com.github.davidmoten.rtree

Enum InternalStructure

java.lang.Object

java.lang.Enum<InternalStructure>

com.github.davidmoten.rtree.InternalStructure

All Implemented Interfaces:

Serializable, Comparable<InternalStructure>

public enum InternalStructure
extends Enum<InternalStructure>

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFAULT Tree structure using an object graph.
SINGLE_ARRAY Tree structure where nodes are stored in a single linear array and extracted on demand.

Method Summary

Modifier and Type	Method and Description
static InternalStructure	valueOf(String name) Returns the enum constant of this type with the specified name.
static InternalStructure[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SINGLE_ARRAY

public static final InternalStructure SINGLE_ARRAY

Tree structure where nodes are stored in a single linear array and extracted on demand. This is a memory saving option (work on one-third the space) with some access performance penalties compared to the DEFAULT structure (assume one-tenth for search throughput).

Suited most for a static dataset loaded from storage because additions and deletions are not made to the single underlying array but rather combines the array with an object graph. Deletions are not recovered from the single array and after enough of them happen the datastructure should be rewritten to a new array to recover space.

DEFAULT

public static final InternalStructure DEFAULT

Tree structure using an object graph. Offers maximal performance for search/addition/deletion but consumes more memory than SINGLE_ARRAY.

Method Detail

values

public static InternalStructure[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (InternalStructure c : InternalStructure.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static InternalStructure valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null