Module ojalgo

Package org.ojalgo.matrix.store

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

All Superinterfaces:

Access2D.Collectable<N,TransformableRegion<N>>, Operate2D<N,ElementsSupplier<N>>, Structure1D, Structure2D

All Known Subinterfaces:

DecompositionStore<N>, MatrixStore<N>, PhysicalStore<N>

All Known Implementing Classes:

AboveBelowStore, AbstractStore, ColumnsStore, ColumnsSupplier, ComposingStore, CompressedSparseR064, ConjugatedStore, DiagonalStore, FactoryStore, GenericStore, IdentityStore, ImageData, ImageData.SingleChannel, LeftRightStore, LimitStore, LogicalStore, LowerHessenbergStore, LowerSymmetricStore, LowerTriangularStore, MatrixPipeline, MatrixPipeline.BinaryOperatorLeft, MatrixPipeline.BinaryOperatorRight, MatrixPipeline.ColumnsModifier, MatrixPipeline.ColumnsReducer, MatrixPipeline.Multiplication, MatrixPipeline.RowsModifier, MatrixPipeline.RowsReducer, MatrixPipeline.Transformer, MatrixPipeline.Transpose, MatrixPipeline.UnaryOperator, OffsetStore, R032Store, R064CSC, R064CSR, R064Store, RawStore, RepeatedColumnsStore, RepeatedRowsStore, RowsStore, RowsSupplier, SelectingStore, ShadingStore, SingleStore, SparseStore, SuperimposedStore, TransjugatedStore, TransposedStore, UnaryOperatoStore, UpperHessenbergStore, UpperSymmetricStore, UpperTriangularStore, WrapperStore, ZeroStore

public interface ElementsSupplier<N extends java.lang.Comparable<N>>
extends Operate2D<N,ElementsSupplier<N>>, Access2D.Collectable<N,TransformableRegion<N>>

An ElementsSupplier is not necessarily (or not yet) a matrix, but something from which the elements of a matrix can be derived. There are several matrix related things you can do with them:

1. You can query the size/shape of the (future) matrix.
2. You can supply the elements to an already existing matrix (or more precisely to a TransformableRegion) or collect them into a new matrix using a Factory2D.
3. You can define a stream of additional operations to be executed when the elements are extracted.

Nested Class Summary

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

Structure1D.BasicMapper<T>, Structure1D.IndexMapper<T>, Structure1D.IntIndex, 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 ElementsSupplier<N>	onAll(UnaryFunction<N> operator)
default ElementsSupplier<N>	onAny(Transformation2D<N> operator)
default ElementsSupplier<N>	onColumns(BinaryFunction<N> operator, Access1D<N> right)
default ElementsSupplier<N>	onColumns(Access1D<N> left, BinaryFunction<N> operator)
default ElementsSupplier<N>	onMatching(BinaryFunction<N> operator, Access2D<N> right)
default ElementsSupplier<N>	onMatching(Access2D<N> left, BinaryFunction<N> operator)
default ElementsSupplier<N>	onRows(BinaryFunction<N> operator, Access1D<N> right)
default ElementsSupplier<N>	onRows(Access1D<N> left, BinaryFunction<N> operator)
default ElementsSupplier<N>	transpose()

Methods inherited from interface org.ojalgo.structure.Access2D.Collectable

collect, supplyTo

Methods inherited from interface org.ojalgo.structure.Operate2D

onAll, onAll, onAll, onAll, onAll, onCompatible, onCompatible

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

onAll

default ElementsSupplier<N> onAll(UnaryFunction<N> operator)

Specified by:

onAll in interface Operate2D<N extends java.lang.Comparable<N>,ElementsSupplier<N extends java.lang.Comparable<N>>>

onAny

default ElementsSupplier<N> onAny(Transformation2D<N> operator)

Specified by:

onAny in interface Operate2D<N extends java.lang.Comparable<N>,ElementsSupplier<N extends java.lang.Comparable<N>>>

onColumns

default ElementsSupplier<N> onColumns(Access1D<N> left,
                                      BinaryFunction<N> operator)

Specified by:

onColumns in interface Operate2D<N extends java.lang.Comparable<N>,ElementsSupplier<N extends java.lang.Comparable<N>>>

onColumns

default ElementsSupplier<N> onColumns(BinaryFunction<N> operator,
                                      Access1D<N> right)

Specified by:

onColumns in interface Operate2D<N extends java.lang.Comparable<N>,ElementsSupplier<N extends java.lang.Comparable<N>>>

onMatching

default ElementsSupplier<N> onMatching(Access2D<N> left,
                                       BinaryFunction<N> operator)

Specified by:

onMatching in interface Operate2D<N extends java.lang.Comparable<N>,ElementsSupplier<N extends java.lang.Comparable<N>>>

onMatching

default ElementsSupplier<N> onMatching(BinaryFunction<N> operator,
                                       Access2D<N> right)

Specified by:

onMatching in interface Operate2D<N extends java.lang.Comparable<N>,ElementsSupplier<N extends java.lang.Comparable<N>>>

onRows

default ElementsSupplier<N> onRows(Access1D<N> left,
                                   BinaryFunction<N> operator)

Specified by:

onRows in interface Operate2D<N extends java.lang.Comparable<N>,ElementsSupplier<N extends java.lang.Comparable<N>>>

onRows

default ElementsSupplier<N> onRows(BinaryFunction<N> operator,
                                   Access1D<N> right)

Specified by:

onRows in interface Operate2D<N extends java.lang.Comparable<N>,ElementsSupplier<N extends java.lang.Comparable<N>>>

transpose

default ElementsSupplier<N> transpose()