org.ojalgo.matrix.store

Class SparseStore<N extends Number>

java.lang.Object

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

All Implemented Interfaces:

Consumer<Access2D<?>>, Supplier<MatrixStore<N>>, Group, Group.Additive<MatrixStore<N>>, NormedVectorSpace<MatrixStore<N>,N>, Operation, Operation.Addition<MatrixStore<N>>, Operation.Multiplication<MatrixStore<N>>, ScalarOperation, ScalarOperation.Multiplication<MatrixStore<N>,N>, VectorSpace<MatrixStore<N>,N>, ElementsSupplier<N>, MatrixStore<N>, TransformableRegion<N>, Access1D<N>, Access1D.Aggregatable<N>, Access1D.Elements, Access1D.Sliceable<N>, Access1D.Visitable<N>, Access2D<N>, Access2D.Aggregatable<N>, Access2D.Collectable<N,TransformableRegion<N>>, Access2D.Elements, Access2D.Sliceable<N>, Access2D.Visitable<N>, Mutate1D, Mutate1D.Fillable<N>, Mutate1D.Modifiable<N>, Mutate2D, Mutate2D.Exchangeable, Mutate2D.Fillable<N>, Mutate2D.Modifiable<N>, Mutate2D.ModifiableReceiver<N>, Mutate2D.Receiver<N>, Stream2D<N,MatrixStore<N>,TransformableRegion<N>,ElementsSupplier<N>>, Structure1D, Structure2D, Structure2D.ReducibleTo1D<ElementsSupplier<N>>

public final class SparseStore<N extends Number>
extends Object
implements TransformableRegion<N>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SparseStore.Factory<N extends Number>

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

TransformableRegion.ColumnsRegion<N extends Number>, TransformableRegion.FillByMultiplying<N extends Number>, TransformableRegion.LimitRegion<N extends Number>, TransformableRegion.OffsetRegion<N extends Number>, TransformableRegion.ReceiverRegion<N extends Number>, TransformableRegion.RowsRegion<N extends Number>, TransformableRegion.TransposedRegion<N extends Number>

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

Mutate2D.Exchangeable, Mutate2D.Fillable<N extends Number>, Mutate2D.Mixable<N extends Number>, Mutate2D.Modifiable<N extends Number>, Mutate2D.ModifiableReceiver<N extends Number>, Mutate2D.Receiver<N extends Number>

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

Mutate1D.Sortable

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

Structure2D.IntRowColumn, Structure2D.Logical<S extends Structure2D,B extends Structure2D.Logical<S,?>>, 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.structure.Structure1D

Structure1D.BasicMapper<T>, Structure1D.IndexCallback, Structure1D.IndexMapper<T>, Structure1D.IntIndex, Structure1D.LongIndex, Structure1D.LoopCallback

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

Access2D.Aggregatable<N extends Number>, Access2D.Collectable<N extends Number,R extends Mutate2D.Receiver<N>>, Access2D.Elements, Access2D.ElementView<N extends Number>, Access2D.IndexOf, Access2D.Sliceable<N extends Number>, Access2D.Visitable<N extends Number>

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

MatrixStore.LogicalBuilder<N extends Number>

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

Group.Additive<S>, Group.Multiplicative<S>

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.algebra.ScalarOperation

ScalarOperation.Addition<T,N extends Number>, ScalarOperation.Division<T,N extends Number>, ScalarOperation.Multiplication<T,N extends Number>, ScalarOperation.Subtraction<T,N extends Number>

Field Summary

Fields

Modifier and Type	Field and Description
static SparseStore.Factory<ComplexNumber>	COMPLEX
static SparseStore.Factory<Double>	PRIMITIVE
static SparseStore.Factory<Quaternion>	QUATERNION
static SparseStore.Factory<RationalNumber>	RATIONAL

Method Summary

