bplustree.h File Reference

b+ tree indexer interface More...

#include <types.h>
#include <memory.h>
#include <indexer.h>
#include <list.h>
#include <iterator.h>

Macros
#define	___BPLUSTREE_H   0
#define	bplustree_create_index(mkc, c)   bplustree_create_index_with_heap_and_unique(NULL, mkc, c, false)
	creates b+ tree index with default heap More...
#define	bplustree_create_index_with_unique(mkc, c, u)   bplustree_create_index_with_heap_and_unique(NULL, mkc, c, u)
	creates b+ tree index with default heap More...
#define	bplustree_create_index_with_heap(h, mkc, c)   bplustree_create_index_with_heap_and_unique(h, mkc, c, false)
	creates b+ tree index with default heap More...

Typedefs
typedef int8_t(*	bplustree_key_destroyer_f) (memory_heap_t *heap, void *key)
typedef int8_t(*	bplustree_key_cloner_f) (memory_heap_t *heap, const void *key, void **cloned_key)

Functions
index_t *	bplustree_create_index_with_heap_and_unique (memory_heap_t *heap, uint64_t max_key_count, index_key_comparator_f comparator, boolean_t unique)
	creates b+ tree index implementation More...
int8_t	bplustree_destroy_index (index_t *idx)
	destroys index More...
int8_t	bplustree_set_comparator_for_unique_subpart_for_non_unique_index (index_t *idx, index_key_comparator_f comparator)
	sets a comparator for unique subpart for non unique index More...
int8_t	bplustree_set_key_destroyer (index_t *idx, bplustree_key_destroyer_f destroyer)
	sets a key destroyer for index More...
int8_t	bplustree_set_key_cloner (index_t *idx, bplustree_key_cloner_f cloner)
	sets a key cloner for index More...

Detailed Description

b+ tree indexer interface

This work is licensed under TURNSTONE OS Public License. Please read and understand latest version of Licence.

Macro Definition Documentation

___BPLUSTREE_H

#define ___BPLUSTREE_H   0

prevent duplicate header error macro

bplustree_create_index

#define bplustree_create_index	(		mkc,
			c
	)		bplustree_create_index_with_heap_and_unique(NULL, mkc, c, false)

creates b+ tree index with default heap

Parameters

[in]	mkc	max key count
[in]	c	comparator

Returns

b+ tree index

bplustree_create_index_with_heap

#define bplustree_create_index_with_heap	(		h,
			mkc,
			c
	)		bplustree_create_index_with_heap_and_unique(h, mkc, c, false)

creates b+ tree index with default heap

Parameters

[in]	h	heap to use
[in]	mkc	max key count
[in]	c	comparator

Returns

b+ tree index

bplustree_create_index_with_unique

#define bplustree_create_index_with_unique	(		mkc,
			c,
			u
	)		bplustree_create_index_with_heap_and_unique(NULL, mkc, c, u)

creates b+ tree index with default heap

Parameters

[in]	mkc	max key count
[in]	c	comparator
[in]	u	unique flag

Returns

b+ tree index

Function Documentation

bplustree_create_index_with_heap_and_unique()

index_t * bplustree_create_index_with_heap_and_unique	(	memory_heap_t *	heap,
		uint64_t	max_key_count,
		index_key_comparator_f	comparator,
		boolean_t	unique
	)

creates b+ tree index implementation

Parameters

heap	heap to use
max_key_count	maximum key count at each tree node
comparator	key comparator
unique	if unique flag set remove and insert key,value

Returns

index interface

bplustree_destroy_index()

int8_t bplustree_destroy_index

(

index_t *

idx

)

destroys index

Parameters

[in]

idx

index to be destroyed

Returns

0 if successed.

destroys only b+tree not data. if data will not be destroyed a memory leak will be happened.

bplustree_set_comparator_for_unique_subpart_for_non_unique_index()

int8_t bplustree_set_comparator_for_unique_subpart_for_non_unique_index	(	index_t *	idx,
		index_key_comparator_f	comparator
	)

sets a comparator for unique subpart for non unique index

Parameters

[in]	idx	index
[in]	comparator	comparator

Returns

0 if successed.

bplustree_set_key_cloner()

int8_t bplustree_set_key_cloner	(	index_t *	idx,
		bplustree_key_cloner_f	cloner
	)

sets a key cloner for index

Parameters

[in]	idx	index
[in]	cloner	cloner

Returns

0 if successed.

bplustree_set_key_destroyer()

int8_t bplustree_set_key_destroyer	(	index_t *	idx,
		bplustree_key_destroyer_f	destroyer
	)

sets a key destroyer for index

Parameters

[in]	idx	index
[in]	destroyer	destroyer

Returns

0 if successed.