Module ojalgo

Package org.ojalgo.matrix.store

Class MatrixPipeline<N extends java.lang.Comparable<N>>

java.lang.Object

org.ojalgo.matrix.store.MatrixPipeline<N>

All Implemented Interfaces:

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

Direct Known Subclasses:

MatrixPipeline.BinaryOperatorLeft, MatrixPipeline.BinaryOperatorRight, MatrixPipeline.ColumnsModifier, MatrixPipeline.ColumnsReducer, MatrixPipeline.Multiplication, MatrixPipeline.RowsModifier, MatrixPipeline.RowsReducer, MatrixPipeline.Transformer, MatrixPipeline.Transpose, MatrixPipeline.UnaryOperator

abstract class MatrixPipeline<N extends java.lang.Comparable<N>>
extends java.lang.Object
implements ElementsSupplier<N>

Intermediate step in a matrix pipeline – a chain of operations to be executed when the elements are extracted. Intermediate steps cannot alter the size/shape of the (future) matrix, only the elements themselves. One notable exception is the ElementsSupplier.transpose() operation, which can change the shape of the matrix.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	MatrixPipeline.BinaryOperatorLeft<N extends java.lang.Comparable<N>>
(package private) static class	MatrixPipeline.BinaryOperatorRight<N extends java.lang.Comparable<N>>
(package private) static class	MatrixPipeline.ColumnsModifier<N extends java.lang.Comparable<N>>
(package private) static class	MatrixPipeline.ColumnsReducer<N extends java.lang.Comparable<N>>
(package private) static class	MatrixPipeline.Multiplication<N extends java.lang.Comparable<N>>
(package private) static class	MatrixPipeline.RowsModifier<N extends java.lang.Comparable<N>>
(package private) static class	MatrixPipeline.RowsReducer<N extends java.lang.Comparable<N>>
(package private) static class	MatrixPipeline.Transformer<N extends java.lang.Comparable<N>>
(package private) static class	MatrixPipeline.Transpose<N extends java.lang.Comparable<N>>
(package private) static class	MatrixPipeline.UnaryOperator<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.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>

Field Summary

Fields

Modifier and Type	Field	Description
private int	myColumnsCount
private ElementsSupplier<N>	myContext
private int	myRowsCount

Constructor Summary

Constructors

Constructor	Description
MatrixPipeline(ElementsSupplier<N> context)
MatrixPipeline(ElementsSupplier<N> context, int rowsCount, int columnsCount)

Method Summary

Modifier and Type	Method	Description
long	countColumns()	Only need to implement if the structure may contain more than Integer.MAX_VALUE elements.
long	countRows()	Only need to implement if the structure may contain more than Integer.MAX_VALUE elements.
int	getColDim()
(package private) ElementsSupplier<N>	getContext()
int	getRowDim()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

collect, supplyTo

Methods inherited from interface org.ojalgo.matrix.store.ElementsSupplier

onAll, onAny, onColumns, onColumns, onMatching, onMatching, onRows, onRows, transpose

Methods inherited from interface org.ojalgo.structure.Operate2D

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

Methods inherited from interface org.ojalgo.structure.Structure2D

count, firstInColumn, firstInRow, getMaxDim, getMinDim, isEmpty, isFat, isScalar, isSquare, isTall, isVector, limitOfColumn, limitOfRow, size

Field Detail

myColumnsCount

private final int myColumnsCount

myContext

private final ElementsSupplier<N extends java.lang.Comparable<N>> myContext

myRowsCount

private final int myRowsCount

Constructor Detail

MatrixPipeline

MatrixPipeline(ElementsSupplier<N> context)

MatrixPipeline

MatrixPipeline(ElementsSupplier<N> context,
               int rowsCount,
               int columnsCount)

Method Detail

countColumns

public final long countColumns()

Description copied from interface: Structure2D

Only need to implement if the structure may contain more than Integer.MAX_VALUE elements.

Specified by:

countColumns in interface Structure2D

Returns:

The number of columns

countRows

public final long countRows()

Description copied from interface: Structure2D

Only need to implement if the structure may contain more than Integer.MAX_VALUE elements.

Specified by:

countRows in interface Structure2D

Returns:

The number of rows

getColDim

public final int getColDim()

Specified by:

getColDim in interface Structure2D

Returns:

The number of columns

getRowDim

public final int getRowDim()

Specified by:

getRowDim in interface Structure2D

Returns:

The number of rows

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

getContext

final ElementsSupplier<N> getContext()