Modifier and Type	Method and Description
void	add(long row, long col, double addend)
void	add(long row, long col, Number addend)
long	countColumns()
long	countRows()
double	doubleValue(long row, long col) Extracts one element of this matrix as a double.
boolean	equals(Object someObj)
void	fillByMultiplying(Access1D<N> left, Access1D<N> right)
void	fillOne(long row, long col, Access1D<?> values, long valueIndex)
void	fillOne(long row, long col, N value)
void	fillOne(long row, long col, NullaryFunction<N> supplier)
int	firstInColumn(int col) The default value is simply 0, and if all elements are zeros then this.countRows().
int	firstInRow(int row) The default value is simply 0, and if all elements are zeros then this.countColumns().
MatrixStore<N>	get()
N	get(long row, long col)
protected int	getColDim()
protected int	getMaxDim()
protected int	getMinDim()
protected int	getRowDim()
int	hashCode()
protected boolean	isPrimitive()
int	limitOfColumn(int col) The default value is simply this.countRows(), and if all elements are zeros then 0.
int	limitOfRow(int row) The default value is simply this.countColumns(), and if all elements are zeros then 0.
static SparseStore<ComplexNumber>	makeComplex(int rowsCount, int columnsCount)
static SparseStore<Double>	makePrimitive(int rowsCount, int columnsCount)
static SparseStore<Quaternion>	makeQuaternion(int rowsCount, int columnsCount)
static SparseStore<RationalNumber>	makeRational(int rowsCount, int columnsCount)
void	modifyAll(UnaryFunction<N> modifier)
void	modifyMatching(Access1D<N> left, BinaryFunction<N> function)
void	modifyMatching(BinaryFunction<N> function, Access1D<N> right)
void	modifyOne(long row, long col, UnaryFunction<N> modifier)
void	multiply(Access1D<N> right, TransformableRegion<N> target)
MatrixStore<N>	multiply(double scalar)
MatrixStore<N>	multiply(MatrixStore<N> right)
MatrixStore<N>	multiply(N scalar)
N	multiplyBoth(Access1D<N> leftAndRight) Assumes [leftAndRight] is a vector and will calulate [leftAndRight]H[this][leftAndRight]
ElementView2D<N,?>	nonzeros()
PhysicalStore.Factory<N,?>	physical()
ElementsSupplier<N>	premultiply(Access1D<N> left) The premultiply method differs from multiply in 3 ways: The matrix positions are swapped - left/right. It does NOT return a MatrixStore but an ElementsSupplier instead. It accepts an Access1D as the argument left matrix.
void	reduceColumns(Aggregator aggregator, Mutate1D receiver)
void	reduceRows(Aggregator aggregator, Mutate1D receiver)
TransformableRegion<N>	regionByColumns(int... columns)
TransformableRegion<N>	regionByLimits(int rowLimit, int columnLimit)
TransformableRegion<N>	regionByOffsets(int rowOffset, int columnOffset)
TransformableRegion<N>	regionByRows(int... rows)
TransformableRegion<N>	regionByTransposing()
void	reset() Reset this mutable structure to some standard (all zeros) initial state.
void	set(long row, long col, double value)
void	set(long row, long col, Number value)
void	supplyTo(TransformableRegion<N> receiver)
String	toString()
void	visitColumn(long row, long col, VoidFunction<N> visitor)
void	visitRow(long row, long col, VoidFunction<N> visitor)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

exchangeColumns, exchangeRows, modifyAny

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

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

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

modifyRange

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

accept, isAcceptable

Methods inherited from interface org.ojalgo.structure.Mutate2D

add, add, set, set

Methods inherited from interface org.ojalgo.structure.Mutate1D

copyComplexArgument, copyComplexImaginary, copyComplexModulus, copyComplexModulusAndArgument, copyComplexReal, copyComplexRealAndImaginary

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

fillColumn, fillColumn, fillColumn, fillColumn, fillColumn, fillColumn, fillDiagonal, fillDiagonal, fillDiagonal, fillDiagonal, fillDiagonal, fillDiagonal, fillOne, fillOne, fillOne, fillRow, fillRow, fillRow, fillRow, fillRow, fillRow

