org.ojalgo.structure

Interface StructureAnyD

All Superinterfaces:

Structure1D

All Known Subinterfaces:

AccessAnyD<N>, AccessAnyD.Aggregatable<N>, AccessAnyD.Collectable<N,R>, AccessAnyD.Elements, AccessAnyD.IndexOf, AccessAnyD.Sliceable<N>, AccessAnyD.Visitable<N>, MutateAnyD, MutateAnyD.Fillable<N>, MutateAnyD.Mixable<N>, MutateAnyD.Modifiable<N>, MutateAnyD.ModifiableReceiver<N>, MutateAnyD.Receiver<N>, StreamAnyD<N,A,R,P>, StructureAnyD.Logical<S,B>, StructureAnyD.ReducibleTo1D<R>, StructureAnyD.ReducibleTo2D<R>, Tensor<N>

All Known Implementing Classes:

ArrayAnyD

public interface StructureAnyD
extends Structure1D

A (fixed size) any-dimensional data structure.

Author:

apete

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	StructureAnyD.IntReference
static interface	StructureAnyD.Logical<S extends StructureAnyD,B extends StructureAnyD.Logical<S,?>>
static class	StructureAnyD.LongReference
static interface	StructureAnyD.ReducibleTo1D<R extends Structure1D>
static interface	StructureAnyD.ReducibleTo2D<R extends Structure2D>
static interface	StructureAnyD.ReferenceCallback
static class	StructureAnyD.ReferenceMapper

Nested classes/interfaces inherited from interface org.ojalgo.structure.Structure1D

Structure1D.BasicMapper<T>, Structure1D.IndexCallback, Structure1D.IndexMapper<T>, Structure1D.IntIndex, Structure1D.LongIndex, Structure1D.LoopCallback

Method Summary

Modifier and Type	Method and Description
default long	count() count() == count(0) * count(1) * count(2) * count(3) * ...
long	count(int dimension)
static int	count(int[] structure)
static int	count(int[] structure, int dimension)
static long	count(long[] structure)
static long	count(long[] structure, int dimension)
static int	index(int[] structure, int[] reference)
static int	index(int[] structure, long[] reference)
static long	index(long[] structure, long[] reference)
default void	loop(int dimension, long dimensionalIndex, Structure1D.LoopCallback callback) Will loop through this multidimensional data structure so that one index value of one dimension is fixed.
default void	loop(long[] initial, int dimension, Structure1D.LoopCallback callback)
default void	loop(Predicate<long[]> filter, Structure1D.IndexCallback callback)
default void	loopAll(StructureAnyD.ReferenceCallback callback)
static void	loopMatching(StructureAnyD structureA, StructureAnyD structureB, Structure1D.IndexCallback callback)
static StructureAnyD.ReferenceMapper	mapperOf(StructureAnyD structure, Structure1D.IndexMapper<Object>[] mappers)
default int	rank()
static long[]	reference(long index, long[] structure)
long[]	shape()
static long[]	shape(StructureAnyD structure)
static int	step(int[] structure, int dimension)
static int	step(int[] structure, int[] increment) A more complex/general version of step(int[], int).
static long	step(long[] structure, int dimension) How does the index change when stepping to the next dimensional unit (next row, next column.
static long	step(long[] structure, long[] increment) A more complex/general version of step(int[], int).

Methods inherited from interface org.ojalgo.structure.Structure1D

index, loopAll, loopMatching, loopRange, mapper, size

Method Detail

count

static int count(int[] structure)

Parameters:

structure - An access structure

Returns:

The size of an access with that structure

count

static int count(int[] structure,
                 int dimension)

Parameters:

structure - An access structure

dimension - A dimension index

Returns:

The size of that dimension

count

static long count(long[] structure)

Parameters:

structure - An access structure

Returns:

The size of an access with that structure

count

static long count(long[] structure,
                  int dimension)

Parameters:

structure - An access structure

dimension - A dimension index

Returns:

The size of that dimension

index

static int index(int[] structure,
                 int[] reference)

Parameters:

structure - An access structure

reference - An access element reference

Returns:

The index of that element

index

static int index(int[] structure,
                 long[] reference)

Parameters:

structure - An access structure

reference - An access element reference

Returns:

The index of that element

index

static long index(long[] structure,
                  long[] reference)

Parameters:

structure - An access structure

reference - An access element reference

Returns:

The index of that element

loopMatching

static void loopMatching(StructureAnyD structureA,
                         StructureAnyD structureB,
                         Structure1D.IndexCallback callback)

mapperOf

static StructureAnyD.ReferenceMapper mapperOf(StructureAnyD structure,
                                              Structure1D.IndexMapper<Object>[] mappers)

reference

static long[] reference(long index,
                        long[] structure)

shape

static long[] shape(StructureAnyD structure)

step

static int step(int[] structure,
                int dimension)

Parameters:

structure - An access structure

dimension - A dimension index indication a direction

Returns:

The step size (index change) in that direction

step

static int step(int[] structure,
                int[] increment)

A more complex/general version of step(int[], int).

Parameters:

structure - An access structure

increment - A vector indication a direction (and size)

Returns:

The step size (index change)

step

static long step(long[] structure,
                 int dimension)

How does the index change when stepping to the next dimensional unit (next row, next column. next matrix/area, next cube...)

Parameters:

structure - An access structure

dimension - Which reference index to increment

Returns:

The step size (index change)

step

static long step(long[] structure,
                 long[] increment)

A more complex/general version of step(int[], int).

Parameters:

structure - An access structure

increment - A vector indication a direction (and size)

Returns:

The step size (index change)

count

default long count()

count() == count(0) * count(1) * count(2) * count(3) * ...

Specified by:

count in interface Structure1D

Returns:

The total number of elements in this structure.

count

long count(int dimension)

loop

default void loop(int dimension,
                  long dimensionalIndex,
                  Structure1D.LoopCallback callback)

Will loop through this multidimensional data structure so that one index value of one dimension is fixed. (Ex: Loop through all items with row index == 5.)

Parameters:

dimension - The dimension with a fixed/supplied index. (0==row, 1==column, 2=matrix/area...)

dimensionalIndex - The index value that dimension is fixed to. (Which row, column or matrix/area)

callback - A callback with parameters that define a sub-loop

loop

default void loop(long[] initial,
                  int dimension,
                  Structure1D.LoopCallback callback)

loop

default void loop(Predicate<long[]> filter,
                  Structure1D.IndexCallback callback)

loopAll

default void loopAll(StructureAnyD.ReferenceCallback callback)

rank

default int rank()

Returns:

The number of dimensions (the number of indices used to reference one element)

shape

long[] shape()