Uses of Interface
org.ojalgo.structure.Structure2D

Packages that use Structure2D

Package	Description
org.ojalgo
org.ojalgo.ann
org.ojalgo.array
org.ojalgo.data
org.ojalgo.data.image
org.ojalgo.matrix
org.ojalgo.matrix.decomposition
org.ojalgo.matrix.store
org.ojalgo.matrix.task
org.ojalgo.matrix.transformation
org.ojalgo.optimisation.convex
org.ojalgo.scalar
org.ojalgo.structure
org.ojalgo.tensor

Uses of Structure2D in org.ojalgo

Methods in org.ojalgo with parameters of type Structure2D

Modifier and Type	Method	Description
static void	ProgrammingError.throwIfNotEqualRowDimensions(Structure2D mtrx1, Structure1D mtrx2)
static void	ProgrammingError.throwIfNotSquare(Structure2D mtrx)

Uses of Structure2D in org.ojalgo.ann

Methods in org.ojalgo.ann that return Structure2D

Modifier and Type	Method	Description
Structure2D[]	ArtificialNeuralNetwork.structure()
Structure2D[]	NetworkTrainer.structure()

Uses of Structure2D in org.ojalgo.array

Classes in org.ojalgo.array that implement Structure2D

Modifier and Type	Class	Description
final class	Array2D<N extends Comparable<N>>	Array2D

Uses of Structure2D in org.ojalgo.data

Classes in org.ojalgo.data that implement Structure2D

Modifier and Type	Class	Description
final class	DataBatch	A reusable data batch.

Uses of Structure2D in org.ojalgo.data.image

Classes in org.ojalgo.data.image that implement Structure2D

Modifier and Type	Class	Description
class	ImageData	Treats an image as a matrix.

Methods in org.ojalgo.data.image with parameters of type Structure2D

Modifier and Type	Method	Description
static ImageData	ImageData.newColour(Structure2D shape)
static ImageData	ImageData.newGreyScale(Structure2D shape)

Uses of Structure2D in org.ojalgo.matrix

Subinterfaces of Structure2D in org.ojalgo.matrix

Modifier and Type	Interface	Description
interface	Matrix2D<N extends Comparable<N>,M extends Matrix2D<N,M>>	Definition of what's common to BasicMatrix and MatrixStore.

Classes in org.ojalgo.matrix that implement Structure2D

Modifier and Type	Class	Description
class	BasicMatrix<N extends Comparable<N>,M extends BasicMatrix<N,M>>	A base class for, easy to use, immutable (thread safe) matrices with a rich feature set.
final class	MatrixC128	A matrix (linear algebra) with Complex NumberSet.C elements, implemented using dual 64-bit double values. (2 x 64 = 128)
static final class	MatrixC128.DenseReceiver
static final class	MatrixC128.SparseReceiver
final class	MatrixH256	A matrix (linear algebra) with Quaternion NumberSet.H elements, implemented using four 64-bit double values. (4 x 64 = 256)
static final class	MatrixH256.DenseReceiver
static final class	MatrixH256.SparseReceiver
final class	MatrixQ128	A matrix (linear algebra) with Rational NumberSet.Q elements, implemented using dual 64-bit long values. (2 x 64 = 128)
static final class	MatrixQ128.DenseReceiver
static final class	MatrixQ128.SparseReceiver
final class	MatrixR032	A matrix (linear algebra) with Real NumberSet.R elements, approximated by 32-bit float.
static final class	MatrixR032.DenseReceiver
static final class	MatrixR032.SparseReceiver
final class	MatrixR064	A matrix (linear algebra) with Real NumberSet.R elements, approximated by 64-bit double.
static final class	MatrixR064.DenseReceiver
static final class	MatrixR064.SparseReceiver
final class	MatrixR128	A matrix (linear algebra) with Real NumberSet.R elements, approximated by 128-bit floating-point values (implemented using dual 64-bit double). (2 x 64 = 128)
static final class	MatrixR128.DenseReceiver
static final class	MatrixR128.SparseReceiver

Methods in org.ojalgo.matrix with parameters of type Structure2D