Methods inherited from interface org.ojalgo.structure.Structure2D

column, column, column, column, column, count, 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.structure.Mutate1D.Fillable

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

Methods inherited from interface org.ojalgo.structure.Structure1D

index, loopAll, loopMatching, loopRange, mapper, size

Methods inherited from interface java.util.function.Consumer

andThen

Methods inherited from interface org.ojalgo.structure.Access2D

asCollectable2D, asPrimitive2D, byteValue, byteValue, columns, doubleValue, elements, equals, floatValue, floatValue, get, intValue, intValue, longValue, longValue, newPrimitiveColumnCollectable, newPrimitiveRowCollectable, rows, shortValue, shortValue, toRawCopy2D, toString, wrap, wrap

Methods inherited from interface org.ojalgo.structure.Access1D

asCollectable1D, asPrimitive1D, axpy, dot, equals, hashCode, supplyTo, toRawCopy1D, toString, wrap, wrap, wrap

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

add, aggregateAll, aggregateColumn, aggregateDiagonal, aggregateRange, aggregateRow, conjugate, copy, equals, firstInColumn, firstInColumn, firstInRow, firstInRow, isAbsolute, isHermitian, isNormal, isSmall, isSmall, limitOfColumn, limitOfColumn, limitOfRow, limitOfRow, logical, negate, norm, operateOnAll, reduceColumns, reduceRows, signum, sliceColumn, sliceDiagonal, sliceRange, sliceRow, subtract, toScalar, transpose, visitOne

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

operateOnAny, operateOnColumns, operateOnMatching, operateOnMatching, operateOnRows

Methods inherited from interface org.ojalgo.structure.Stream2D

operateOnAll, operateOnAll, operateOnAll, operateOnAll, operateOnAll

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

collect

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

visitColumn, visitDiagonal, visitDiagonal, visitOne, visitRow

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

visitAll, visitRange

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

aggregateColumn, aggregateDiagonal, aggregateRow

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

sliceColumn, sliceDiagonal, sliceRow

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

isAbsolute, isColumnSmall, isColumnSmall, isRowSmall, isRowSmall, isSmall

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

isAllSmall

Field Detail

COMPLEX

public static final SparseStore.Factory<ComplexNumber> COMPLEX

PRIMITIVE

public static final SparseStore.Factory<Double> PRIMITIVE

QUATERNION

public static final SparseStore.Factory<Quaternion> QUATERNION

RATIONAL

public static final SparseStore.Factory<RationalNumber> RATIONAL

Method Detail

makeComplex

public static SparseStore<ComplexNumber> makeComplex(int rowsCount,
                                                     int columnsCount)

makePrimitive

public static SparseStore<Double> makePrimitive(int rowsCount,
                                                int columnsCount)

makeQuaternion

public static SparseStore<Quaternion> makeQuaternion(int rowsCount,
                                                     int columnsCount)

makeRational

public static SparseStore<RationalNumber> makeRational(int rowsCount,
                                                       int columnsCount)

add

public void add(long row,
                long col,
                double addend)

Specified by:

add in interface Mutate2D

add

public void add(long row,
                long col,
                Number addend)

Specified by:

add in interface Mutate2D

doubleValue

public double doubleValue(long row,
                          long col)

Description copied from interface: Access2D

Extracts one element of this matrix as a double.

Specified by:

doubleValue in interface MatrixStore<N extends Number>

Specified by:

doubleValue in interface Access2D<N extends Number>

Parameters:

row - A row index.

col - A column index.

Returns:

One matrix element

fillByMultiplying

public void fillByMultiplying(Access1D<N> left,
                              Access1D<N> right)

Specified by:

fillByMultiplying in interface TransformableRegion<N extends Number>

fillOne

public void fillOne(long row,
                    long col,
                    Access1D<?> values,
                    long valueIndex)

