|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface BasicMatrix
This interface declares a set of high level methods for linear algebra. Only the most basic set of matrix functionality is defined here. Various matrix decompositions may be used to do some of the more advanced tasks.
A vector is a matrix with column (or perhaps row) dimension 1.
LU,
Cholesky,
QR,
Eigenvalue,
SingularValue,
MatrixStore| 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. |
Scalar<? extends Number> |
calculateDeterminant()
Deprecated. Since Version 24. Use getDeterminant() instead |
Scalar<? extends Number> |
calculateFrobeniusNorm()
Deprecated. Since Version 24. Use getFrobeniusNorm() instead |
int |
calculateRank()
Deprecated. Since Version 24. Use getRank() instead |
Scalar<? extends Number> |
calculateTrace()
Deprecated. Since Version 24. Use getTrace() instead |
Scalar<? extends Number> |
calculateVectorNorm(int aDegree)
Deprecated. Since Version 24. Use getVectorNorm(int) instead |
Scalar<? extends Number> |
calculateVectorProduct(BasicMatrix aVctr)
Deprecated. Since Version 24. Use getVectorProduct(BasicMatrix) instead |
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 aRow,
int aCol)
Extracts one element of this matrix as a double. |
BasicMatrix |
enforce(NumberContext aCntxt)
|
boolean |
equals(BasicMatrix aMtrx,
NumberContext aCntxt)
|
int |
getColDim()
|
BasicMatrix |
getColumns(int[] someCols)
|
Scalar<?> |
getDeterminant()
|
Scalar<?> |
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()
The largest, absolute, element value. |
Scalar<? extends Number> |
getLargestElement()
Deprecated. Since Version 24. Use getInfinityNorm() instead |
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)
|
Scalar<?> |
getTrace()
The sum of the diagonal elements. |
Scalar<?> |
getVectorNorm(int aDegree)
Treats [this] as if it is one dimensional (a vector) and calculates the vector norm. |
Scalar<?> |
getVectorProduct(BasicMatrix aVctr)
Treats [this] and [aVctr] as if they are one dimensional (vectors) and calculates the vector (dot) product. |
Scalar<?> |
getZeroNorm()
|
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 |
isSquare()
Matrices are either square, tall, fat or empty. |
boolean |
isTall()
Matrices are either square, tall, fat or empty. |
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. |
BasicMatrix |
negate()
|
BasicMatrix |
set(int aRow,
int aCol,
Number aNmbr)
|
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()
|
ComplexNumber |
toComplexNumber(int aRow,
int aCol)
Extracts one element of this matrix as a ComplexNumber. |
PhysicalStore<ComplexNumber> |
toComplexStore()
|
List<BasicMatrix> |
toListOfColumns()
|
List<BigDecimal> |
toListOfElements()
|
List<BasicMatrix> |
toListOfRows()
|
PhysicalStore<Double> |
toPrimitiveStore()
|
Scalar<?> |
toScalar(int aRow,
int aCol)
Extracts one element of this matrix as a Scalar. |
String |
toString(int aRow,
int aCol)
|
BasicMatrix |
transpose()
Transposes this matrix. |
| Method Detail |
|---|
BasicMatrix add(BasicMatrix aMtrx)
aMtrx - What to add.
BasicMatrix add(Number aNmbr)
aNmbr - What to add
@Deprecated Scalar<? extends Number> calculateDeterminant()
getDeterminant() instead
@Deprecated Scalar<? extends Number> calculateFrobeniusNorm()
getFrobeniusNorm() instead
@Deprecated int calculateRank()
getRank() instead
@Deprecated Scalar<? extends Number> calculateTrace()
getTrace() instead
@Deprecated Scalar<? extends Number> calculateVectorNorm(int aDegree)
getVectorNorm(int) instead
toListOfRows(),
toListOfColumns(),
toListOfElements()@Deprecated Scalar<? extends Number> calculateVectorProduct(BasicMatrix aVctr)
getVectorProduct(BasicMatrix) instead
BasicMatrix conjugate()
transpose()BasicMatrix divide(Number aNmbr)
aNmbr - The denominator.
BasicMatrix divideElements(BasicMatrix aMtrx)
aMtrx - The denominator elements.
double doubleValue(int aRow,
int aCol)
aRow - A row index.aCol - A column index.
BasicMatrix enforce(NumberContext aCntxt)
boolean equals(BasicMatrix aMtrx,
NumberContext aCntxt)
int getColDim()
BasicMatrix getColumns(int[] someCols)
someCols - An ordered array of column indeces.
Scalar<?> getDeterminant()
Scalar<?> getFrobeniusNorm()
Scalar<?> getInfinityNorm()
@Deprecated Scalar<? extends Number> getLargestElement()
getInfinityNorm() instead
int getRank()
int getRowDim()
BasicMatrix getRows(int[] someRows)
someRows - An ordered array of row indeces.
Scalar<?> getTrace()
Scalar<?> getVectorNorm(int aDegree)
toListOfRows(),
toListOfColumns(),
toListOfElements()Scalar<?> getVectorProduct(BasicMatrix aVctr)
Scalar<?> getZeroNorm()
BasicMatrix invert()
About inverting matrices:
solve(BasicMatrix).solve(BasicMatrix) and transposing.QR or
SingularValue decompositions.
boolean isEmpty()
boolean isFat()
boolean isSquare()
boolean isTall()
BasicMatrix mergeColumns(BasicMatrix aMtrx)
aMtrx - The matrix to merge.
BasicMatrix mergeRows(BasicMatrix aMtrx)
aMtrx - The matrix to merge.
BasicMatrix multiply(Number aNmbr)
aNmbr - What to multiply with.
BasicMatrix multiplyElements(BasicMatrix aMtrx)
aMtrx - The elements to multiply by.
BasicMatrix multiplyLeft(BasicMatrix aMtrx)
aMtrx - The left matrix.
multiplyRight(BasicMatrix)BasicMatrix multiplyRight(BasicMatrix aMtrx)
aMtrx - The right matrix.
multiplyLeft(BasicMatrix)BasicMatrix negate()
BasicMatrix set(int aRow,
int aCol,
Number aNmbr)
int size()
BasicMatrix solve(BasicMatrix aRHS)
This 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
aRHS - The right hand side of the equation.
BasicMatrix subtract(BasicMatrix aMtrx)
aMtrx - What to subtract.
BasicMatrix subtract(Number aNmbr)
aNmbr - What to subtract.
BigDecimal toBigDecimal(int aRow,
int aCol)
aRow - A row index.aCol - A column index.
PhysicalStore<BigDecimal> toBigStore()
toComplexStore(),
toPrimitiveStore()
ComplexNumber toComplexNumber(int aRow,
int aCol)
aRow - A row index.aCol - A column index.
PhysicalStore<ComplexNumber> toComplexStore()
toBigStore(),
toPrimitiveStore()List<BasicMatrix> toListOfColumns()
List<BigDecimal> toListOfElements()
List<BasicMatrix> toListOfRows()
PhysicalStore<Double> toPrimitiveStore()
toBigStore(),
toComplexStore()
Scalar<?> toScalar(int aRow,
int aCol)
aRow - A row index.aCol - A column index.
String toString(int aRow,
int aCol)
BasicMatrix transpose()
conjugate()
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||