Module ojalgo

Package org.ojalgo.structure

Interface Access2D<N extends java.lang.Comparable<N>>

All Superinterfaces:

Access1D<N>, Structure1D, Structure2D

All Known Subinterfaces:

DecompositionStore<N>, Matrix2D<N,M>, MatrixStore<N>, Mutate2D.ModifiableReceiver<N>, PhysicalStore<N>, TransformableRegion<N>

All Known Implementing Classes:

AboveBelowStore, AbstractStore, Access2D.SelectionView, AccessAnyD.MatrixView, Array2D, BasicMatrix, ColumnsStore, ColumnsSupplier, ComplexNumber, ComposingStore, CompressedSparseR064, ConjugatedStore, DataBatch, DenseMutator2D, DenseTableau, DiagonalStore, FactoryStore, GenericStore, IdentityStore, ImageData, ImageData.SingleChannel, LeftRightStore, LimitStore, LogicalStore, LowerHessenbergStore, LowerSymmetricStore, LowerTriangularStore, MatrixC128, MatrixC128.DenseReceiver, MatrixH256, MatrixH256.DenseReceiver, MatrixQ128, MatrixQ128.DenseReceiver, MatrixR032, MatrixR032.DenseReceiver, MatrixR064, MatrixR064.DenseReceiver, MatrixR128, MatrixR128.DenseReceiver, MatrixTensor, OffsetStore, Primitive2D, Primitive2D.Simple, Primitive2D.Wrapper, Quaternion, R032Store, R064CSC, R064CSR, R064Store, RawStore, RepeatedColumnsStore, RepeatedRowsStore, RowsStore, RowsSupplier, SelectingStore, ShadingStore, SimplexTableau, SingleStore, SparseStore, SparseTableau, Subregion2D, Subregion2D.ColumnsRegion, Subregion2D.LimitRegion, Subregion2D.OffsetRegion, Subregion2D.RowsRegion, Subregion2D.SynchronizedRegion, Subregion2D.TransposedRegion, Subregion2D.WrapperRegion, SuperimposedStore, TransjugatedStore, TransposedStore, UnaryOperatoStore, UpperHessenbergStore, UpperSymmetricStore, UpperTriangularStore, WrapperStore, ZeroStore

public interface Access2D<N extends java.lang.Comparable<N>>
extends Structure2D, Access1D<N>

2-dimensional accessor methods

See Also:

Access1D

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Access2D.Aggregatable<N extends java.lang.Comparable<N>>
static interface	Access2D.Collectable<N extends java.lang.Comparable<N>,R extends Mutate2D>
static class	Access2D.ColumnView<N extends java.lang.Comparable<N>>
static class	Access2D.ElementView<N extends java.lang.Comparable<N>>
static class	Access2D.RowView<N extends java.lang.Comparable<N>>
static class	Access2D.SelectionView<N extends java.lang.Comparable<N>>
static interface	Access2D.Sliceable<N extends java.lang.Comparable<N>>
static interface	Access2D.Visitable<N extends java.lang.Comparable<N>>

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

Structure1D.BasicMapper<T>, Structure1D.IndexMapper<T>, Structure1D.IntIndex, Structure1D.Logical<S extends Structure1D,B extends Structure1D.Logical<S,B>>, Structure1D.LongIndex, Structure1D.LoopCallback

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

Structure2D.IntRowColumn, Structure2D.Logical<S extends Structure2D,B extends Structure2D.Logical<S,B>>, Structure2D.LongRowColumn, Structure2D.ReducibleTo1D<R extends Structure1D>, Structure2D.Reshapable, Structure2D.RowColumnKey<R,C>, Structure2D.RowColumnMapper<R,C>

Method Summary

