Module ojalgo

Package org.ojalgo.matrix.store

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

java.lang.Object

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

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

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

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

All Implemented Interfaces:

Group, Group.Additive<MatrixStore<N>>, NormedVectorSpace<MatrixStore<N>,N>, Operation, Operation.Addition<MatrixStore<N>>, Operation.Multiplication<MatrixStore<N>>, Operation.Subtraction<MatrixStore<N>>, ScalarOperation, ScalarOperation.Addition<MatrixStore<N>,N>, ScalarOperation.Division<MatrixStore<N>,N>, ScalarOperation.Multiplication<MatrixStore<N>,N>, ScalarOperation.Subtraction<MatrixStore<N>,N>, VectorSpace<MatrixStore<N>,N>, Matrix2D<N,MatrixStore<N>>, ElementsSupplier<N>, MatrixStore<N>, 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>, Operate2D<N,ElementsSupplier<N>>, Structure1D, Structure2D, Structure2D.Logical<Access2D<N>,MatrixStore<N>>, Structure2D.ReducibleTo1D<ElementsSupplier<N>>

final class SuperimposedStore<N extends java.lang.Comparable<N>>
extends ComposingStore<N>

SuperimposedStore

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

Field Summary

Fields

Modifier and Type	Field	Description
private int	myColFirst
private int	myColLimit
private MatrixStore<N>	myDiff
private int	myRowFirst
private int	myRowLimit

Constructor Summary

Constructors

Constructor	Description
SuperimposedStore(MatrixStore<N> base, long row, long col, MatrixStore<N> diff)
SuperimposedStore(MatrixStore<N> base, MatrixStore<N> diff)

Method Summary

Modifier and Type	Method	Description
double	doubleValue(int row, int col)	Extracts one element of this matrix as a double.
N	get(int row, int col)
private boolean	isCovered(int row, int col)
MatrixStore<N>	multiply(double scalar)
MatrixStore<N>	multiply(N scalar)
MatrixStore<N>	multiply(MatrixStore<N> right)
void	multiply(Access1D<N> right, TransformableRegion<N> target)
N	multiplyBoth(Access1D<N> leftAndRight)	Assumes [leftAndRight] is a vector and will calulate [leftAndRight]H[this][leftAndRight]
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	supplyTo(TransformableRegion<N> consumer)
Scalar<N>	toScalar(int row, int col)	Extracts one element of this matrix as a Scalar.

Methods inherited from class org.ojalgo.matrix.store.LogicalStore

base, executeMultiply, executeMultiply, executeMultiply, executeMultiply, executeMultiplyBoth, executePremultiply, one, physical, zero

Methods inherited from class org.ojalgo.matrix.store.AbstractStore

buildColumn, buildColumn, buildColumn, buildRow, buildRow, buildRow, cast, countColumns, countRows, equals, getColDim, getComponentType, getMaxDim, getMinDim, getRowDim, hashCode, isPrimitive, limitOfColumn, limitOfRow, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ojalgo.structure.Access1D

asCollectable1D, asKeyed1D, asList, 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

sliceColumn, sliceDiagonal, sliceRow

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

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

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, equals, get, get, hermitian, hessenberg, indexOfLargest, isHermitian, isNormal, isSmall, isSmall, left, left, left, limits, logical, negate, norm, offsets, onAll, operate, power, reduceColumns, reduceRows, repeat, right, right, right, row, row, rows, rows, select, select, signum, sliceColumn, sliceDiagonal, sliceRange, sliceRow, subtract, subtract, subtract, superimpose, superimpose, supplyTo, symmetric, transpose, triangular, tridiagonal, visitOne

Methods inherited from interface org.ojalgo.structure.Operate2D

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

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, firstInColumn, firstInRow, isEmpty, isFat, isScalar, isSquare, isTall, isVector, size

Field Detail

myColFirst

private final int myColFirst

myColLimit

private final int myColLimit

myDiff

private final MatrixStore<N extends java.lang.Comparable<N>> myDiff

myRowFirst

private final int myRowFirst

myRowLimit

private final int myRowLimit

Constructor Detail

SuperimposedStore

SuperimposedStore(MatrixStore<N> base,
                  long row,
                  long col,
                  MatrixStore<N> diff)

SuperimposedStore

SuperimposedStore(MatrixStore<N> base,
                  MatrixStore<N> diff)

Method Detail

doubleValue

public double doubleValue(int row,
                          int col)

Description copied from interface: Access2D

Extracts one element of this matrix as a double.

Parameters:

row - A row index.

col - A column index.

Returns:

One matrix element

See Also:

Access2D.doubleValue(long, long)

get

public N get(int row,
             int col)

multiply

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

multiply

public MatrixStore<N> multiply(double scalar)

Returns:

this * scalarMultiplicand.

multiply

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

Parameters:

right - The multiplicand

Returns:

this * multiplicand.

multiply

public MatrixStore<N> multiply(N scalar)

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 java.lang.Comparable<N>>

Overrides:

multiplyBoth in class AbstractStore<N extends java.lang.Comparable<N>>

Parameters:

leftAndRight - The argument vector

Returns:

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

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.

Parameters:

left - The left matrix

Returns:

The matrix product

supplyTo

public void supplyTo(TransformableRegion<N> consumer)

toScalar

public Scalar<N> toScalar(int row,
                          int col)

Description copied from interface: Matrix2D

Extracts one element of this matrix as a Scalar.

Parameters:

row - A row index.

col - A column index.

Returns:

One matrix element as a Scalar.

isCovered

private boolean isCovered(int row,
                          int col)