org.ojalgo.matrix.store

Class IdentityStore<N extends java.lang.Number>

java.lang.Object

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<N>, Access1D<N>, Access1D.Elements, Access1D.Visitable<N>, Access2D<N>, Access2D.Elements, Access2D.Visitable<N>, MatrixStore<N>

public final class IdentityStore<N extends java.lang.Number>
extends java.lang.Object

IdentityStore

Author:

apete

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	IdentityStore.Factory<N extends java.lang.Number>

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

MatrixStore.Builder<N extends java.lang.Number>, MatrixStore.ElementsConsumer<N extends java.lang.Number>, MatrixStore.ElementsSupplier<N extends java.lang.Number>

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

Access2D.Elements, Access2D.Fillable<N extends java.lang.Number>, Access2D.Iterable2D<N extends java.lang.Number>, Access2D.Modifiable<N extends java.lang.Number>, Access2D.Visitable<N extends java.lang.Number>

Field Summary

Fields

Modifier and Type	Field and Description
static IdentityStore.Factory<java.math.BigDecimal>	BIG
static IdentityStore.Factory<ComplexNumber>	COMPLEX
static IdentityStore.Factory<java.lang.Double>	PRIMITIVE

Constructor Summary

Constructors

Constructor and Description
IdentityStore(PhysicalStore.Factory<N,?> aFactory, int dimension)

Method Summary

Modifier and Type	Method and Description
MatrixStore<N>	add(MatrixStore<N> addend)
N	aggregateAll(Aggregator aggregator)
MatrixStore.Builder<N>	builder()
PhysicalStore<N>	conjugate() Each call must produce a new instance.
PhysicalStore<N>	copy() Each call must produce a new instance.
long	count()
long	countColumns()
long	countRows()
double	doubleValue(long index)
double	doubleValue(long aRow, long aCol) Extracts one element of this matrix as a double.
boolean	equals(MatrixStore<N> other, NumberContext context)
boolean	equals(java.lang.Object someObj)
PhysicalStore.Factory<N,?>	factory()
N	get(long index)
N	get(long aRow, long aCol)
int	hashCode()
boolean	isAbsolute(long index)
boolean	isAbsolute(long row, long column)
boolean	isLowerLeftShaded() The entries below (left of) the first subdiagonal are zero - effectively an upper Hessenberg matrix.
boolean	isSmall(long index, double comparedTo)
boolean	isSmall(long row, long column, double comparedTo)
boolean	isUpperRightShaded() The entries above (right of) the first superdiagonal are zero - effectively a lower Hessenberg matrix.
static IdentityStore<java.math.BigDecimal>	makeBig(int dimension)
static IdentityStore<ComplexNumber>	makeComplex(int dimension)
static IdentityStore<java.lang.Double>	makePrimitive(int dimension)
MatrixStore<N>	multiply(Access1D<N> right)
MatrixStore<N>	multiplyLeft(Access1D<N> leftMtrx)
MatrixStore<N>	negate()
MatrixStore<N>	scale(N scalar)
MatrixStore<N>	subtract(MatrixStore<N> subtrahend)
Scalar<N>	toScalar(long row, long column)
java.lang.String	toString()
PhysicalStore<N>	transpose() Each call must produce a new instance.
void	visitAll(VoidFunction<N> visitor)
void	visitColumn(long row, long column, VoidFunction<N> visitor)
void	visitDiagonal(long row, long column, VoidFunction<N> visitor)
void	visitRange(long first, long limit, VoidFunction<N> visitor)
void	visitRow(long row, long column, VoidFunction<N> visitor)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

multiply, multiplyRight

Methods inherited from interface org.ojalgo.access.Access1D

iterator, stream

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

isZero

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

isZero

Field Detail

BIG

public static final IdentityStore.Factory<java.math.BigDecimal> BIG

COMPLEX

public static final IdentityStore.Factory<ComplexNumber> COMPLEX

PRIMITIVE

public static final IdentityStore.Factory<java.lang.Double> PRIMITIVE

Constructor Detail

IdentityStore

public IdentityStore(PhysicalStore.Factory<N,?> aFactory,
                     int dimension)

Method Detail

makeBig

public static IdentityStore<java.math.BigDecimal> makeBig(int dimension)

makeComplex

public static IdentityStore<ComplexNumber> makeComplex(int dimension)

makePrimitive

