Module ojalgo

Package org.ojalgo.matrix.decomposition

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

All Superinterfaces:

Access1D<N>, Access1D.Aggregatable<N>, Access1D.Collectable<N,Mutate1D>, Access1D.Sliceable<N>, Access1D.Visitable<N>, Access2D<N>, Access2D.Aggregatable<N>, Access2D.Collectable<N,TransformableRegion<N>>, Access2D.Sliceable<N>, Access2D.Visitable<N>, java.util.function.Consumer<Access2D<?>>, ElementsSupplier<N>, ExchangeColumns, Group, Group.Additive<MatrixStore<N>>, Matrix2D<N,MatrixStore<N>>, MatrixStore<N>, Mutate1D, Mutate1D.Fillable<N>, Mutate1D.Modifiable<N>, Mutate2D, Mutate2D.Exchangeable, Mutate2D.Fillable<N>, Mutate2D.Modifiable<N>, Mutate2D.ModifiableReceiver<N>, Mutate2D.Receiver<N>, NegateColumn, NormedVectorSpace<MatrixStore<N>,N>, Operate2D<N,ElementsSupplier<N>>, Operation, Operation.Addition<MatrixStore<N>>, Operation.Multiplication<MatrixStore<N>>, Operation.Subtraction<MatrixStore<N>>, PhysicalStore<N>, RotateRight, ScalarOperation, ScalarOperation.Addition<MatrixStore<N>,N>, ScalarOperation.Division<MatrixStore<N>,N>, ScalarOperation.Multiplication<MatrixStore<N>,N>, ScalarOperation.Subtraction<MatrixStore<N>,N>, Structure1D, Structure2D, Structure2D.Logical<Access2D<N>,MatrixStore<N>>, Structure2D.ReducibleTo1D<ElementsSupplier<N>>, TransformableRegion<N>, VectorSpace<MatrixStore<N>,N>

All Known Implementing Classes:

GenericStore, R064Store

public interface DecompositionStore<N extends java.lang.Comparable<N>>
extends PhysicalStore<N>, RotateRight, ExchangeColumns, NegateColumn

Only classes that will act as a delegate to a MatrixDecomposition implementation from this package should implement this interface. The interface specifications are entirely dictated by the classes in this package.

Do not use it for anything else!

Nested Class Summary

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

Access2D.Aggregatable<N extends java.lang.Comparable<N>>, Access2D.Collectable<N extends java.lang.Comparable<N>,R extends Mutate2D>, Access2D.ColumnView<N extends java.lang.Comparable<N>>, Access2D.ElementView<N extends java.lang.Comparable<N>>, Access2D.RowView<N extends java.lang.Comparable<N>>, Access2D.SelectionView<N extends java.lang.Comparable<N>>, Access2D.Sliceable<N extends java.lang.Comparable<N>>, Access2D.Visitable<N extends java.lang.Comparable<N>>

Nested classes/interfaces inherited from interface org.ojalgo.algebra.Group

Group.Additive<T>, Group.Multiplicative<T>

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

Mutate1D.Fillable<N extends java.lang.Comparable<N>>, Mutate1D.Mixable<N extends java.lang.Comparable<N>>, Mutate1D.Modifiable<N extends java.lang.Comparable<N>>, Mutate1D.ModifiableReceiver<N extends java.lang.Comparable<N>>, Mutate1D.Receiver<N extends java.lang.Comparable<N>>, Mutate1D.Sortable

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

Mutate2D.Exchangeable, Mutate2D.Fillable<N extends java.lang.Comparable<N>>, Mutate2D.Mixable<N extends java.lang.Comparable<N>>, Mutate2D.Modifiable<N extends java.lang.Comparable<N>>, Mutate2D.ModifiableReceiver<N extends java.lang.Comparable<N>>, Mutate2D.Receiver<N extends java.lang.Comparable<N>>

Nested classes/interfaces inherited from interface org.ojalgo.algebra.Operation

Operation.Addition<T>, Operation.Division<T>, Operation.Multiplication<T>, Operation.Subtraction<T>

Nested classes/interfaces inherited from interface org.ojalgo.matrix.store.PhysicalStore

PhysicalStore.Factory<N extends java.lang.Comparable<N>,I extends PhysicalStore<N> & Factory2D.Builder<I>>

Nested classes/interfaces inherited from interface org.ojalgo.algebra.ScalarOperation

ScalarOperation.Addition<T,N extends java.lang.Comparable<N>>, ScalarOperation.Division<T,N extends java.lang.Comparable<N>>, ScalarOperation.Multiplication<T,N extends java.lang.Comparable<N>>, ScalarOperation.Subtraction<T,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>

