org.ojalgo.matrix.store
Class SingleElementStore<N extends Number>

java.lang.Object
  org.ojalgo.matrix.store.SingleElementStore<N>

All Implemented Interfaces:

Serializable, MatrixStore<N>

public final class SingleElementStore<N extends Number>
extends Object

See Also:

Serialized Form

Constructor Summary

SingleElementStore(PhysicalStore.Factory<N> aFactory, N anElement)

Method Summary

PhysicalStore<N>	conjugate() Each call must produce a new instance.
PhysicalStore<N>	copy() Each call must produce a new instance.
double	doubleValue(int aRow, int aCol)
boolean	equals(MatrixStore<N> aStore, NumberContext aCntxt)
boolean	equals(Object someObj)
int	getColDim()
PhysicalStore.Factory<N>	getFactory()
int	getMinDim()
N	getNumber(int aRow, int aCol)
int	getRowDim()
int	hashCode()
boolean	isAbsolute(int aRow, int aCol)
boolean	isLowerLeftShaded() The lower (left) triangle is shaded leaving an upper Hessenberg matrix.
boolean	isReal(int aRow, int aCol)
boolean	isShaded() Either the lower (left) or the upper (right) triangles are shaded.
boolean	isUpperRightShaded() The upper (right) triangle is shaded leaving a lower Hessenberg matrix.
boolean	isZero(int aRow, int aCol)
static SingleElementStore<BigDecimal>	makeBig(BigDecimal aSingleElement)
static SingleElementStore<ComplexNumber>	makeComplex(ComplexNumber aSingleElement)
static SingleElementStore<Double>	makePrimitive(double aSingleElement)
MatrixStore<N>	multiplyLeft(MatrixStore<N> aStore)
MatrixStore<N>	multiplyRight(MatrixStore<N> aStore)
int	size()
Scalar<N>	toScalar(int aRow, int aCol)
PhysicalStore<N>	transpose() Each call must produce a new instance.
void	visitAll(AggregatorFunction<N> aVisitor)
void	visitColumn(int aRow, int aCol, AggregatorFunction<N> aVisitor)
void	visitDiagonal(int aRow, int aCol, AggregatorFunction<N> aVisitor)
void	visitRow(int aRow, int aCol, AggregatorFunction<N> aVisitor)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SingleElementStore

public SingleElementStore(PhysicalStore.Factory<N> aFactory,
                          N anElement)

Method Detail

makeBig

public static SingleElementStore<BigDecimal> makeBig(BigDecimal aSingleElement)

makeComplex

public static SingleElementStore<ComplexNumber> makeComplex(ComplexNumber aSingleElement)

makePrimitive

public static SingleElementStore<Double> makePrimitive(double aSingleElement)

conjugate

public PhysicalStore<N> conjugate()

Description copied from interface: MatrixStore

Each call must produce a new instance.

Specified by:

conjugate in interface MatrixStore<N extends Number>

Returns:

A new conjugated PhysicalStore copy.

copy

public PhysicalStore<N> copy()

Description copied from interface: MatrixStore

Each call must produce a new instance.

Specified by:

copy in interface MatrixStore<N extends Number>

Returns:

A new PhysicalStore copy.

doubleValue

public double doubleValue(int aRow,
                          int aCol)

getColDim

public int getColDim()

getNumber

public N getNumber(int aRow,
                   int aCol)

getRowDim

public int getRowDim()

isLowerLeftShaded

public boolean isLowerLeftShaded()

Description copied from interface: MatrixStore

The lower (left) triangle is shaded leaving an upper Hessenberg matrix.

See Also:

MatrixStore.isUpperRightShaded(), MatrixStore.isShaded(), PhysicalStore.shadeLowerLeft(), PhysicalStore.unshade()

isUpperRightShaded

public boolean isUpperRightShaded()

Description copied from interface: MatrixStore

The upper (right) triangle is shaded leaving a lower Hessenberg matrix.

See Also:

MatrixStore.isLowerLeftShaded(), MatrixStore.isShaded(), PhysicalStore.shadeUpperRight(), PhysicalStore.unshade()

multiplyLeft

public MatrixStore<N> multiplyLeft(MatrixStore<N> aStore)

multiplyRight

public MatrixStore<N> multiplyRight(MatrixStore<N> aStore)

toScalar

public Scalar<N> toScalar(int aRow,
                          int aCol)

transpose

public PhysicalStore<N> transpose()

Description copied from interface: MatrixStore

Each call must produce a new instance.

Specified by:

transpose in interface MatrixStore<N extends Number>

Returns:

A new transposed PhysicalStore copy.

getFactory

public final PhysicalStore.Factory<N> getFactory()

equals

public final boolean equals(MatrixStore<N> aStore,
                            NumberContext aCntxt)

Specified by:

equals in interface MatrixStore<N extends Number>

equals

public final boolean equals(Object someObj)

Overrides:

equals in class Object

getMinDim

public int getMinDim()

Specified by:

getMinDim in interface MatrixStore<N extends Number>

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

isAbsolute

public boolean isAbsolute(int aRow,
                          int aCol)

Specified by:

isAbsolute in interface MatrixStore<N extends Number>

isReal

public boolean isReal(int aRow,
                      int aCol)

Specified by:

isReal in interface MatrixStore<N extends Number>

isShaded

public boolean isShaded()

Description copied from interface: MatrixStore

Either the lower (left) or the upper (right) triangles are shaded.

Shading part of a MatrixStore causes that part to be ignored (as if it had zero valued elements) when doing matrix multiplication. It is possible to shade part of a PhysicalStore even though the shaded elements are not actually zero valued. Calling doubleValue(i, j), getNumber(i, j) or toScalar(i, j) will return the actual stored value.

Specified by:

isShaded in interface MatrixStore<N extends Number>

See Also:

MatrixStore.isLowerLeftShaded(), MatrixStore.isUpperRightShaded(), PhysicalStore.unshade()

isZero

public boolean isZero(int aRow,
                      int aCol)

Specified by:

isZero in interface MatrixStore<N extends Number>

size

public int size()

Specified by:

size in interface MatrixStore<N extends Number>

visitAll

public void visitAll(AggregatorFunction<N> aVisitor)

Specified by:

visitAll in interface MatrixStore<N extends Number>

visitColumn

public void visitColumn(int aRow,
                        int aCol,
                        AggregatorFunction<N> aVisitor)

Specified by:

visitColumn in interface MatrixStore<N extends Number>

visitDiagonal

public void visitDiagonal(int aRow,
                          int aCol,
                          AggregatorFunction<N> aVisitor)

Specified by:

visitDiagonal in interface MatrixStore<N extends Number>

visitRow

public void visitRow(int aRow,
                     int aCol,
                     AggregatorFunction<N> aVisitor)

Specified by:

visitRow in interface MatrixStore<N extends Number>