org.ojalgo.matrix.store

Interface ElementsSupplier<N extends Number>

All Superinterfaces:

Access2D.Collectable<N,ElementsConsumer<N>>, Stream2D<N,MatrixStore<N>,ElementsConsumer<N>,ElementsSupplier<N>>, Structure1D, Structure2D, Supplier<MatrixStore<N>>

All Known Subinterfaces:

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

All Known Implementing Classes:

BigDenseStore, ColumnsSupplier, ComplexDenseStore, GenericDenseStore, MatrixStore.LogicalBuilder, PrimitiveDenseStore, RawStore, RowsSupplier, SparseStore

public interface ElementsSupplier<N extends Number>
extends Stream2D<N,MatrixStore<N>,ElementsConsumer<N>,ElementsSupplier<N>>, Supplier<MatrixStore<N>>

An elements supplier is not (yet) a matrix, but 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 an ElementsConsumer) or collect them using a Factory2D.
3. You can define a stream of additional operations to be executed when the elements are extracted.
4. You can get that matrix

Author:

apete

Nested Class Summary

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

Structure2D.IntRowColumn, Structure2D.LongRowColumn, Structure2D.ReducibleTo1D<R extends Structure1D>, Structure2D.RowColumnCallback, Structure2D.RowColumnKey<R,C>, 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
default MatrixStore<N>	get()
default ElementsSupplier<N>	operateOnAll(UnaryFunction<N> operator)
default ElementsSupplier<N>	operateOnMatching(BinaryFunction<N> operator, MatrixStore<N> right)
default ElementsSupplier<N>	operateOnMatching(MatrixStore<N> left, BinaryFunction<N> operator)
PhysicalStore.Factory<N,?>	physical()
default ElementsSupplier<N>	transpose()

Methods inherited from interface org.ojalgo.access.Stream2D

operateOnAll, operateOnAll, operateOnAll, operateOnAll, operateOnAll

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

collect, supplyTo

Methods inherited from interface org.ojalgo.access.Structure2D

column, column, column, column, column, count, countColumns, countRows, index, index, isEmpty, isFat, isScalar, isSquare, isTall, isVector, loopAll, loopColumn, loopColumn, loopDiagonal, loopMatching, loopRow, loopRow, mapperOf, row, row, row, row, row

Methods inherited from interface org.ojalgo.access.Structure1D

loopAll, loopMatching, loopRange, mapper

Method Detail

get

default MatrixStore<N> get()

Specified by:

get in interface Supplier<MatrixStore<N extends Number>>

operateOnAll

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

Specified by:

operateOnAll in interface Stream2D<N extends Number,MatrixStore<N extends Number>,ElementsConsumer<N extends Number>,ElementsSupplier<N extends Number>>

operateOnMatching

default ElementsSupplier<N> operateOnMatching(BinaryFunction<N> operator,
                                              MatrixStore<N> right)

Specified by:

operateOnMatching in interface Stream2D<N extends Number,MatrixStore<N extends Number>,ElementsConsumer<N extends Number>,ElementsSupplier<N extends Number>>

operateOnMatching

default ElementsSupplier<N> operateOnMatching(MatrixStore<N> left,
                                              BinaryFunction<N> operator)

Specified by:

operateOnMatching in interface Stream2D<N extends Number,MatrixStore<N extends Number>,ElementsConsumer<N extends Number>,ElementsSupplier<N extends Number>>

physical

PhysicalStore.Factory<N,?> physical()

transpose

default ElementsSupplier<N> transpose()

Specified by:

transpose in interface Stream2D<N extends Number,MatrixStore<N extends Number>,ElementsConsumer<N extends Number>,ElementsSupplier<N extends Number>>