AIndex (vectorz 0.6.1 API)

java.lang.Object
- mikera.indexz.AIndex

All Implemented Interfaces:

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

Direct Known Subclasses:

ComputedIndex, Index
```
public abstract class AIndex
extends Object
implements Serializable, Cloneable, Comparable<AIndex>, Iterable<Integer>
```
Abstract base class for a list of integer indexes

Author:

Mike

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

AIndex()

Constructors
Constructor and Description
`AIndex()`

Method Summary

Methods
Modifier and Type	Method and Description
`AIndex`	`clone()`
`int`	`compareTo(AIndex a)`
`Index`	`compose(AIndex a)`
`boolean`	`contains(Index inds)`
`boolean`	`contains(int index)`
`void`	`copyTo(int[] array, int offset)`
`boolean`	`equals(AIndex o)`
`boolean`	`equals(Object o)`
`abstract int`	`get(int i)` Gets the index value at position i
`int`	`hashCode()`
`boolean`	`isDistinct()` Returns true if this Index contains only distinct integer indices
`boolean`	`isFullyMutable()`
`boolean`	`isPermutation()` Returns true if this index represents a permutation of positions 0..length-1
`boolean`	`isSorted()`
`IndexIterator`	`iterator()`
`abstract int`	`length()` Returns the length of this index list
`int`	`maxIndex()`
`int`	`minIndex()`
`void`	`reverse()`
`void`	`set(int i, int value)`
`void`	`swap(int i, int j)`
`int[]`	`toArray()`
`List<Integer>`	`toList()`
`String`	`toString()`

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

Constructor Detail
- AIndex
```
public AIndex()
```

Method Detail

get
```
public abstract int get(int i)
```
Gets the index value at position i

Parameters:
i -

Returns:

length
```
public abstract int length()
```
Returns the length of this index list

Returns:

set

public void set(int i,
       int value)

isFullyMutable
```
public boolean isFullyMutable()
```

copyTo

public void copyTo(int[] array,
          int offset)

toArray
```
public int[] toArray()
```

toList
```
public List<Integer> toList()
```

swap

public void swap(int i,
        int j)

reverse
```
public void reverse()
```

minIndex
```
public int minIndex()
```

maxIndex
```
public int maxIndex()
```

isSorted
```
public boolean isSorted()
```

isDistinct
```
public boolean isDistinct()
```
Returns true if this Index contains only distinct integer indices

Returns:

isPermutation
```
public boolean isPermutation()
```
Returns true if this index represents a permutation of positions 0..length-1

Returns:

contains
```
public boolean contains(int index)
```

contains
```
public boolean contains(Index inds)
```

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

equals
```
public boolean equals(AIndex o)
```

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

toString
```
public String toString()
```
Overrides:

toString in class Object

clone
```
public AIndex clone()
```
Overrides:

clone in class Object

compareTo
```
public int compareTo(AIndex a)
```
Specified by:

compareTo in interface Comparable<AIndex>

iterator
```
public IndexIterator iterator()
```
Specified by:

iterator in interface Iterable<Integer>

compose
```
public Index compose(AIndex a)
```

Class AIndex

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AIndex

Method Detail

get

length

set

isFullyMutable

copyTo

toArray

toList

swap

reverse

minIndex

maxIndex

isSorted

isDistinct

isPermutation

contains

contains

equals

equals

hashCode

toString

clone

compareTo

iterator

compose