org.tinspin.index.critbit

Class CritBit64<V>

java.lang.Object

org.tinspin.index.critbit.CritBit64<V>

All Implemented Interfaces:

Iterable<V>

Direct Known Subclasses:

CritBit64COW

public class CritBit64<V>
extends Object
implements Iterable<V>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	CritBit64.AtomicInfo<V>
static class	CritBit64.CBIterator<V>
static class	CritBit64.Entry<V>
protected static class	CritBit64.Node<V>
static class	CritBit64.QueryIterator<V>
static class	CritBit64.QueryIteratorMask<V>

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	DEPTH
protected CritBit64.AtomicInfo<V>	info

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CritBit64()

Method Summary

Modifier and Type	Method and Description
boolean	checkTree()
boolean	contains(long key) Check whether a given key exists in the tree.
static <V> CritBit64<V>	create() Create a 1D crit-bit tree with 64 bit key length.
V	get(long key) Get the value for a given key.
CritBit64.CBIterator<V>	iterator()
void	printTree()
V	put(long key, V val) Add a key value pair to the tree or replace the value if the key already exists.
CritBit64.QueryIterator<V>	query(long min, long max) Queries the tree for entries with min<=key<=max.
CritBit64.QueryIteratorMask<V>	queryWithMask(long min, long max) Queries the tree for entries with min<=key<=max.
V	remove(long key) Remove a key and its value
int	size() Get the size of the tree.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

DEPTH

protected static final int DEPTH

See Also:

Constant Field Values

info

protected CritBit64.AtomicInfo<V> info

Constructor Detail

CritBit64

protected CritBit64()

Method Detail

create

public static <V> CritBit64<V> create()

Create a 1D crit-bit tree with 64 bit key length.

Type Parameters:

V - value type

Returns:

a 1D crit-bit tree

put

public V put(long key,
             V val)

Add a key value pair to the tree or replace the value if the key already exists.

Parameters:

key - key

val - value

Returns:

The previous value or null if there was no previous value

printTree

public void printTree()

toString

public String toString()

Overrides:

toString in class Object

checkTree

public boolean checkTree()

size

public int size()

Get the size of the tree.

Returns:

the number of keys in the tree

contains

public boolean contains(long key)

Check whether a given key exists in the tree.

Parameters:

key - key

Returns:

true if the key exists otherwise false

get

public V get(long key)

Get the value for a given key.

Parameters:

key - key

Returns:

the values associated with key or null if the key does not exist.

remove

public V remove(long key)

Remove a key and its value

Parameters:

key - key

Returns:

The value of the key of null if the value was not found.

iterator

public CritBit64.CBIterator<V> iterator()

Specified by:

iterator in interface Iterable<V>

query

public CritBit64.QueryIterator<V> query(long min,
                                        long max)

Queries the tree for entries with min<=key<=max.

Parameters:

min - minimum key

max - maximum key

Returns:

An iterator over the matching entries.

queryWithMask

public CritBit64.QueryIteratorMask<V> queryWithMask(long min,
                                                    long max)

Queries the tree for entries with min<=key<=max. Unlike the normal query, this query also excludes all elements with (key|min)!=key and (key&max!=max). See PH-Tree for a discussion.

Parameters:

min - minimum key

max - maximum key

Returns:

An iterator over the matching entries.