jsat.utils

Enum IntPriorityQueue.Mode

java.lang.Object

java.lang.Enum<IntPriorityQueue.Mode>

jsat.utils.IntPriorityQueue.Mode

All Implemented Interfaces:

Serializable, Comparable<IntPriorityQueue.Mode>

Enclosing class:

IntPriorityQueue

public static enum IntPriorityQueue.Mode
extends Enum<IntPriorityQueue.Mode>

Sets the mode used for the priority queue.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOUNDED Sets the priority queue to use a backing array that indexes into the heap.
HASH Sets the priority queue to use a backing hashtable to map values to their position in the heap.
STANDARD Sets the priority queue to use the standard queue implementation with the standard complexity for the following operations O(1) time for IntPriorityQueue.peek() O(log n) time for IntPriorityQueue.poll(), AbstractQueue.add(java.lang.Object) O(n) time for IntPriorityQueue.remove(java.lang.Object) and IntPriorityQueue.contains(java.lang.Object) And calling Iterator.remove() is O(log n), but the iteration is in no particular order

Method Summary

Modifier and Type	Method and Description
static IntPriorityQueue.Mode	valueOf(String name) Returns the enum constant of this type with the specified name.
static IntPriorityQueue.Mode[]	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

STANDARD

public static final IntPriorityQueue.Mode STANDARD

Sets the priority queue to use the standard queue implementation with the standard complexity for the following operations

O(1) time for IntPriorityQueue.peek()
O(log n) time for IntPriorityQueue.poll(), AbstractQueue.add(java.lang.Object)
O(n) time for IntPriorityQueue.remove(java.lang.Object) and IntPriorityQueue.contains(java.lang.Object)
And calling Iterator.remove() is O(log n), but the iteration is in no particular order

HASH

public static final IntPriorityQueue.Mode HASH

Sets the priority queue to use a backing hashtable to map values to their position in the heap. This changes the complexity to

O(1) time for IntPriorityQueue.peek() and IntPriorityQueue.contains(java.lang.Object)
O(log n) time for IntPriorityQueue.poll(), AbstractQueue.add(java.lang.Object), and IntPriorityQueue.remove(java.lang.Object)
And calling Iterator.remove() is O(log n), but the iteration is in no particular order

BOUNDED

public static final IntPriorityQueue.Mode BOUNDED

Sets the priority queue to use a backing array that indexes into the heap. This provides the fastest version if fast IntPriorityQueue.remove(java.lang.Object) and IntPriorityQueue.contains(java.lang.Object) are needed. However, it must create an array as large as the largest int value put into the queue, and negative values will not be accepted. This method is best when the size of the queue is known to be bounded and all values are in the range [0, N].

O(1) time for IntPriorityQueue.peek() and IntPriorityQueue.contains(java.lang.Object)
O(log n) time for IntPriorityQueue.poll(), AbstractQueue.add(java.lang.Object), and IntPriorityQueue.remove(java.lang.Object)
And calling Iterator.remove() is O(log n), but the iteration is in no particular order

Method Detail

values

public static IntPriorityQueue.Mode[] 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 (IntPriorityQueue.Mode c : IntPriorityQueue.Mode.values())
    System.out.println(c);

Returns:

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

valueOf

public static IntPriorityQueue.Mode 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