Specified by:

fillOne in interface Mutate2D.Fillable<N extends Number>

fillOne

public void fillOne(long row,
                    long col,
                    N value)

Specified by:

fillOne in interface Mutate2D.Fillable<N extends Number>

fillOne

public void fillOne(long row,
                    long col,
                    NullaryFunction<N> supplier)

Specified by:

fillOne in interface Mutate2D.Fillable<N extends Number>

firstInColumn

public int firstInColumn(int col)

Description copied from interface: MatrixStore

The default value is simply 0, and if all elements are zeros then this.countRows().

Specified by:

firstInColumn in interface MatrixStore<N extends Number>

Parameters:

col - The column index

Returns:

The row index of the first non-zero element in the specified column

firstInRow

public int firstInRow(int row)

Description copied from interface: MatrixStore

The default value is simply 0, and if all elements are zeros then this.countColumns().

Specified by:

firstInRow in interface MatrixStore<N extends Number>

Returns:

The column index of the first non-zero element in the specified row

get

public N get(long row,
             long col)

Specified by:

get in interface Access2D<N extends Number>

limitOfColumn

public int limitOfColumn(int col)

Description copied from interface: MatrixStore

The default value is simply this.countRows(), and if all elements are zeros then 0.

Specified by:

limitOfColumn in interface MatrixStore<N extends Number>

Returns:

The row index of the first zero element, after all non-zeros, in the specified column (index of the last non-zero + 1)

limitOfRow

public int limitOfRow(int row)

Description copied from interface: MatrixStore

The default value is simply this.countColumns(), and if all elements are zeros then 0.

Specified by:

limitOfRow in interface MatrixStore<N extends Number>

Returns:

The column index of the first zero element, after all non-zeros, in the specified row (index of the last non-zero + 1)

modifyAll

public void modifyAll(UnaryFunction<N> modifier)

Specified by:

modifyAll in interface Mutate1D.Modifiable<N extends Number>

modifyMatching

public void modifyMatching(Access1D<N> left,
                           BinaryFunction<N> function)

Specified by:

modifyMatching in interface Mutate1D.Modifiable<N extends Number>

modifyMatching

public void modifyMatching(BinaryFunction<N> function,
                           Access1D<N> right)

Specified by:

modifyMatching in interface Mutate1D.Modifiable<N extends Number>

modifyOne

public void modifyOne(long row,
                      long col,
                      UnaryFunction<N> modifier)

Specified by:

modifyOne in interface Mutate2D.Modifiable<N extends Number>

multiply

public void multiply(Access1D<N> right,
                     TransformableRegion<N> target)

Specified by:

multiply in interface MatrixStore<N extends Number>

multiply

public MatrixStore<N> multiply(double scalar)

Specified by:

multiply in interface ScalarOperation.Multiplication<MatrixStore<N extends Number>,N extends Number>

Specified by:

multiply in interface MatrixStore<N extends Number>

Returns:

this * scalarMultiplicand.

multiply

public MatrixStore<N> multiply(MatrixStore<N> right)

Specified by:

multiply in interface Operation.Multiplication<MatrixStore<N extends Number>>

Specified by:

multiply in interface MatrixStore<N extends Number>

Parameters:

right - The multiplicand

Returns:

this * multiplicand.

multiply

public MatrixStore<N> multiply(N scalar)

Specified by:

multiply in interface ScalarOperation.Multiplication<MatrixStore<N extends Number>,N extends Number>

Specified by:

multiply in interface MatrixStore<N extends Number>

Returns:

this * multiplicand.

multiplyBoth

public N multiplyBoth(Access1D<N> leftAndRight)

Description copied from interface: MatrixStore

Assumes [leftAndRight] is a vector and will calulate [leftAndRight]^H[this][leftAndRight]

Specified by:

multiplyBoth in interface MatrixStore<N extends Number>

Parameters:

leftAndRight - The argument vector

Returns:

A scalar (extracted from the resulting 1 x 1 matrix)

nonzeros

public ElementView2D<N,?> nonzeros()

Specified by:

nonzeros in interface Access1D<N extends Number>

premultiply

public ElementsSupplier<N> premultiply(Access1D<N> left)

Description copied from interface: MatrixStore

The premultiply method differs from multiply in 3 ways:

1. The matrix positions are swapped - left/right.
2. It does NOT return a MatrixStore but an ElementsSupplier instead.
3. It accepts an Access1D as the argument left matrix.

Specified by:

premultiply in interface MatrixStore<N extends Number>

Parameters:

left - The left matrix

Returns:

The matrix product

reduceColumns

public void reduceColumns(Aggregator aggregator,
                          Mutate1D receiver)

Specified by:

reduceColumns in interface Access2D.Aggregatable<N extends Number>

reduceRows

public void reduceRows(Aggregator aggregator,
                       Mutate1D receiver)

Specified by:

reduceRows in interface Access2D.Aggregatable<N extends Number>

regionByColumns

public TransformableRegion<N> regionByColumns(int... columns)

Specified by:

regionByColumns in interface TransformableRegion<N extends Number>

Returns:

A consumer (sub)region

regionByLimits

public TransformableRegion<N> regionByLimits(int rowLimit,
                                             int columnLimit)

Specified by:

regionByLimits in interface TransformableRegion<N extends Number>

Returns:

A consumer (sub)region

regionByOffsets

public TransformableRegion<N> regionByOffsets(int rowOffset,
                                              int columnOffset)

Specified by:

regionByOffsets in interface TransformableRegion<N extends Number>

Returns:

A consumer (sub)region

regionByRows

public TransformableRegion<N> regionByRows(int... rows)

Specified by:

regionByRows in interface TransformableRegion<N extends Number>

Returns:

A consumer (sub)region

regionByTransposing

public TransformableRegion<N> regionByTransposing()

Specified by:

regionByTransposing in interface TransformableRegion<N extends Number>

Returns:

A transposed consumer region

reset

public void reset()

Description copied from interface: Mutate1D

Reset this mutable structure to some standard (all zeros) initial state. It must still be usuable after this call, and the structure/size/shape must not change.

Specified by:

reset in interface Mutate1D

set

public void set(long row,
                long col,
                double value)

Specified by:

set in interface Mutate2D

set

public void set(long row,
                long col,
                Number value)

Specified by:

set in interface Mutate2D

supplyTo

public void supplyTo(TransformableRegion<N> receiver)

Specified by:

supplyTo in interface MatrixStore<N extends Number>

Specified by:

supplyTo in interface Access2D.Collectable<N extends Number,TransformableRegion<N extends Number>>

visitColumn

public void visitColumn(long row,
                        long col,
                        VoidFunction<N> visitor)

Specified by:

visitColumn in interface Access2D.Visitable<N extends Number>

visitRow

public void visitRow(long row,
                     long col,
                     VoidFunction<N> visitor)

Specified by:

visitRow in interface Access2D.Visitable<N extends Number>

physical

public final PhysicalStore.Factory<N,?> physical()

countColumns

public long countColumns()

Specified by:

countColumns in interface Structure2D

Returns:

The number of columns

countRows

public long countRows()

Specified by:

countRows in interface Structure2D

Returns:

The number of rows

equals

public final boolean equals(Object someObj)

Overrides:

equals in class Object

get

public final MatrixStore<N> get()

Specified by:

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

Specified by:

get in interface ElementsSupplier<N extends Number>

Specified by:

get in interface MatrixStore<N extends Number>

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

toString

public final String toString()

Overrides:

toString in class Object

getColDim

protected final int getColDim()

getMaxDim

protected final int getMaxDim()

getMinDim

protected final int getMinDim()

getRowDim

protected final int getRowDim()

isPrimitive

protected final boolean isPrimitive()