Nested classes/interfaces inherited from interface org.ojalgo.matrix.store.TransformableRegion

TransformableRegion.FillByMultiplying<N extends java.lang.Comparable<N>>

Field Summary

Fields inherited from interface org.ojalgo.matrix.decomposition.function.ExchangeColumns

NULL

Fields inherited from interface org.ojalgo.matrix.decomposition.function.NegateColumn

NULL

Fields inherited from interface org.ojalgo.matrix.decomposition.function.RotateRight

NULL

Method Summary

Modifier and Type	Method	Description
void	applyCholesky(int iterationPoint, BasicArray<N> multipliers)	Cholesky transformations
void	applyLDL(int iterationPoint, BasicArray<N> multipliers)	LDL transformations
void	applyLU(int iterationPoint, BasicArray<N> multipliers)	LU transformations
Array1D<ComplexNumber>	computeInPlaceSchur(PhysicalStore<N> transformationCollector, boolean eigenvalue)
void	divideAndCopyColumn(int row, int column, BasicArray<N> destination)
default void	exchangeColumns(int colA, int colB)
void	exchangeHermitian(int indexA, int indexB)
boolean	generateApplyAndCopyHouseholderColumn(int row, int column, Householder<N> destination)
boolean	generateApplyAndCopyHouseholderRow(int row, int column, Householder<N> destination)
void	setToIdentity(int aCol)
default Array1D<N>	sliceColumn(long col)
Array1D<N>	sliceColumn(long row, long col)
Array1D<N>	sliceDiagonal(long row, long col)
Array1D<N>	sliceRange(long first, long limit)
default Array1D<N>	sliceRow(long row)
Array1D<N>	sliceRow(long row, long col)
void	transformSymmetric(Householder<N> transformation)
void	tred2(BasicArray<N> mainDiagonal, BasicArray<N> offDiagonal, boolean yesvecs)

Methods inherited from interface org.ojalgo.structure.Access1D

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

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

collect

Methods inherited from interface org.ojalgo.structure.Access1D.Visitable

visitAll, visitRange

Methods inherited from interface org.ojalgo.structure.Access2D

asCollectable2D, asKeyed2D, byteValue, byteValue, byteValue, byteValue, columns, doubleValue, doubleValue, doubleValue, elements, floatValue, floatValue, floatValue, floatValue, get, intValue, intValue, intValue, intValue, longValue, longValue, longValue, longValue, nonzeros, rows, shortValue, shortValue, shortValue, shortValue, toRawCopy2D

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

aggregateColumn, aggregateDiagonal, aggregateRow, reduceColumns, reduceRows

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

collect

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

sliceDiagonal

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

visitColumn, visitColumn, visitDiagonal, visitDiagonal, visitOne, visitRow, visitRow

Methods inherited from interface java.util.function.Consumer

andThen

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

onAny, onColumns, onColumns, onMatching, onMatching, onRows, onRows

Methods inherited from interface org.ojalgo.matrix.Matrix2D

equals

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

above, above, above, add, add, add, aggregateAll, aggregateColumn, aggregateDiagonal, aggregateRange, aggregateRow, below, below, below, bidiagonal, column, column, columns, columns, conjugate, copy, diagonal, diagonally, divide, divide, doubleValue, equals, get, get, get, hermitian, hessenberg, indexOfLargest, isHermitian, isNormal, isSmall, isSmall, left, left, left, limits, logical, multiply, multiply, multiply, multiply, multiplyBoth, negate, norm, offsets, onAll, operate, physical, power, premultiply, reduceColumns, reduceRows, repeat, right, right, right, row, row, rows, rows, select, select, signum, subtract, subtract, subtract, superimpose, superimpose, supplyTo, symmetric, toScalar, transpose, triangular, tridiagonal, visitOne

Methods inherited from interface org.ojalgo.structure.Mutate1D

reset

Methods inherited from interface org.ojalgo.structure.Mutate1D.Fillable

fillAll, fillAll, fillCompatible, fillMatching, fillMatching, fillMatching, fillRange, fillRange

Methods inherited from interface org.ojalgo.structure.Mutate1D.Modifiable

modifyAll, modifyMatching, modifyMatching, modifyRange

Methods inherited from interface org.ojalgo.structure.Mutate2D

set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set

Methods inherited from interface org.ojalgo.structure.Mutate2D.Fillable

fillColumn, fillColumn, fillColumn, fillColumn, fillColumn, fillColumn, fillCompatible, fillDiagonal, fillDiagonal, fillDiagonal, fillDiagonal, fillDiagonal, fillDiagonal, fillRow, fillRow, fillRow, fillRow, fillRow, fillRow