Modifier and Type	Method	Description
default <NN extends java.lang.Comparable<NN>,R extends Mutate2D.Receiver<NN>> Access2D.Collectable<NN,R>	asCollectable2D()
default <R,C> Keyed2D<R,C,N>	asKeyed2D(Structure1D.IndexMapper<R> rowMapper, Structure1D.IndexMapper<C> columnMapper)
static Access2D<java.lang.Double>	asPrimitive2D(Access2D<?> access)	Deprecated. v54 Use Primitive2D.wrap(Structure2D) instead
default byte	byteValue(int index)
default byte	byteValue(int row, int col)
default byte	byteValue(long index)
default byte	byteValue(long row, long col)
default Access2D.ColumnView<N>	columns()
default Access2D<N>	columns(int... columns)
default Access2D<N>	columns(long... columns)
default double	doubleValue(int index)
double	doubleValue(int row, int col)	Extracts one element of this matrix as a double.
default double	doubleValue(long index)
default double	doubleValue(long row, long col)
default ElementView2D<N,?>	elements()	Returns an Iterable of ElementView1D.
static boolean	equals(Access2D<?> accessA, Access2D<?> accessB, NumberContext accuracy)
default float	floatValue(int index)
default float	floatValue(int row, int col)
default float	floatValue(long index)
default float	floatValue(long row, long col)
default N	get(long index)
N	get(long row, long col)
default int	intValue(int index)
default int	intValue(int row, int col)
default int	intValue(long index)
default int	intValue(long row, long col)
default long	longValue(int index)
default long	longValue(int row, int col)
default long	longValue(long index)
default long	longValue(long row, long col)
static <R extends Mutate2D.Receiver<java.lang.Double>> Access2D.Collectable<java.lang.Double,R>	newPrimitiveColumnCollectable(Access1D<?> anything1D)
static <R extends Mutate2D.Receiver<java.lang.Double>> Access2D.Collectable<java.lang.Double,R>	newPrimitiveRowCollectable(Access1D<?> anything1D)
default ElementView2D<N,?>	nonzeros()	Similar to Access1D.elements() but avoids elements that are structurally known to be zero.
default Access2D.RowView<N>	rows()
default Access2D<N>	rows(int... rows)
default Access2D<N>	rows(long... rows)
default Access2D<N>	select(int[] rows, int[] columns)
default Access2D<N>	select(long[] rows, long[] columns)	Creates a view of the underlying data structure of only the selected elements.
default short	shortValue(int index)
default short	shortValue(int row, int col)
default short	shortValue(long index)
default short	shortValue(long row, long col)
default double[][]	toRawCopy2D()
static java.lang.String	toString(Access2D<?> matrix)
static Access2D<java.lang.Double>	wrap(double[][] target)
static <N extends java.lang.Comparable<N>> Access2D<N>	wrap(N[][] target)

Methods inherited from interface org.ojalgo.structure.Access1D

asCollectable1D, asKeyed1D, asList, axpy, dot, select, supplyTo, toList, toRawCopy1D

Methods inherited from interface org.ojalgo.structure.Structure2D

count, countColumns, countRows, firstInColumn, firstInRow, getColDim, getMaxDim, getMinDim, getRowDim, isEmpty, isFat, isScalar, isSquare, isTall, isVector, limitOfColumn, limitOfRow, size

Method Detail

asPrimitive2D

@Deprecated
static Access2D<java.lang.Double> asPrimitive2D(Access2D<?> access)

Deprecated.

v54 Use Primitive2D.wrap(Structure2D) instead

equals

static boolean equals(Access2D<?> accessA,
                      Access2D<?> accessB,
                      NumberContext accuracy)

newPrimitiveColumnCollectable

static <R extends Mutate2D.Receiver<java.lang.Double>> Access2D.Collectable<java.lang.Double,R> newPrimitiveColumnCollectable(Access1D<?> anything1D)

newPrimitiveRowCollectable

static <R extends Mutate2D.Receiver<java.lang.Double>> Access2D.Collectable<java.lang.Double,R> newPrimitiveRowCollectable(Access1D<?> anything1D)

toString

static java.lang.String toString(Access2D<?> matrix)

wrap

static Access2D<java.lang.Double> wrap(double[][] target)

wrap

static <N extends java.lang.Comparable<N>> Access2D<N> wrap(N[][] target)

asCollectable2D

default <NN extends java.lang.Comparable<NN>,R extends Mutate2D.Receiver<NN>> Access2D.Collectable<NN,R> asCollectable2D()

