1
0
Fork 0
arangodb/SkipLists/skiplistIndex.h

196 lines
7.2 KiB
C
Executable File

////////////////////////////////////////////////////////////////////////////////
/// @brief unique hash index
///
/// @file
///
/// DISCLAIMER
///
/// Copyright by triAGENS GmbH - All rights reserved.
///
/// The Programs (which include both the software and documentation)
/// contain proprietary information of triAGENS GmbH; they are
/// provided under a license agreement containing restrictions on use and
/// disclosure and are also protected by copyright, patent and other
/// intellectual and industrial property laws. Reverse engineering,
/// disassembly or decompilation of the Programs, except to the extent
/// required to obtain interoperability with other independently created
/// software or as specified by law, is prohibited.
///
/// The Programs are not intended for use in any nuclear, aviation, mass
/// transit, medical, or other inherently dangerous applications. It shall
/// be the licensee's responsibility to take all appropriate fail-safe,
/// backup, redundancy, and other measures to ensure the safe use of such
/// applications if the Programs are used for such purposes, and triAGENS
/// GmbH disclaims liability for any damages caused by such use of
/// the Programs.
///
/// This software is the confidential and proprietary information of
/// triAGENS GmbH. You shall not disclose such confidential and
/// proprietary information and shall use it only in accordance with the
/// terms of the license agreement you entered into with triAGENS GmbH.
///
/// Copyright holder is triAGENS GmbH, Cologne, Germany
///
/// @author Dr. O
/// @author Copyright 2011, triagens GmbH, Cologne, Germany
////////////////////////////////////////////////////////////////////////////////
#ifndef TRIAGENS_DURHAM_VOC_BASE_SKIPLIST_INDEX_H
#define TRIAGENS_DURHAM_VOC_BASE_SKIPLIST_INDEX_H 1
#include <BasicsC/common.h>
#include "SkipLists/skiplist.h"
#include "SkipLists/sl-operator.h"
#include "ShapedJson/shaped-json.h"
#ifdef __cplusplus
extern "C" {
#endif
// -----------------------------------------------------------------------------
// --SECTION-- skiplistIndex public types
// -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
/// @addtogroup skiplistIndex
/// @{
////////////////////////////////////////////////////////////////////////////////
typedef struct {
union {
TRI_skiplist_t* uniqueSkiplist;
TRI_skiplist_multi_t* nonUniqueSkiplist;
} skiplist;
bool unique;
} SkiplistIndex;
typedef struct {
size_t numFields; // the number of fields
TRI_shaped_json_t* fields; // list of shaped json objects which the collection should know about
void* data; // master document pointer
void* collection; // pointer to the collection;
} SkiplistIndexElement;
typedef struct {
size_t _numElements;
SkiplistIndexElement* _elements; // simple list of elements
} SkiplistIndexElements;
////////////////////////////////////////////////////////////////////////////////
/// @brief Iterator structure for skip list. We require a start and stop node
////////////////////////////////////////////////////////////////////////////////
typedef struct TRI_skiplist_iterator_interval_s {
void* _leftEndPoint;
void* _rightEndPoint;
} TRI_skiplist_iterator_interval_t;
typedef struct TRI_skiplist_iterator_s {
SkiplistIndex* _index;
TRI_vector_t _intervals;
size_t _currentInterval; // starts with 0
void* _cursor; // initially null
bool (*_hasNext) (struct TRI_skiplist_iterator_s*);
void* (*_next) (struct TRI_skiplist_iterator_s*);
void* (*_nexts) (struct TRI_skiplist_iterator_s*, int64_t jumpSize);
bool (*_hasPrev) (struct TRI_skiplist_iterator_s*);
void* (*_prev) (struct TRI_skiplist_iterator_s*);
void* (*_prevs) (struct TRI_skiplist_iterator_s*, int64_t jumpSize);
} TRI_skiplist_iterator_t;
////////////////////////////////////////////////////////////////////////////////
/// @}
////////////////////////////////////////////////////////////////////////////////
// -----------------------------------------------------------------------------
// --SECTION-- skiplistIndex public methods
// -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
/// @addtogroup skiplistIndex
/// @{
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
/// @brief Free a skiplist iterator
////////////////////////////////////////////////////////////////////////////////
void TRI_FreeSkiplistIterator (TRI_skiplist_iterator_t* const);
////////////////////////////////////////////////////////////////////////////////
/// @brief destroys a skip list index , but does not free the pointer
////////////////////////////////////////////////////////////////////////////////
void SkiplistIndex_destroy (SkiplistIndex*);
////////////////////////////////////////////////////////////////////////////////
/// @brief destroys a skip list index and frees the pointer
////////////////////////////////////////////////////////////////////////////////
void SkiplistIndex_free (SkiplistIndex*);
////////////////////////////////////////////////////////////////////////////////
/// @}
////////////////////////////////////////////////////////////////////////////////
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
// Unique skiplist indexes
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
SkiplistIndex* SkiplistIndex_new (void);
int SkiplistIndex_add (SkiplistIndex*, SkiplistIndexElement*);
TRI_skiplist_iterator_t* SkiplistIndex_find (SkiplistIndex*, TRI_vector_t*, TRI_sl_operator_t*);
int SkiplistIndex_insert (SkiplistIndex*, SkiplistIndexElement*);
int SkiplistIndex_remove (SkiplistIndex*, SkiplistIndexElement*);
bool SkiplistIndex_update (SkiplistIndex*, const SkiplistIndexElement*, const SkiplistIndexElement*);
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
// Multi-skiplist non-unique skiplist indexes
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
SkiplistIndex* MultiSkiplistIndex_new (void);
int MultiSkiplistIndex_add (SkiplistIndex*, SkiplistIndexElement*);
TRI_skiplist_iterator_t* MultiSkiplistIndex_find (SkiplistIndex*, TRI_vector_t*, TRI_sl_operator_t*);
int MultiSkiplistIndex_insert (SkiplistIndex*, SkiplistIndexElement*);
int MultiSkiplistIndex_remove (SkiplistIndex*, SkiplistIndexElement*);
bool MultiSkiplistIndex_update (SkiplistIndex*, SkiplistIndexElement*, SkiplistIndexElement*);
#ifdef __cplusplus
}
#endif
#endif
// Local Variables:
// mode: outline-minor
// outline-regexp: "^\\(/// @brief\\|/// {@inheritDoc}\\|/// @addtogroup\\|// --SECTION--\\|/// @\\}\\)"
// End: