de.javagl.nd.tuples.i

Interface IntTuple

All Superinterfaces:

Tuple

All Known Subinterfaces:

MutableIntTuple

All Known Implementing Classes:

AbstractIntTuple, AbstractMutableIntTuple

public interface IntTuple
extends Tuple

Interface describing an N-dimensional tuple consisting of int values.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object object) Returns whether this tuple equals the given object.
int	get(int index) Returns the value at the given index of this tuple.
int	hashCode() This hash code is defined to be the sum of the hash codes of all the elements of this tuple.
default java.util.stream.IntStream	stream() Returns a sequential IntStream with this tuple as its source.
default IntTuple	subTuple(int fromIndex, int toIndex) Returns a view on a portion of this tuple.

Methods inherited from interface de.javagl.nd.tuples.Tuple

getSize

Method Detail

get

int get(int index)

Returns the value at the given index of this tuple.

Parameters:

index - The index.

Returns:

The value.

Throws:

IndexOutOfBoundsException - If the given index is smaller than 0, or greater than or equal to the size of this tuple.

subTuple

default IntTuple subTuple(int fromIndex,
                          int toIndex)

Description copied from interface: Tuple

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

Specified by:

subTuple in interface Tuple

Parameters:

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

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

Returns:

The sub-tuple

stream

default java.util.stream.IntStream stream()

Returns a sequential IntStream with this tuple as its source.

Returns:

The stream

equals

boolean equals(Object object)

Returns whether this tuple equals the given object. This will return true if and only if the given object is also a IntTuple, has the same size as this one, and is component-wise equal to this one.

Overrides:

equals in class Object

Parameters:

object - The object to compare with

Returns:

Whether this tuple equals the given object

hashCode

int hashCode()

This hash code is defined to be the sum of the hash codes of all the elements of this tuple.

Overrides:

hashCode in class Object

Returns:

The hash code