de.javagl.nd.arrays

Class AbstractArrayND

java.lang.Object

de.javagl.nd.arrays.AbstractArrayND

All Implemented Interfaces:

ArrayND

public abstract class AbstractArrayND
extends Object
implements ArrayND

Abstract base implementation of a multidimensional array.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractArrayND(IntTuple size, Order preferredIterationOrder) Creates a new multidimensional array with the given size.

Method Summary

Modifier and Type	Method and Description
Order	getPreferredIterationOrder() Returns the preferred iteration Order of this array, or null if this array does not have any preferred iteration order.
IntTuple	getSize() Returns the size of the array.
int	getTotalSize() Returns the total size of this array.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface de.javagl.nd.arrays.ArrayND

coordinates, subArray

Constructor Detail

AbstractArrayND

protected AbstractArrayND(IntTuple size,
                          Order preferredIterationOrder)

Creates a new multidimensional array with the given size.

Parameters:

size - The size of the array.

preferredIterationOrder - The preferred iteration Order of this array. This may be null if the array does not have a preferred iteration order.

Throws:

NullPointerException - If the given size is null

IllegalArgumentException - If the given size is negative along any dimension

Method Detail

getTotalSize

public final int getTotalSize()

Description copied from interface: ArrayND

Returns the total size of this array. This is the product of the size along all dimensions.

Specified by:

getTotalSize in interface ArrayND

Returns:

The total size

getSize

public final IntTuple getSize()

Description copied from interface: ArrayND

Returns the size of the array.

Specified by:

getSize in interface ArrayND

Returns:

The size of the array.

getPreferredIterationOrder

public Order getPreferredIterationOrder()

Description copied from interface: ArrayND

Returns the preferred iteration Order of this array, or null if this array does not have any preferred iteration order.

Specified by:

getPreferredIterationOrder in interface ArrayND

Returns:

The preferred iteration Order