|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.ojalgo.matrix.PrimitiveMatrix
public final class PrimitiveMatrix
PrimitiveMatrix
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from interface org.ojalgo.matrix.BasicMatrix |
|---|
BasicMatrix.Factory |
| Field Summary | |
|---|---|
static MatrixFactory<Double> |
FACTORY
|
| Constructor Summary | |
|---|---|
PrimitiveMatrix(MatrixStore<Double> aStore)
|
|
| Method Summary | |
|---|---|
BasicMatrix |
add(BasicMatrix aMtrx)
Adds the elements of aMtrx to the elements of this matrix. |
BasicMatrix |
add(Number aNmbr)
Adds aNmbr to the elements of this. |
BasicMatrix |
conjugate()
For real matrices conjugate() and transpose() are identical. |
BasicMatrix |
divide(Number aNmbr)
Divides the elements of this with aNmbr. |
BasicMatrix |
divideElements(BasicMatrix aMtrx)
Divides the elements of this with the elements of aMtrx. |
double |
doubleValue(int i,
int j)
Extracts one element of this matrix as a double. |
BasicMatrix |
enforce(NumberContext aContext)
|
boolean |
equals(BasicMatrix aMtrx,
NumberContext aCntxt)
|
boolean |
equals(Object obj)
|
void |
flushCache()
BasicMatrix instances are intended to be immutable. |
N |
get(int aRow,
int aColumn)
|
int |
getColDim()
|
BasicMatrix |
getColumns(int[] someCols)
|
Scalar<N> |
getCondition()
|
Scalar<N> |
getDeterminant()
|
List<ComplexNumber> |
getEigenvalues()
|
Scalar<N> |
getFrobeniusNorm()
The Frobenius norm is the square root of the sum of the squares of each element, or the square root of the sum of the square of the singular values. |
Scalar<?> |
getInfinityNorm()
|
Scalar<N> |
getKyFanNorm(int k)
|
int |
getMinDim()
|
N |
getNumber(int aRow,
int aColumn)
Deprecated. v29 Use get(int,int) instead |
Scalar<?> |
getOneNorm()
|
Scalar<N> |
getOperatorNorm()
2-norm, max singular value |
int |
getRank()
The rank of a matrix is the (maximum) number of linearly independent rows or columns it contains. |
int |
getRowDim()
|
BasicMatrix |
getRows(int[] someRows)
|
List<Double> |
getSingularValues()
|
Scalar<N> |
getTrace()
The sum of the diagonal elements. |
Scalar<N> |
getTraceNorm()
|
Scalar<N> |
getVectorInfinityNorm()
The largest, absolute, element value. |
Scalar<N> |
getVectorNorm(int aDegree)
Treats [this] as if it is one dimensional (a vector) and calculates the vector norm. |
Scalar<N> |
getVectorZeroNorm()
|
int |
hashCode()
|
BasicMatrix |
invert()
About inverting matrices: |
boolean |
isEmpty()
Matrices are either square, tall, fat or empty. |
boolean |
isFat()
Matrices are either square, tall, fat or empty. |
boolean |
isFullRank()
|
boolean |
isHermitian()
|
boolean |
isScalar()
|
boolean |
isSquare()
Matrices are either square, tall, fat or empty. |
boolean |
isSymmetric()
|
boolean |
isTall()
Matrices are either square, tall, fat or empty. |
boolean |
isVector()
|
BasicMatrix |
mergeColumns(BasicMatrix aMtrx)
[aMtrx] is appended to the bottom of [this]. |
BasicMatrix |
mergeRows(BasicMatrix aMtrx)
[aMtrx] is appended to the right side of [this]. |
BasicMatrix |
multiply(Number aNmbr)
Multiplies the elements of this matrix with aNmbr. |
BasicMatrix |
multiplyElements(BasicMatrix aMtrx)
Multiplies the elements of this matrix with the elements of aMtrx. |
BasicMatrix |
multiplyLeft(BasicMatrix aMtrx)
Matrix multiplication: [aMtrx][this] The column dimension of the left matrix must equal the row dimension of the right matrix. |
BasicMatrix |
multiplyRight(BasicMatrix aMtrx)
Matrix multiplication: [this][aMtrx] The column dimension of the left matrix must equal the row dimension of the right matrix. |
Scalar<N> |
multiplyVectors(BasicMatrix aVctr)
Assumes that both [this] and [aVctr] have row or column dimension, doesn't matter which, equal to 1. |
BasicMatrix |
negate()
|
BasicMatrix |
round(NumberContext aContext)
|
BasicMatrix |
set(int aRow,
int aCol,
Number aNmbr)
Do not use this method to populate large dense matrices! Only use it to change a few (a small number) of elements. |
int |
size()
|
BasicMatrix |
solve(BasicMatrix aRHS)
This method solves a system of linear equations: [this][X]=[aRHS]. |
BasicMatrix |
subtract(BasicMatrix aMtrx)
Subtracts the elements of aMtrx from the elements of this matrix. |
BasicMatrix |
subtract(Number aNmbr)
Subtracts aNmbr from the elements of this matrix. |
BigDecimal |
toBigDecimal(int aRow,
int aCol)
Extracts one element of this matrix as a BigDecimal. |
PhysicalStore<BigDecimal> |
toBigStore()
Must be a copy that is safe to modify. |
ComplexNumber |
toComplexNumber(int aRow,
int aCol)
Extracts one element of this matrix as a ComplexNumber. |
PhysicalStore<ComplexNumber> |
toComplexStore()
Must be a copy that is safe to modify. |
List<BasicMatrix> |
toListOfColumns()
|
List<N> |
toListOfElements()
It is also possible to call BasicMatrix.toBigStore(), BasicMatrix.toComplexStore() or BasicMatrix.toPrimitiveStore() and then PhysicalStore.asList(). |
List<BasicMatrix> |
toListOfRows()
|
PhysicalStore<Double> |
toPrimitiveStore()
Must be a copy that is safe to modify. |
Scalar<N> |
toScalar(int aRow,
int aCol)
Extracts one element of this matrix as a Scalar. |
String |
toString()
|
String |
toString(int aRow,
int aCol)
|
BasicMatrix |
transpose()
Transposes this matrix. |
| Methods inherited from class java.lang.Object |
|---|
getClass, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final MatrixFactory<Double> FACTORY
| Constructor Detail |
|---|
public PrimitiveMatrix(MatrixStore<Double> aStore)
| Method Detail |
|---|
public BasicMatrix enforce(NumberContext aContext)
public BasicMatrix round(NumberContext aContext)
public BigDecimal toBigDecimal(int aRow,
int aCol)
BasicMatrix
aRow - A row index.aCol - A column index.
public ComplexNumber toComplexNumber(int aRow,
int aCol)
BasicMatrix
aRow - A row index.aCol - A column index.
public PhysicalStore<Double> toPrimitiveStore()
BasicMatrix
toPrimitiveStore in interface BasicMatrixBasicMatrix.toBigStore(),
BasicMatrix.toComplexStore()
public String toString(int aRow,
int aCol)
public BasicMatrix add(BasicMatrix aMtrx)
BasicMatrix
add in interface BasicMatrixaMtrx - What to add.
public BasicMatrix add(Number aNmbr)
BasicMatrix
add in interface BasicMatrixaNmbr - What to add
public BasicMatrix conjugate()
BasicMatrix
conjugate in interface BasicMatrixBasicMatrix.transpose()public BasicMatrix divide(Number aNmbr)
BasicMatrix
divide in interface BasicMatrixaNmbr - The denominator.
public BasicMatrix divideElements(BasicMatrix aMtrx)
BasicMatrix
divideElements in interface BasicMatrixaMtrx - The denominator elements.
public double doubleValue(int i,
int j)
BasicMatrix
doubleValue in interface Access2D<N extends Number>doubleValue in interface BasicMatrixi - A row index.j - A column index.
public final boolean equals(BasicMatrix aMtrx,
NumberContext aCntxt)
equals in interface BasicMatrixpublic final boolean equals(Object obj)
equals in class Objectpublic void flushCache()
BasicMatrix
flushCache in interface BasicMatrix
public N get(int aRow,
int aColumn)
get in interface Access2D<N extends Number>public int getColDim()
getColDim in interface BasicMatrixpublic BasicMatrix getColumns(int[] someCols)
getColumns in interface BasicMatrixsomeCols - An ordered array of column indeces.
public Scalar<N> getCondition()
getCondition in interface BasicMatrixpublic Scalar<N> getDeterminant()
getDeterminant in interface BasicMatrixpublic List<ComplexNumber> getEigenvalues()
getEigenvalues in interface BasicMatrixpublic Scalar<N> getFrobeniusNorm()
BasicMatrix
getFrobeniusNorm in interface BasicMatrixBasicMatrix.getFrobeniusNorm()public Scalar<?> getInfinityNorm()
getInfinityNorm in interface BasicMatrixBasicMatrix.getFrobeniusNorm(),
BasicMatrix.getInfinityNorm(),
BasicMatrix.getKyFanNorm(int),
BasicMatrix.getOneNorm(),
BasicMatrix.getOperatorNorm(),
BasicMatrix.getTraceNorm(),
BasicMatrix.getVectorInfinityNorm(),
BasicMatrix.getVectorNorm(int),
BasicMatrix.getVectorZeroNorm()public Scalar<N> getKyFanNorm(int k)
getKyFanNorm in interface BasicMatrixBasicMatrix.getFrobeniusNorm(),
BasicMatrix.getInfinityNorm(),
BasicMatrix.getKyFanNorm(int),
BasicMatrix.getOneNorm(),
BasicMatrix.getOperatorNorm(),
BasicMatrix.getTraceNorm(),
BasicMatrix.getVectorInfinityNorm(),
BasicMatrix.getVectorNorm(int),
BasicMatrix.getVectorZeroNorm()public int getMinDim()
@Deprecated
public N getNumber(int aRow,
int aColumn)
get(int,int) instead
public Scalar<?> getOneNorm()
getOneNorm in interface BasicMatrixBasicMatrix.getFrobeniusNorm(),
BasicMatrix.getInfinityNorm(),
BasicMatrix.getKyFanNorm(int),
BasicMatrix.getOneNorm(),
BasicMatrix.getOperatorNorm(),
BasicMatrix.getTraceNorm(),
BasicMatrix.getVectorInfinityNorm(),
BasicMatrix.getVectorNorm(int),
BasicMatrix.getVectorZeroNorm()public Scalar<N> getOperatorNorm()
BasicMatrix
getOperatorNorm in interface BasicMatrixBasicMatrix.getFrobeniusNorm(),
BasicMatrix.getInfinityNorm(),
BasicMatrix.getKyFanNorm(int),
BasicMatrix.getOneNorm(),
BasicMatrix.getOperatorNorm(),
BasicMatrix.getTraceNorm(),
BasicMatrix.getVectorInfinityNorm(),
BasicMatrix.getVectorNorm(int),
BasicMatrix.getVectorZeroNorm()public int getRank()
BasicMatrix
getRank in interface BasicMatrixpublic int getRowDim()
getRowDim in interface BasicMatrixpublic BasicMatrix getRows(int[] someRows)
getRows in interface BasicMatrixsomeRows - An ordered array of row indeces.
public List<Double> getSingularValues()
getSingularValues in interface BasicMatrixpublic Scalar<N> getTrace()
BasicMatrix
getTrace in interface BasicMatrixpublic Scalar<N> getTraceNorm()
getTraceNorm in interface BasicMatrixBasicMatrix.getFrobeniusNorm(),
BasicMatrix.getInfinityNorm(),
BasicMatrix.getKyFanNorm(int),
BasicMatrix.getOneNorm(),
BasicMatrix.getOperatorNorm(),
BasicMatrix.getTraceNorm(),
BasicMatrix.getVectorInfinityNorm(),
BasicMatrix.getVectorNorm(int),
BasicMatrix.getVectorZeroNorm()public Scalar<N> getVectorInfinityNorm()
BasicMatrix
getVectorInfinityNorm in interface BasicMatrixBasicMatrix.getFrobeniusNorm(),
BasicMatrix.getInfinityNorm(),
BasicMatrix.getKyFanNorm(int),
BasicMatrix.getOneNorm(),
BasicMatrix.getOperatorNorm(),
BasicMatrix.getTraceNorm(),
BasicMatrix.getVectorInfinityNorm(),
BasicMatrix.getVectorNorm(int),
BasicMatrix.getVectorZeroNorm()public Scalar<N> getVectorNorm(int aDegree)
BasicMatrix
getVectorNorm in interface BasicMatrixBasicMatrix.getFrobeniusNorm(),
BasicMatrix.getInfinityNorm(),
BasicMatrix.getKyFanNorm(int),
BasicMatrix.getOneNorm(),
BasicMatrix.getOperatorNorm(),
BasicMatrix.getTraceNorm(),
BasicMatrix.getVectorInfinityNorm(),
BasicMatrix.getVectorNorm(int),
BasicMatrix.getVectorZeroNorm()public Scalar<N> getVectorZeroNorm()
getVectorZeroNorm in interface BasicMatrixBasicMatrix.getFrobeniusNorm(),
BasicMatrix.getInfinityNorm(),
BasicMatrix.getKyFanNorm(int),
BasicMatrix.getOneNorm(),
BasicMatrix.getOperatorNorm(),
BasicMatrix.getTraceNorm(),
BasicMatrix.getVectorInfinityNorm(),
BasicMatrix.getVectorNorm(int),
BasicMatrix.getVectorZeroNorm()public final int hashCode()
hashCode in class Objectpublic BasicMatrix invert()
BasicMatrixAbout inverting matrices:
invert in interface BasicMatrixpublic boolean isEmpty()
BasicMatrix
isEmpty in interface BasicMatrixpublic boolean isFat()
BasicMatrix
isFat in interface BasicMatrixpublic final boolean isFullRank()
isFullRank in interface BasicMatrixpublic boolean isHermitian()
isHermitian in interface BasicMatrixpublic boolean isScalar()
isScalar in interface BasicMatrixpublic boolean isSquare()
BasicMatrix
isSquare in interface BasicMatrixpublic boolean isSymmetric()
isSymmetric in interface BasicMatrixpublic boolean isTall()
BasicMatrix
isTall in interface BasicMatrixpublic boolean isVector()
isVector in interface BasicMatrixpublic BasicMatrix mergeColumns(BasicMatrix aMtrx)
BasicMatrix
mergeColumns in interface BasicMatrixaMtrx - The matrix to merge.
public BasicMatrix mergeRows(BasicMatrix aMtrx)
BasicMatrix
mergeRows in interface BasicMatrixaMtrx - The matrix to merge.
public BasicMatrix multiply(Number aNmbr)
BasicMatrix
multiply in interface BasicMatrixaNmbr - What to multiply with.
public BasicMatrix multiplyElements(BasicMatrix aMtrx)
BasicMatrix
multiplyElements in interface BasicMatrixaMtrx - The elements to multiply by.
public BasicMatrix multiplyLeft(BasicMatrix aMtrx)
BasicMatrix
multiplyLeft in interface BasicMatrixaMtrx - The left matrix.
BasicMatrix.multiplyRight(BasicMatrix)public BasicMatrix multiplyRight(BasicMatrix aMtrx)
BasicMatrix
multiplyRight in interface BasicMatrixaMtrx - The right matrix.
BasicMatrix.multiplyLeft(BasicMatrix)public Scalar<N> multiplyVectors(BasicMatrix aVctr)
BasicMatrix
multiplyVectors in interface BasicMatrixpublic BasicMatrix negate()
negate in interface BasicMatrix
public BasicMatrix set(int aRow,
int aCol,
Number aNmbr)
BasicMatrix
set in interface BasicMatrixpublic int size()
size in interface BasicMatrixpublic BasicMatrix solve(BasicMatrix aRHS)
BasicMatrixThis method solves a system of linear equations: [this][X]=[aRHS]. A combination of columns in [this] should produce a column in [aRHS]. It is ok for [aRHS] to have more than 1 column.
Remember that: [X][this]=[aRHS] is equivalent to [this]T[X]T=[aRHS]T
solve in interface BasicMatrixaRHS - The right hand side of the equation.
public BasicMatrix subtract(BasicMatrix aMtrx)
BasicMatrix
subtract in interface BasicMatrixaMtrx - What to subtract.
public BasicMatrix subtract(Number aNmbr)
BasicMatrix
subtract in interface BasicMatrixaNmbr - What to subtract.
public PhysicalStore<BigDecimal> toBigStore()
BasicMatrix
toBigStore in interface BasicMatrixBasicMatrix.toComplexStore(),
BasicMatrix.toPrimitiveStore()public PhysicalStore<ComplexNumber> toComplexStore()
BasicMatrix
toComplexStore in interface BasicMatrixBasicMatrix.toBigStore(),
BasicMatrix.toPrimitiveStore()public List<BasicMatrix> toListOfColumns()
toListOfColumns in interface BasicMatrixpublic List<N> toListOfElements()
BasicMatrix
toListOfElements in interface BasicMatrixpublic List<BasicMatrix> toListOfRows()
toListOfRows in interface BasicMatrix
public Scalar<N> toScalar(int aRow,
int aCol)
BasicMatrix
toScalar in interface Access2D<N extends Number>toScalar in interface BasicMatrixaRow - A row index.aCol - A column index.
public String toString()
toString in class Objectpublic BasicMatrix transpose()
BasicMatrix
transpose in interface BasicMatrixBasicMatrix.conjugate()
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||