asKeyed2D

default <R,C> Keyed2D<R,C,N> asKeyed2D(Structure1D.IndexMapper<R> rowMapper,
                                                         Structure1D.IndexMapper<C> columnMapper)

byteValue

default byte byteValue(int index)

Specified by:

byteValue in interface Access1D<N extends java.lang.Comparable<N>>

byteValue

default byte byteValue(int row,
                       int col)

byteValue

default byte byteValue(long index)

Specified by:

byteValue in interface Access1D<N extends java.lang.Comparable<N>>

byteValue

default byte byteValue(long row,
                       long col)

columns

default Access2D.ColumnView<N> columns()

columns

default Access2D<N> columns(int... columns)

columns

default Access2D<N> columns(long... columns)

doubleValue

default double doubleValue(int index)

Specified by:

doubleValue in interface Access1D<N extends java.lang.Comparable<N>>

doubleValue

double doubleValue(int row,
                   int col)

Extracts one element of this matrix as a double.

Parameters:

row - A row index.

col - A column index.

Returns:

One matrix element

doubleValue

default double doubleValue(long index)

Specified by:

doubleValue in interface Access1D<N extends java.lang.Comparable<N>>

doubleValue

default double doubleValue(long row,
                           long col)

elements

default ElementView2D<N,?> elements()

Description copied from interface: Access1D

Returns an Iterable of ElementView1D. It allows to iterate over the instance's element "positions" without actually extracting the elements (unless you explicitly do so).

Specified by:

elements in interface Access1D<N extends java.lang.Comparable<N>>

floatValue

default float floatValue(int index)

Specified by:

floatValue in interface Access1D<N extends java.lang.Comparable<N>>

floatValue

default float floatValue(int row,
                         int col)

floatValue

default float floatValue(long index)

Specified by:

floatValue in interface Access1D<N extends java.lang.Comparable<N>>

floatValue

default float floatValue(long row,
                         long col)

get

default N get(long index)

Specified by:

get in interface Access1D<N extends java.lang.Comparable<N>>

get

N get(long row,
      long col)

intValue

default int intValue(int index)

Specified by:

intValue in interface Access1D<N extends java.lang.Comparable<N>>

intValue

default int intValue(int row,
                     int col)

intValue

default int intValue(long index)

Specified by:

intValue in interface Access1D<N extends java.lang.Comparable<N>>

intValue

default int intValue(long row,
                     long col)

longValue

default long longValue(int index)

Specified by:

longValue in interface Access1D<N extends java.lang.Comparable<N>>

longValue

default long longValue(int row,
                       int col)

longValue

default long longValue(long index)

Specified by:

longValue in interface Access1D<N extends java.lang.Comparable<N>>

longValue

default long longValue(long row,
                       long col)

nonzeros

default ElementView2D<N,?> nonzeros()

Description copied from interface: Access1D

Similar to Access1D.elements() but avoids elements that are structurally known to be zero. (That does not eliminate all zero-values from this view.) With an arbitrary (dense) unstructured implementation the Access1D.nonzeros() and Access1D.elements() methods do the same thing! Only some specific implementations are able to actually exploit structure/sparsity to view fewer elements.

Specified by:

nonzeros in interface Access1D<N extends java.lang.Comparable<N>>

rows

default Access2D.RowView<N> rows()

rows

default Access2D<N> rows(int... rows)

rows

default Access2D<N> rows(long... rows)

select

default Access2D<N> select(int[] rows,
                           int[] columns)

select

default Access2D<N> select(long[] rows,
                           long[] columns)

Creates a view of the underlying data structure of only the selected elements. If either the rows or columns input arguments are null or empty arrays, then that transaltes to all rows and/or columns.

shortValue

default short shortValue(int index)

Specified by:

shortValue in interface Access1D<N extends java.lang.Comparable<N>>

shortValue

default short shortValue(int row,
                         int col)

shortValue

default short shortValue(long index)

Specified by:

shortValue in interface Access1D<N extends java.lang.Comparable<N>>

shortValue

default short shortValue(long row,
                         long col)

toRawCopy2D

default double[][] toRawCopy2D()