de.javagl.nd.tuples

Interface Tuple

All Known Subinterfaces:

DoubleTuple, IntTuple, LongTuple, MutableDoubleTuple, MutableIntTuple, MutableLongTuple

All Known Implementing Classes:

AbstractDoubleTuple, AbstractIntTuple, AbstractLongTuple, AbstractMutableDoubleTuple, AbstractMutableIntTuple, AbstractMutableLongTuple

public interface Tuple

Interface describing an N-dimensional tuple

Method Summary

Modifier and Type	Method and Description
int	getSize() Returns the size (number of dimensions) of this tuple.
Tuple	subTuple(int fromIndex, int toIndex) Returns a view on a portion of this tuple.

Method Detail

getSize

int getSize()

Returns the size (number of dimensions) of this tuple.

Returns:

The size of this tuple.

subTuple

Tuple subTuple(int fromIndex,
               int toIndex)

Returns a view on a portion of this tuple. Changes in this tuple will be visible in the returned tuple.

Parameters:

fromIndex - The start index of the sub-tuple (inclusive)

toIndex - The end index of the sub-tuple (exclusive)

Returns:

The sub-tuple

Throws:

IllegalArgumentException - If the indices are not valid. This is the case when fromIndex < 0 or fromIndex > toIndex or toIndex >= getSize()