Package ints

Interface IntArray

All Known Subinterfaces:

DuplicatesGTRec, GTRec, RefGTRec

All Known Implementing Classes:

BitSetGT, CharArray, IndexArray, LowMafRefDiallelicGT, LowMafRefGT, PackedIntArray, SeqCodedRefGT, UnsignedByteArray, VcfRecord, WrappedIntArray

public interface IntArray

Interface IntArray represents an immutable int[] array.

Instances of class IntArray are required to be immutable.

Method Summary

Modifier and Type	Method	Description
static java.lang.String	asString(IntArray ia)	Returns a string representation of this IntArray by applying java.utils.Arrays.toString() to an equivalent int[] object.
static IntArray	create(int[] ia, int valueSize)	Returns a new IntArray instance that has the same sequence of integers as the specified array.
static IntArray	create(IntList il, int valueSize)	Returns a new IntArray instance that has the same sequence of integers as the specified list.
static boolean	equals(IntArray a, IntArray b)	Returns true if the specified IntArray objects represent the same sequence of integer values, and returns false otherwise.
int	get(int index)	Returns the specified array element.
static int	max(IntArray ia)	Returns the maximum element, or Integer.MIN_VALUE if this.size() == 0.
static int	min(IntArray ia)	Returns the minimum element, or Integer.MAX_VALUE if this.size() == 0.
int	size()	Returns the number of elements in this IntArray.
static int[]	toArray(IntArray ia)	Returns a copy of the specified array.

Method Detail

size

int size()

Returns the number of elements in this IntArray.

Returns:

the number of elements in this IntArray

get

int get(int index)

Returns the specified array element.

Parameters:

index - an array index

Returns:

the specified array element

Throws:

java.lang.IndexOutOfBoundsException - if index < 0 || index >= this.size()

toArray

static int[] toArray(IntArray ia)

Returns a copy of the specified array.

Parameters:

ia - a list of integers

Returns:

a copy of the specified array

Throws:

java.lang.NullPointerException - if ia == null

asString

static java.lang.String asString(IntArray ia)

Returns a string representation of this IntArray by applying java.utils.Arrays.toString() to an equivalent int[] object.

Parameters:

ia - a list of integers

Returns:

a string representation of this IntArray.

Throws:

java.lang.NullPointerException - if ia == null

equals

static boolean equals(IntArray a,
                      IntArray b)

Returns true if the specified IntArray objects represent the same sequence of integer values, and returns false otherwise.

Parameters:

a - a sequence of integer values

b - a sequence of integer values

Returns:

true if the specified IntArray objects represent the same sequence of integer values

max

static int max(IntArray ia)

Returns the maximum element, or Integer.MIN_VALUE if this.size() == 0.

Parameters:

ia - a list of integers

Returns:

the maximum element

Throws:

java.lang.NullPointerException - if ia == null

min

static int min(IntArray ia)

Returns the minimum element, or Integer.MAX_VALUE if this.size() == 0.

Parameters:

ia - a list of integers

Returns:

the minimum element

Throws:

java.lang.NullPointerException - if ia == null

create

static IntArray create(int[] ia,
                       int valueSize)

Returns a new IntArray instance that has the same sequence of integers as the specified array.

Parameters:

ia - the array of integers to be copied

valueSize - the exclusive end of the range of non-negative array values

Returns:

a new IntArray instance that has the same sequence of integers as the specified array

Throws:

java.lang.IllegalArgumentException - if valueSize < 1

java.lang.IllegalArgumentException - if (ia[j] < 0 || ia[j] > valueSize) for any index j satisfying (j >= 0 && j < ia.length)

java.lang.NullPointerException - if ia == null

create

static IntArray create(IntList il,
                       int valueSize)

Returns a new IntArray instance that has the same sequence of integers as the specified list.

Parameters:

il - the list of integers to be copied

valueSize - the exclusive end of the range of non-negative array values

Returns:

a new IntArray instance that has the same sequence of integers as the specified list

Throws:

java.lang.IllegalArgumentException - if valueSize < 1

java.lang.IllegalArgumentException - if (ia[j] < 0 || ia[j] > valueSize) for any index j satisfying (j >= 0 && j < ia.length)

java.lang.NullPointerException - if ia == null