Index (Javolution Core (Java) for MSFTBX 6.11.3 API)

java.lang.Object
- java.lang.Number
- - javolution.util.Index

All Implemented Interfaces:

Serializable, Comparable<Index>, ValueType
```
@Realtime
@DefaultTextFormat(value=Index.Decimal.class)
public final class Index
extends Number
implements Comparable<Index>, ValueType
```
A non-negative number representing a position in an arrangement.
```
 interface Vector<F> {
     Vector<F> getSubVector(List<Index> indices); 
         // e.g. getSubVector(Index.rangeOf(0, n)) for the n first elements.
     ...
 }
```
Index performance is on-par with the primitive int type for small values and similar to Integer instances for large values. Small indexes have no adverse effect on the garbage collector and have fast equals method due to their unicity.
Version:

5.1, July 26, 2007

Author:

Jean-Marie Dautelle

See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Index.Decimal
Default text format for indices (decimal value representation).

Nested Classes
Modifier and Type	Class and Description
`static class`	`Index.Decimal` Default text format for indices (decimal value representation).

Field Summary

Fields
Modifier and Type	Field and Description
`static Configurable<Integer>`	`UNIQUE` Holds the number of unique preallocated instances (default `1024`).
`static Index`	`ZERO` Holds the index zero (value `0`).

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`compareTo(Index that)` Compares this index with the specified index for order.
`int`	`compareTo(int value)` Compares this index with the specified integer value for order.
`Index`	`copy()` Returns a copy of this index or `this` if the indexes is small (in permanent memory) in order to maintain unicity.
`double`	`doubleValue()` Returns the index value as `double`.
`boolean`	`equals(Object obj)` Indicates if this index is equals to the one specified (for small indices this method is equivalent to `==`).
`float`	`floatValue()` Returns the index value as `float`.
`int`	`hashCode()` Returns the hash code for this index.
`int`	`intValue()` Returns the index value as `int`.
`boolean`	`isZero()` Indicates if this index is zero.
`static FastTable<Index>`	`listOf(int... values)` Returns the indices having the specified `int` non-negative values (convenience method).
`long`	`longValue()` Returns the index value as `long`.
`Index`	`next()` Returns the index after this one.
`static Index`	`of(int value)` Returns the index for the specified `int` non-negative value (returns a preallocated instance if the specified value is small).
`Index`	`previous()` Returns the index before this one.
`static ConstantTable<Index>`	`rangeOf(int fromIndex, int toIndex)` Returns the indices having the specified range of `int` non-negative values (convenience method).
`protected Object`	`readResolve()` Ensures index unicity during deserialization.
`String`	`toString()` Returns the `String` representation of this index.

Methods inherited from class java.lang.Number
byteValue, shortValue

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - UNIQUE
```
public static final Configurable<Integer> UNIQUE
```
    Holds the number of unique preallocated instances (default 1024). This number is configurable, for example with -Djavolution.util.Index#UNIQUE=0 there is no unique instance.
  - ZERO
```
public static final Index ZERO
```
    Holds the index zero (value 0).
- Method Detail
  - of
```
public static Index of(int value)
```
    Returns the index for the specified int non-negative value (returns a preallocated instance if the specified value is small).
    
    Parameters:
    value - the index value.
    
    Returns:
    the corresponding index.
    
    Throws:
    
    IndexOutOfBoundsException - if value < 0
  - listOf
```
public static FastTable<Index> listOf(int... values)
```
    Returns the indices having the specified int non-negative values (convenience method).
    
    Parameters:
    values - the indices values.
    
    Returns:
    the corresponding table.
  - rangeOf
```
public static ConstantTable<Index> rangeOf(int fromIndex,
                           int toIndex)
```
    Returns the indices having the specified range of int non-negative values (convenience method). A sub-table view over preallocated instances is returned when possible.
    
    Parameters:
    fromIndex - low endpoint (inclusive) of the list to return.
    toIndex - high endpoint (exclusive) of the list to return.
    
    Returns:
    the corresponding indices.
  - compareTo
```
public int compareTo(Index that)
```
    Compares this index with the specified index for order. Returns a negative integer, zero, or a positive integer as this index is less than, equal to, or greater than the specified index.
    
    Specified by:
    
    compareTo in interface Comparable<Index>
    
    Parameters:
    that - the index to be compared.
    
    Returns:
    a negative integer, zero, or a positive integer as this index is less than, equal to, or greater than the specified index.
  - compareTo
```
public int compareTo(int value)
```
    Compares this index with the specified integer value for order. Returns a negative integer, zero, or a positive integer as this index is less than, equal to, or greater than the specified value.
    
    Parameters:
    value - the value to be compared.
    
    Returns:
    a negative integer, zero, or a positive integer as this index is less than, equal to, or greater than the specified value.
  - copy
```
public Index copy()
```
    Returns a copy of this index or this if the indexes is small (in permanent memory) in order to maintain unicity.
  - doubleValue
```
public double doubleValue()
```
    Returns the index value as double.
    
    Specified by:
    
    doubleValue in class Number
    
    Returns:
    the index value.
  - equals
```
public boolean equals(Object obj)
```
    Indicates if this index is equals to the one specified (for small indices this method is equivalent to ==).
    
    Specified by:
    
    equals in interface ValueType
    
    Overrides:
    
    equals in class Object
  - floatValue
```
public float floatValue()
```
    Returns the index value as float.
    
    Specified by:
    
    floatValue in class Number
    
    Returns:
    the index value.
  - hashCode
```
public int hashCode()
```
    Returns the hash code for this index.
    
    Specified by:
    
    hashCode in interface ValueType
    
    Overrides:
    
    hashCode in class Object
  - intValue
```
public int intValue()
```
    Returns the index value as int.
    
    Specified by:
    
    intValue in class Number
    
    Returns:
    the index value.
  - isZero
```
public boolean isZero()
```
    Indicates if this index is zero.
    
    Returns:
    this == ZERO
  - longValue
```
public long longValue()
```
    Returns the index value as long.
    
    Specified by:
    
    longValue in class Number
    
    Returns:
    the index value.
  - next
```
public Index next()
```
    Returns the index after this one.
  - previous
```
public Index previous()
```
    Returns the index before this one.
    
    Throws:
    
    IndexOutOfBoundsException - if (this == Index.ZERO)
  - readResolve
```
protected final Object readResolve()
                            throws ObjectStreamException
```
    Ensures index unicity during deserialization.
    
    Throws:
    
    ObjectStreamException
  - toString
```
public String toString()
```
    Returns the String representation of this index.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    TextContext.getFormat(Index.class).format(this)

Class Index

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Number

Methods inherited from class java.lang.Object

Field Detail

UNIQUE

ZERO

Method Detail

of

listOf

rangeOf

compareTo

compareTo

copy

doubleValue

equals

floatValue

hashCode

intValue

isZero

longValue

next

previous

readResolve

toString