Methods inherited from interface org.ojalgo.structure.Mutate2D.Modifiable

add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, modifyColumn, modifyColumn, modifyDiagonal, modifyDiagonal, modifyMatchingInColumns, modifyMatchingInColumns, modifyMatchingInRows, modifyMatchingInRows, modifyOne, modifyOne, modifyRow, modifyRow

Methods inherited from interface org.ojalgo.structure.Mutate2D.ModifiableReceiver

modifyCompatible, modifyCompatible

Methods inherited from interface org.ojalgo.structure.Mutate2D.Receiver

accept, isAcceptable

Methods inherited from interface org.ojalgo.matrix.decomposition.function.NegateColumn

negateColumn

Methods inherited from interface org.ojalgo.structure.Operate2D

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

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

asList, indexOfLargestInColumn, indexOfLargestInRow, indexOfLargestOnDiagonal, modifyAny, substituteBackwards, substituteForwards, supplyTo, transformLeft, transformLeft, transformRight, transformRight

Methods inherited from interface org.ojalgo.matrix.decomposition.function.RotateRight

rotateRight

Methods inherited from interface org.ojalgo.algebra.ScalarOperation.Addition

add

Methods inherited from interface org.ojalgo.algebra.ScalarOperation.Division

divide

Methods inherited from interface org.ojalgo.algebra.ScalarOperation.Multiplication

multiply

Methods inherited from interface org.ojalgo.algebra.ScalarOperation.Subtraction

subtract

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

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

exchangeColumns, exchangeRows, fillByMultiplying, regionByColumns, regionByLimits, regionByOffsets, regionByRows, regionByTransposing, synchronised

Method Detail

applyCholesky

void applyCholesky(int iterationPoint,
                   BasicArray<N> multipliers)

Cholesky transformations

applyLDL

void applyLDL(int iterationPoint,
              BasicArray<N> multipliers)

LDL transformations

applyLU

void applyLU(int iterationPoint,
             BasicArray<N> multipliers)

LU transformations

computeInPlaceSchur

Array1D<ComplexNumber> computeInPlaceSchur(PhysicalStore<N> transformationCollector,
                                           boolean eigenvalue)

divideAndCopyColumn

void divideAndCopyColumn(int row,
                         int column,
                         BasicArray<N> destination)

exchangeColumns

default void exchangeColumns(int colA,
                             int colB)

Specified by:

exchangeColumns in interface ExchangeColumns

exchangeHermitian

void exchangeHermitian(int indexA,
                       int indexB)

generateApplyAndCopyHouseholderColumn

boolean generateApplyAndCopyHouseholderColumn(int row,
                                              int column,
                                              Householder<N> destination)

generateApplyAndCopyHouseholderRow

boolean generateApplyAndCopyHouseholderRow(int row,
                                           int column,
                                           Householder<N> destination)

setToIdentity

void setToIdentity(int aCol)

sliceColumn

default Array1D<N> sliceColumn(long col)

Specified by:

sliceColumn in interface Access2D.Sliceable<N extends java.lang.Comparable<N>>

sliceColumn

Array1D<N> sliceColumn(long row,
                       long col)

Specified by:

sliceColumn in interface Access2D.Sliceable<N extends java.lang.Comparable<N>>

Specified by:

sliceColumn in interface MatrixStore<N extends java.lang.Comparable<N>>

sliceDiagonal

Array1D<N> sliceDiagonal(long row,
                         long col)

Specified by:

sliceDiagonal in interface Access2D.Sliceable<N extends java.lang.Comparable<N>>

Specified by:

sliceDiagonal in interface MatrixStore<N extends java.lang.Comparable<N>>

sliceRange

Array1D<N> sliceRange(long first,
                      long limit)

Specified by:

sliceRange in interface Access1D.Sliceable<N extends java.lang.Comparable<N>>

Specified by:

sliceRange in interface MatrixStore<N extends java.lang.Comparable<N>>

sliceRow

default Array1D<N> sliceRow(long row)

Specified by:

sliceRow in interface Access2D.Sliceable<N extends java.lang.Comparable<N>>

sliceRow

Array1D<N> sliceRow(long row,
                    long col)

Specified by:

sliceRow in interface Access2D.Sliceable<N extends java.lang.Comparable<N>>

Specified by:

sliceRow in interface MatrixStore<N extends java.lang.Comparable<N>>

transformSymmetric

void transformSymmetric(Householder<N> transformation)

tred2

void tred2(BasicArray<N> mainDiagonal,
           BasicArray<N> offDiagonal,
           boolean yesvecs)