public static IdentityStore<java.lang.Double> makePrimitive(int dimension)

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 java.lang.Number>

Returns:

A new conjugated instance.

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 java.lang.Number>

Returns:

A new PhysicalStore copy.

doubleValue

public double doubleValue(long aRow,
                          long aCol)

Description copied from interface: Access2D

Extracts one element of this matrix as a double.

Parameters:

aRow - A row index.

aCol - A column index.

Returns:

One matrix element

get

public N get(long aRow,
             long aCol)

isLowerLeftShaded

public boolean isLowerLeftShaded()

Description copied from interface: MatrixStore

The entries below (left of) the first subdiagonal are zero - effectively an upper Hessenberg matrix.

See Also:

MatrixStore.isUpperRightShaded()

isUpperRightShaded

public boolean isUpperRightShaded()

Description copied from interface: MatrixStore

The entries above (right of) the first superdiagonal are zero - effectively a lower Hessenberg matrix.

See Also:

MatrixStore.isLowerLeftShaded()

multiplyLeft

public MatrixStore<N> multiplyLeft(Access1D<N> leftMtrx)

Specified by:

multiplyLeft in interface MatrixStore<N extends java.lang.Number>

multiply

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

toScalar

public Scalar<N> toScalar(long row,
                          long column)

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 java.lang.Number>

Returns:

A new transposed instance.

factory

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

add

public MatrixStore<N> add(MatrixStore<N> addend)

Specified by:

add in interface MatrixStore<N extends java.lang.Number>

aggregateAll

public N aggregateAll(Aggregator aggregator)

Specified by:

aggregateAll in interface MatrixStore<N extends java.lang.Number>

builder

public final MatrixStore.Builder<N> builder()

Specified by:

builder in interface MatrixStore<N extends java.lang.Number>

count

public long count()

Returns:

The total number of elements in this structure.

countColumns

public long countColumns()

Returns:

The number of columns

countRows

public long countRows()

Returns:

The number of rows

doubleValue

public double doubleValue(long index)

Specified by:

doubleValue in interface Access1D<N extends java.lang.Number>

equals

public final boolean equals(MatrixStore<N> other,
                            NumberContext context)

Specified by:

equals in interface MatrixStore<N extends java.lang.Number>

equals

public final boolean equals(java.lang.Object someObj)

Overrides:

equals in class java.lang.Object

get

public N get(long index)

Specified by:

get in interface Access1D<N extends java.lang.Number>

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

isAbsolute

public boolean isAbsolute(long index)

Specified by:

isAbsolute in interface Access1D.Elements

See Also:

Scalar.isAbsolute()

isAbsolute

public boolean isAbsolute(long row,
                          long column)

Specified by:

isAbsolute in interface Access2D.Elements

See Also:

Scalar.isAbsolute()

isSmall

public boolean isSmall(long index,
                       double comparedTo)

Specified by:

isSmall in interface Access1D.Elements

See Also:

Access1D.Elements.isSmall(long, double)

isSmall

public boolean isSmall(long row,
                       long column,
                       double comparedTo)

Specified by:

isSmall in interface Access2D.Elements

See Also:

Access2D.Elements.isSmall(long, long, double)

negate

public final MatrixStore<N> negate()

Specified by:

negate in interface MatrixStore<N extends java.lang.Number>

scale

public MatrixStore<N> scale(N scalar)

Specified by:

scale in interface MatrixStore<N extends java.lang.Number>

subtract

public MatrixStore<N> subtract(MatrixStore<N> subtrahend)

Specified by:

subtract in interface MatrixStore<N extends java.lang.Number>

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

visitAll

public void visitAll(VoidFunction<N> visitor)

Specified by:

visitAll in interface Access1D.Visitable<N extends java.lang.Number>

visitColumn

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

Specified by:

visitColumn in interface Access2D.Visitable<N extends java.lang.Number>

visitDiagonal

public void visitDiagonal(long row,
                          long column,
                          VoidFunction<N> visitor)

Specified by:

visitDiagonal in interface Access2D.Visitable<N extends java.lang.Number>

visitRange

public void visitRange(long first,
                       long limit,
                       VoidFunction<N> visitor)

Specified by:

visitRange in interface Access1D.Visitable<N extends java.lang.Number>

visitRow

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

Specified by:

visitRow in interface Access2D.Visitable<N extends java.lang.Number>