Modifier and Type	Method	Description
M	MatrixFactory.makeEye(Structure2D shape)

Uses of Structure2D in org.ojalgo.matrix.decomposition

Subinterfaces of Structure2D in org.ojalgo.matrix.decomposition

Modifier and Type	Interface	Description
interface	Bidiagonal<N extends Comparable<N>>	A general matrix [A] can be factorized by similarity transformations into the form [A]=[LQ][D][RQ] -1 where: [A] (m-by-n) is any, real or complex, matrix [D] (r-by-r) or (m-by-n) is, upper or lower, bidiagonal [LQ] (m-by-r) or (m-by-m) is orthogonal [RQ] (n-by-r) or (n-by-n) is orthogonal r = min(m,n)
interface	Cholesky<N extends Comparable<N>>	Cholesky: [A] = [L][L]H (or [R]H[R])
interface	DecompositionStore<N extends Comparable<N>>	Only classes that will act as a delegate to a MatrixDecomposition implementation from this package should implement this interface.
interface	Eigenvalue<N extends Comparable<N>>	[A] = [V][D][V]-1 ([A][V] = [V][D]) [A] = any square matrix. [V] = contains the eigenvectors as columns. [D] = a diagonal matrix with the eigenvalues on the diagonal (possibly in blocks).
static interface	Eigenvalue.Generalised<N extends Comparable<N>>
static interface	Eigenvalue.Spectral<N extends Comparable<N>>	“Spectral decomposition” refers specifically to the orthogonal/unitary eigen-decomposition of a normal matrix (most commonly Hermitian / symmetric).
interface	Hessenberg<N extends Comparable<N>>	Hessenberg: [A] = [Q][H][Q]T A general square matrix [A] can be decomposed by orthogonal similarity transformations into the form [A]=[Q][H][Q]T where [H] is upper (or lower) hessenberg matrix [Q] is orthogonal/unitary
interface	LDL<N extends Comparable<N>>	LDL: [A] = [L][D][L]H (or [R]H[D][R])
interface	LDU<N extends Comparable<N>>	LDU: [A] = [L][D][U] ( [PL][L][D][U][PU] )
interface	LU<N extends Comparable<N>>	LU: [A] = [L][U]
interface	MatrixDecomposition<N extends Comparable<N>>	Notation used to describe the various matrix decompositions: [A] could be any matrix.
static interface	MatrixDecomposition.Determinant<N extends Comparable<N>>
static interface	MatrixDecomposition.EconomySize<N extends Comparable<N>>	Several matrix decompositions can be expressed "economy sized" - some rows or columns of the decomposed matrix parts are not needed for the most releveant use cases, and can therefore be left out.
static interface	MatrixDecomposition.Hermitian<N extends Comparable<N>>	Some matrix decompositions are only available with hermitian (symmetric) matrices or different decomposition algorithms could be used depending on if the matrix is hemitian or not.
static interface	MatrixDecomposition.Ordered<N extends Comparable<N>>
static interface	MatrixDecomposition.Pivoting<N extends Comparable<N>>	The pivot or pivot element is the element of a matrix, or an array, which is selected first by an algorithm (e.g.
static interface	MatrixDecomposition.RankRevealing<N extends Comparable<N>>	A rank-revealing matrix decomposition of a matrix [A] is a decomposition that is, or can be transformed to be, on the form [A]=[X][D][Y]T where: [X] and [Y] are square and well conditioned. [D] is diagonal with nonnegative and non-increasing values on the diagonal.
static interface	MatrixDecomposition.Solver<N extends Comparable<N>>
static interface	MatrixDecomposition.Updatable<N extends Comparable<N>>
static interface	MatrixDecomposition.Values<N extends Comparable<N>>	Eigenvalue and Singular Value decompositions can calculate the "values" only.
interface	QR<N extends Comparable<N>>	QR: [A] = [Q][R] Decomposes [this] into [Q] and [R] where: [Q] is an orthogonal matrix (orthonormal columns).
interface	SingularValue<N extends Comparable<N>>	Singular Value: [A] = [U][S][V]T Decomposes [this] into [U], [S] and [V] where: [U] is an orthogonal matrix.
interface	Tridiagonal<N extends Comparable<N>>	Tridiagonal: [A] = [Q][D][Q]H Any square symmetric (hermitian) matrix [A] can be factorized by similarity transformations into the form, [A]=[Q][D][Q]-1 where [Q] is an orthogonal (unitary) matrix and [D] is a real symmetric tridiagonal matrix.

Classes in org.ojalgo.matrix.decomposition that implement Structure2D

Modifier and Type	Class	Description
final class	SparseQDLDL	Quasi-Definite LDL (QDLDL) sparse decomposition.

Fields in org.ojalgo.matrix.decomposition declared as Structure2D

Modifier and Type	Field	Description
static final Structure2D	MatrixDecomposition.TYPICAL

Methods in org.ojalgo.matrix.decomposition with parameters of type Structure2D

Modifier and Type	Method	Description
default Bidiagonal<N>	Bidiagonal.Factory.make(Structure2D typical)
Bidiagonal<N>	Bidiagonal.Factory.make(Structure2D typical, boolean fullSize)
default Eigenvalue<N>	Eigenvalue.Factory.make(Structure2D typical)
Eigenvalue<N>	Eigenvalue.Factory.make(Structure2D typical, boolean hermitian)
LDL<N>	LDL.ModifiedFactory.make(Structure2D typical)
D	MatrixDecomposition.Factory.make(Structure2D typical)	Will create a new decomposition instance suitable for matrices of the specified size.
default QR<N>	QR.Factory.make(Structure2D typical)
QR<N>	QR.Factory.make(Structure2D typical, boolean fullSize)
default SingularValue<N>	SingularValue.Factory.make(Structure2D typical)
SingularValue<N>	SingularValue.Factory.make(Structure2D typical, boolean fullSize)
default Eigenvalue.Generalised<N>	Eigenvalue.Factory.makeGeneralised(Structure2D typical)	Deprecated. v56 Use Eigenvalue.Factory.makeGeneralised(Structure2D, Eigenvalue.Generalisation) instead, then it's more clear what you're actually doing.
Eigenvalue.Generalised<N>	Eigenvalue.Factory.makeGeneralised(Structure2D typical, Eigenvalue.Generalisation type)	"Generalised" does NOT refer to general (as in not symmetric/hermitian) matrices, but to generalised eigenvalue problems.

Uses of Structure2D in org.ojalgo.matrix.store

Subinterfaces of Structure2D in org.ojalgo.matrix.store

Modifier and Type	Interface	Description
interface	ElementsSupplier<N extends Comparable<N>>	An ElementsSupplier is not necessarily (or not yet) a matrix, but something from which the elements of a matrix can be derived.
interface	MatrixStore<N extends Comparable<N>>	A MatrixStore is a two dimensional store of numbers/scalars.
interface	PhysicalStore<N extends Comparable<N>>	PhysicalStore:s, as opposed to MatrixStore:s, are mutable.
interface	SparseStructure2D	Additional methods for sparse matrix implementations that store only non-zero elements.
interface	TransformableRegion<N extends Comparable<N>>	A transformable 2D (sub)region.

Classes in org.ojalgo.matrix.store that implement Structure2D

Modifier and Type	Class	Description
final class	ColumnsSupplier<N extends Comparable<N>>	Sparse columns – columns can be added and removed.
static final class	ColumnsSupplier.SingleView<N extends Comparable<N>>
final class	DiagonalStore<N extends Comparable<N>,D extends Access1D<?>>
final class	GenericStore<N extends Scalar<N>>	A generic implementation of PhysicalStore.
final class	R032Store	A invalid reference float implementation of PhysicalStore.
final class	R064CSC	A compressed sparse column (CSC) matrix store implementation for double precision values.
static final class	R064CSC.Builder	A builder for constructing R064CSR instances.
final class	R064CSR	A compressed sparse row (CSR) matrix store implementation for double precision values.
static final class	R064CSR.Builder	A builder for constructing CSR matrix stores. the dimensions of the matrix are determined by the highest row and column indices set.
final class	R064Store	A invalid reference double implementation of PhysicalStore.
final class	RawStore	Uses double[][] internally.
final class	RowsSupplier<N extends Comparable<N>>	Sparse rows – rows can be added and removed.
static final class	RowsSupplier.SingleView<N extends Comparable<N>>
final class	SparseStore<N extends Comparable<N>>	A sparse matrix (this implementation) is not thread safe.
static final class	SparseStore.Builder<N extends Comparable<N>>	May be a preferable way to build a sparse matrix if: You don't know the number of nonzero elements in advance.

Methods in org.ojalgo.matrix.store with parameters of type Structure2D

Modifier and Type	Method	Description
boolean	R032Store.isAcceptable(Structure2D supplier)
default I	PhysicalStore.Factory.makeEye(Structure2D shape)
default SparseStore<N>	PhysicalStore.Factory.makeSparse(Structure2D shape)
default MatrixStore<N>	PhysicalStore.Factory.makeZero(Structure2D shape)

Uses of Structure2D in org.ojalgo.matrix.task

Methods in org.ojalgo.matrix.task with parameters of type Structure2D

Modifier and Type	Method	Description
abstract DeterminantTask<N>	DeterminantTask.Factory.make(Structure2D template, boolean symmetric, boolean positiveDefinite)
abstract InverterTask<N>	InverterTask.Factory.make(Structure2D template, boolean symmetric, boolean positiveDefinite)
abstract SolverTask<N>	SolverTask.Factory.make(Structure2D templateBody, Structure2D templateRHS, boolean symmetric, boolean positiveDefinite)
default PhysicalStore<N>	InverterTask.preallocate(Structure2D template)	Will create a PhysicalStore instance suitable for use with InverterTask.invert(Access2D, PhysicalStore).
default PhysicalStore<N>	SolverTask.preallocate(Structure2D templateBody, Structure2D templateRHS)	Will create a PhysicalStore instance suitable for use with SolverTask.solve(Access2D, Access2D, PhysicalStore).

Uses of Structure2D in org.ojalgo.matrix.transformation

Subinterfaces of Structure2D in org.ojalgo.matrix.transformation

Modifier and Type	Interface	Description
interface	InvertibleFactor<N extends Comparable<N>>	A chainable and reversible in-place (equation system) solver.

Classes in org.ojalgo.matrix.transformation that implement Structure2D

Modifier and Type	Class	Description
static final class	InvertibleFactor.IdentityFactor<N extends Comparable<N>>

Uses of Structure2D in org.ojalgo.optimisation.convex

Methods in org.ojalgo.optimisation.convex with parameters of type Structure2D

Modifier and Type	Method	Description
MatrixDecomposition.Solver<Double>	ConvexSolver.Configuration.newSolverGeneral(Structure2D structure)
MatrixDecomposition.Solver<Double>	ConvexSolver.Configuration.newSolverSPD(Structure2D structure)

Method parameters in org.ojalgo.optimisation.convex with type arguments of type Structure2D

Modifier and Type	Method	Description
ConvexSolver.Configuration	ConvexSolver.Configuration.solverGeneral(Function<Structure2D,MatrixDecomposition.Solver<Double>> factory)	This matrix decomposition should be able to "invert" the full KKT systsem body matrix (which is symmetric) and/or its Schur complement with regards to the [Q] matrix (of quadratic terms).
ConvexSolver.Configuration	ConvexSolver.Configuration.solverSPD(Function<Structure2D,MatrixDecomposition.Solver<Double>> factory)	The [Q] matrix (of quadratic terms) is supposed to be symmetric positive definite (or at least semidefinite), but in reality there are usually many deficiencies.

Uses of Structure2D in org.ojalgo.scalar

Classes in org.ojalgo.scalar that implement Structure2D

Modifier and Type	Class	Description
final class	ComplexNumber	ComplexNumber is an immutable complex number class.
final class	Quaternion

Uses of Structure2D in org.ojalgo.structure

Classes in org.ojalgo.structure with type parameters of type Structure2D

Modifier and Type	Interface	Description
interface	Factory2D<I extends Structure2D>
static interface	Factory2D.Builder<I extends Structure2D>
static interface	Factory2D.MayBeSparse<I extends Structure2D,DENSE extends Factory2D.Builder<I>,SPARSE extends Factory2D.Builder<I>>	For when the structures can be either dense or sparse.
static interface	Factory2D.TwoStep<I extends Structure2D,B extends Factory2D.Builder<I>>
static interface	Structure2D.Logical<S extends Structure2D,B extends Structure2D.Logical<S,B>>
static interface	StructureAnyD.ReducibleTo2D<R extends Structure2D>

Subinterfaces of Structure2D in org.ojalgo.structure

Modifier and Type	Interface	Description
interface	Access2D<N extends Comparable<N>>	2-dimensional accessor methods
static interface	Access2D.Aggregatable<N extends Comparable<N>>
static interface	Access2D.Collectable<N extends Comparable<N>,R extends Mutate2D>
static interface	Access2D.Sliceable<N extends Comparable<N>>
static interface	Access2D.Visitable<N extends Comparable<N>>
static interface	Factory2D.Builder<I extends Structure2D>
interface	Mutate2D	2-dimensional mutator methods
static interface	Mutate2D.Exchangeable	A few operations with no 1D or AnyD counterpart.
static interface	Mutate2D.Fillable<N extends Comparable<N>>
static interface	Mutate2D.Mixable<N extends Comparable<N>>
static interface	Mutate2D.Modifiable<N extends Comparable<N>>
static interface	Mutate2D.ModifiableReceiver<N extends Comparable<N>>	Apart from extending Mutate2D.Receiver this interface extends Mutate2D.Modifiable and Mutate2D.Exchangeable which both imply access to existing elements as well as Access2D that dictates explicit access.
static interface	Mutate2D.Receiver<N extends Comparable<N>>
interface	Operate2D<N extends Comparable<N>,P extends Operate2D<N,P>>	To be implemented by classes that are not directly mutable themselves, but that can operate on the elements of some internal/future 2D data structure – similar to streams in some sense.
static interface	Structure2D.Logical<S extends Structure2D,B extends Structure2D.Logical<S,B>>
static interface	Structure2D.ReducibleTo1D<R extends Structure1D>
static interface	Structure2D.Reshapable

Classes in org.ojalgo.structure that implement Structure2D

Modifier and Type	Class	Description
static final class	Access2D.SelectionView<N extends Comparable<N>>
static final class	AccessAnyD.MatrixView<N extends Comparable<N>>
class	Primitive2D

Methods in org.ojalgo.structure that return Structure2D

Modifier and Type	Method	Description
Structure2D	Structure2D.Reshapable.reshape(long rows, long columns)

Methods in org.ojalgo.structure with parameters of type Structure2D

Modifier and Type	Method	Description
B	Structure2D.Logical.above(S... above)
B	Structure2D.Logical.below(S... below)
B	Structure2D.Logical.diagonally(S... diagonally)
default boolean	Mutate2D.Receiver.isAcceptable(Structure2D supplier)
B	Structure2D.Logical.left(S... left)
default I	Factory2D.make(Structure2D shape)
default I	Factory2D.TwoStep.make(Structure2D shape)
static <R, C> Structure2D.RowColumnMapper<R,C>	Structure2D.mapperOf(Structure2D structure, Structure1D.IndexMapper<R> rowMappwer, Structure1D.IndexMapper<C> columnMappwer)
B	Structure2D.Logical.right(S... right)
static Primitive2D	Primitive2D.wrap(Structure2D delegate)

Constructors in org.ojalgo.structure with parameters of type Structure2D

Modifier	Constructor	Description
protected	RowColumnMapper(Structure2D structure, Structure1D.IndexMapper<R> rowMapper, Structure1D.IndexMapper<C> columnMapper)

Uses of Structure2D in org.ojalgo.tensor

Classes in org.ojalgo.tensor that implement Structure2D

Modifier and Type	Class	Description
final class	MatrixTensor<N extends Comparable<N>>