org.ojalgo.access

Interface Structure2D

All Superinterfaces:

Structure1D

All Known Subinterfaces:

Access2D<N>, Access2D.Aggregatable<N>, Access2D.Collectable<N,R>, Access2D.Elements, Access2D.IndexOf, Access2D.Sliceable<N>, Access2D.Visitable<N>, BasicMatrix, BasicMatrix.Builder<I>, DecompositionStore<N>, ElementsConsumer<N>, ElementsSupplier<N>, MatrixStore<N>, Mutate2D, Mutate2D.BiModifiable<N>, Mutate2D.Exchangeable, Mutate2D.Fillable<N>, Mutate2D.Mixable<N>, Mutate2D.Modifiable<N>, Mutate2D.Receiver<N>, PhysicalStore<N>, Stream2D<N,A,R,P>, Structure2D.ReducibleTo1D<R>, TransformationMatrix.Transformable<N>

All Known Implementing Classes:

Array2D, BigDenseStore, BigMatrix, ColumnsSupplier, ComplexDenseStore, ComplexMatrix, ComplexNumber, ComplexNumber.Normalised, ElementsConsumer.ColumnsRegion, ElementsConsumer.ConsumerRegion, ElementsConsumer.LimitRegion, ElementsConsumer.OffsetRegion, ElementsConsumer.RowsRegion, ElementsConsumer.TransposedRegion, GenericDenseStore, MatrixStore.LogicalBuilder, Primitive32Vector2, Primitive32Vector3, Primitive32Vector4, Primitive64Vector2, Primitive64Vector3, Primitive64Vector4, PrimitiveDenseStore, PrimitiveMatrix, Quaternion, Quaternion.Versor, QuaternionMatrix, RationalMatrix, RawStore, RowsSupplier, SparseStore

public interface Structure2D
extends Structure1D

A (fixed size) 2-dimensional data structure.

Author:

apete

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Structure2D.IntRowColumn
static class	Structure2D.LongRowColumn
static interface	Structure2D.ReducibleTo1D<R extends Structure1D>
static interface	Structure2D.RowColumnCallback
static class	Structure2D.RowColumnKey<R,C>
static class	Structure2D.RowColumnMapper<R,C>

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

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

Method Summary

Modifier and Type	Method and Description
static int	column(int index, int structure)
static int	column(int index, int[] structure)
static int	column(long index, int structure)
static long	column(long index, long structure)
static long	column(long index, long[] structure)
default long	count() count() == countRows() * countColumns()
long	countColumns()
long	countRows()
static int	index(int structure, int row, int column)
static long	index(long structure, long row, long column)
default boolean	isEmpty() 2D data structures are either square, tall, fat or empty.
default boolean	isFat() 2D data structures are either square, tall, fat or empty.
default boolean	isScalar()
default boolean	isSquare() 2D data structures are either square, tall, fat or empty.
default boolean	isTall() 2D data structures are either square, tall, fat or empty.
default boolean	isVector()
default void	loopAll(Structure2D.RowColumnCallback callback)
default void	loopColumn(long row, long col, Structure2D.RowColumnCallback callback)
default void	loopColumn(long col, Structure2D.RowColumnCallback callback)
default void	loopDiagonal(long row, long col, Structure2D.RowColumnCallback callback)
static void	loopMatching(Structure2D structureA, Structure2D structureB, Structure2D.RowColumnCallback callback)
default void	loopRow(long row, long col, Structure2D.RowColumnCallback callback)
default void	loopRow(long row, Structure2D.RowColumnCallback callback)
static <R,C> Structure2D.RowColumnMapper<R,C>	mapperOf(Structure2D structure, Structure1D.IndexMapper<R> rowMappwer, Structure1D.IndexMapper<C> columnMappwer)
static int	row(int index, int structure)
static int	row(int index, int[] structure)
static int	row(long index, int structure)
static long	row(long index, long structure)
static long	row(long index, long[] structure)

Methods inherited from interface org.ojalgo.access.Structure1D

loopAll, loopMatching, loopRange, mapper

Method Detail

mapperOf

static <R,C> Structure2D.RowColumnMapper<R,C> mapperOf(Structure2D structure,
                                                       Structure1D.IndexMapper<R> rowMappwer,
                                                       Structure1D.IndexMapper<C> columnMappwer)

column

static int column(int index,
                  int structure)

column

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

column

static int column(long index,
                  int structure)

column

static long column(long index,
                   long structure)

column

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

index

static int index(int structure,
                 int row,
                 int column)

index

static long index(long structure,
                  long row,
                  long column)

loopMatching

static void loopMatching(Structure2D structureA,
                         Structure2D structureB,
                         Structure2D.RowColumnCallback callback)

row

static int row(int index,
               int structure)

row

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

row

static int row(long index,
               int structure)

row

static long row(long index,
                long structure)

row

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

count

default long count()

count() == countRows() * countColumns()

Specified by:

count in interface Structure1D

Returns:

The total number of elements in this structure.

countColumns

long countColumns()

Returns:

The number of columns

countRows

long countRows()

Returns:

The number of rows

isEmpty

default boolean isEmpty()

2D data structures are either square, tall, fat or empty.

m <= 0 or n <= 0

Historically some ojAlgo data structures did allow to create "empty" instances. Currently this is not encouraged, but still possible in some instances.

Returns:

true if matrix is empty

isFat

default boolean isFat()

2D data structures are either square, tall, fat or empty.

1 <= m < n

Returns:

true if matrix is fat

isScalar

default boolean isScalar()

Returns:

true if both the row and column dimensions are equal to 1.

isSquare

default boolean isSquare()

2D data structures are either square, tall, fat or empty.

m = n <> 0

Returns:

true if matrix is square

isTall

default boolean isTall()

2D data structures are either square, tall, fat or empty.

m < n >= 1

Returns:

true if matrix is tall

isVector

default boolean isVector()

Returns:

true if either the row or column dimensions are equal to 1.

loopAll

default void loopAll(Structure2D.RowColumnCallback callback)

loopColumn

default void loopColumn(long row,
                        long col,
                        Structure2D.RowColumnCallback callback)

loopColumn

default void loopColumn(long col,
                        Structure2D.RowColumnCallback callback)

loopDiagonal

default void loopDiagonal(long row,
                          long col,
                          Structure2D.RowColumnCallback callback)

loopRow

default void loopRow(long row,
                     long col,
                     Structure2D.RowColumnCallback callback)

loopRow

default void loopRow(long row,
                     Structure2D.RowColumnCallback callback)