mikera.indexz

Class Index

java.lang.Object

mikera.indexz.AIndex

mikera.indexz.Index

All Implemented Interfaces:

Serializable, Cloneable, Comparable<AIndex>, Iterable<Integer>

public final class Index
extends AIndex

Class to represent a mutable list of integer indexes

Author:

Mike

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
int[]	data

Constructor Summary

Constructors

Constructor and Description
Index(int length)

Method Summary

Methods

Modifier and Type	Method and Description
Index	clone()
Index	compose(AIndex a)
Index	compose(Index a)
boolean	equals(Index o)
boolean	equals(Object o)
int	get(int i) Gets the index value at position i
int[]	getData()
boolean	isFullyMutable()
int	length() Returns the length of this index list
void	lookupWith(Index source)
static Index	of(int... indexes) Creates a new Index, using the specified index values
void	permute(Index permutationIndex) Permutes this vector according to a given permutation index
void	reverse() Reverses an index
void	set(int i, int value)
void	sort() Sorts the index (in-place)
void	swap(int i, int j) Swaps (in-place) the indexes at two positions
int[]	toArray()
static Index	wrap(int[] indexes) Creates a new Index, wrapping the provided index array

Methods inherited from class mikera.indexz.AIndex

compareTo, contains, contains, copyTo, equals, hashCode, isDistinct, isPermutation, isSorted, iterator, maxIndex, minIndex, toList, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

data

public final int[] data

Constructor Detail

Index

public Index(int length)

Method Detail

swap

public void swap(int i,
        int j)

Swaps (in-place) the indexes at two positions

Overrides:

swap in class AIndex

reverse

public void reverse()

Reverses an index

Overrides:

reverse in class AIndex

wrap

public static Index wrap(int[] indexes)

Creates a new Index, wrapping the provided index array

of

public static Index of(int... indexes)

Creates a new Index, using the specified index values

get

public int get(int i)

Description copied from class: AIndex

Gets the index value at position i

Specified by:

get in class AIndex

Returns:

set

public void set(int i,
       int value)

Overrides:

set in class AIndex

length

public int length()

Description copied from class: AIndex

Returns the length of this index list

Specified by:

length in class AIndex

Returns:

clone

public Index clone()

Overrides:

clone in class AIndex

permute

public void permute(Index permutationIndex)

Permutes this vector according to a given permutation index

Parameters:

permutationIndex -

sort

public void sort()

Sorts the index (in-place)

equals

public boolean equals(Object o)

Overrides:

equals in class AIndex

equals

public boolean equals(Index o)

getData

public int[] getData()

toArray

public int[] toArray()

Overrides:

toArray in class AIndex

isFullyMutable

public boolean isFullyMutable()

Overrides:

isFullyMutable in class AIndex

lookupWith

public void lookupWith(Index source)

compose

public Index compose(AIndex a)

Overrides:

compose in class AIndex

compose

public Index compose(Index a)