Class Matrix

java.lang.Object
ch.nolix.base.math.algebra.Matrix
public final class Matrix extends Object
A Matrix represents a mathematical matrix of doubles. All comparisons a Matrix does are approximative. For example: -The second row of the matrix [4, 5; 0.000000001, 0] is interpreted as a zero row. -The matrix [0.9999999999, 0; 0, 1] is interpreted as a identity matrix.
Author:
Silvan Wyss

  • Method Details

    • createIdendityMatrixWithLength

      public static Matrix createIdendityMatrixWithLength(int length)
      Parameters:
      length -
      Returns:
      a new identity Matrix with the given length.
      Throws:
      RuntimeException - if the given length is not positive.

    • createQuadraticMatrixWithOnesAndLength

      public static Matrix createQuadraticMatrixWithOnesAndLength(int length)
      The values of the created Matrix will be all 1.0
      Parameters:
      length -
      Returns:
      a new Matrix with the given length.
      Throws:
      RuntimeException - if the given length is not positive.

    • createRandomQuadraticMatrixWithLength

      public static Matrix createRandomQuadraticMatrixWithLength(int length)
      The values of the created Matrix will be all a whole random number in [0, 99].
      Parameters:
      length -
      Returns:
      a new Matrix with the given length.

    • createRandomQuadraticMatrixWithRowCountAndColumnCount

      public static Matrix createRandomQuadraticMatrixWithRowCountAndColumnCount(int rowCount, int columnCount)
      The values of the created Matrix will be all a whole random number in [0, 99].
      Parameters:
      rowCount -
      columnCount -
      Returns:
      a new Matrix with the given number of rows and the given number of columns.
      Throws:
      RuntimeException - if the given rowCount is not positive.
      RuntimeException - if the given columnCount is not positive.

    • withOnesAndRowCountAndColumnCount

      public static Matrix withOnesAndRowCountAndColumnCount(int rowCount, int columnCount)
      The values of the created Matrix will be all 1.0
      Parameters:
      rowCount -
      columnCount -
      Returns:
      a new Matrix with the given number of rows and the given number of columns.
      Throws:
      RuntimeException - if the given rowCount is not positive.
      RuntimeException - if the given columnCount is not positive.

    • withRowCountAndColumnCount

      public static Matrix withRowCountAndColumnCount(int rowCount, int columnCount)
      Parameters:
      rowCount -
      columnCount -
      Returns:
      a new Matrix with the given rowCount and columnCount.
      Throws:
      RuntimeException - if the given rowCount is not positive.
      RuntimeException - if the given columnCount is not positive.

    • withRowCountAndColumnCountAndDefaultValue

      public static Matrix withRowCountAndColumnCountAndDefaultValue(int rowCount, int columnCount, double defaultValue)
      Parameters:
      rowCount -
      columnCount -
      defaultValue -
      Returns:
      a new Matrix with the given rowCount and columnCount. The values of the matrix will be set to the given defaultValue.
      Throws:
      RuntimeException - if the given rowCount is not positive.
      RuntimeException - if the given columnCount is not positive.

    • add

      public Matrix add(Matrix matrix)
      Adds the given matrix to the current Matrix.
      Parameters:
      matrix -
      Returns:
      the current Matrix.
      Throws:
      UnequalArgumentException - if the given matrix has not as many rows as the current Matrix.
      UnequalArgumentException - if the given matrix has not as many columns as the current Matrix.

    • appendAtRight

      public Matrix appendAtRight(Matrix matrix)
      Appends the given matrix at the right of the current Matrix.
      Parameters:
      matrix -
      Returns:
      the current Matrix.
      Throws:
      UnequalArgumentException - if the given matrix has not as many rows as the current Matrix.

    • appendAtBottom

      public Matrix appendAtBottom(double... rowValues)
      Appends a new row with the given row values at the bottom of the current Matrix.
      Parameters:
      rowValues -
      Returns:
      the current Matrix.
      Throws:
      RuntimeException - if not as many row values are given than the number of columns of the current Matrix.

    • equals

      public boolean equals(Object object)
      Overrides:
      equals in class Object

    • getColumnCount

      public int getColumnCount()
      Returns:
      the number of columns of the current Matrix

    • getClone

      public Matrix getClone()
      Returns:
      a clone of the current Matrix

    • getColumnVectors

      public Vector[] getColumnVectors()
      Returns:
      the column vectors of the current Matrix

    • getInverse

      public Matrix getInverse()
      Returns:
      the inverse matrix of the current Matrix.
      Throws:
      RuntimeException - if the current Matrix is not regular.

    • getMatrixWithFirstColumns

      public Matrix getMatrixWithFirstColumns(int columnCount)
      Parameters:
      columnCount -
      Returns:
      a matrix with the first columns of the current Matrix.
      Throws:
      RuntimeException - if the given column count is not valid.

    • getMatrixWithLastColumns

      public Matrix getMatrixWithLastColumns(int columnCount)
      Parameters:
      columnCount -
      Returns:
      a matrix with the last columns of the current Matrix.
      Throws:
      RuntimeException - if the given column count is not valid.

    • getMinimalFactorMatrix

      public Matrix getMinimalFactorMatrix(Matrix solutionMatrix)
      This method implements the least squares algorithm.
      Parameters:
      solutionMatrix -
      Returns:
      a matrix A so that the matrix X*A-Y is minimal. -X is the current Matrix. -Y is the given solution matrix. The following formula is used: A = (X_t*X)^-1*X_t*Y.
      Throws:
      UnequalArgumentException - if the given solution matrix has not 1 column.
      UnequalArgumentException - if the given solution matrix has not as many rows as the current Matrix.

    • getProduct

      public Matrix getProduct(Matrix matrix)
      Parameters:
      matrix -
      Returns:
      the product of the current Matrix and the given matrix.
      Throws:
      UnequalArgumentException - if the given matrix has not as many rows as the current Matrix columns has.

    • getPseudoInverse

      public Matrix getPseudoInverse()
      Returns:
      a pseudo inverse matrix of the current Matrix.
      Throws:
      RuntimeException - if the current Matrix is not quadratic.

    • getRank

      public int getRank()
      Returns:
      the rank of the current Matrix.
      Throws:
      RuntimeException - if the current Matrix is not quadratic.

    • getRowCount

      public int getRowCount()
      Returns:
      the number of rows of the current Matrix

    • getRowVectors

      public Vector[] getRowVectors()
      Returns:
      the row vectors of the current Matrix

    • getSize

      public int getSize()
      Returns:
      the size of the current Matrix

    • getSolutionAsExtendedMatrix

      public double[] getSolutionAsExtendedMatrix()
      Returns:
      the solution when the current Matrix is an extended matrix of a linear equation system

    • getSum

      public Matrix getSum(Matrix matrix)
      Parameters:
      matrix -
      Returns:
      the matrix that is the sum of the current Matrix and the given matrix
      Throws:
      UnequalArgumentException - if the given matrix has not the same size as the current Matrix

    • getTransposed

      public Matrix getTransposed()
      Returns:
      the transposed matrix of the current Matrix.

    • getTrace

      public double getTrace()
      Returns:
      the trace of the current Matrix.
      Throws:
      RuntimeException - if the current Matrix is not quadratic.

    • getValue

      public double getValue(int rowIndex, int columnIndex)
      Parameters:
      rowIndex -
      columnIndex -
      Returns:
      the value in the row with the given row index and the column with the given column index.
      Throws:
      RuntimeException - if the current Matrix does not contain a row with the given row index.
      RuntimeException - if the current Matrix does not contain a column with the given column index.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • hasSameSize

      public boolean hasSameSize(Matrix matrix)
      Parameters:
      matrix -
      Returns:
      true if the current Matrix has the same size as the given matrix, false otherwise.

    • isIdentityMatrix

      public boolean isIdentityMatrix()
      Returns:
      true if the current Matrix is an identity matrix, false otherwise.

    • isQuadratic

      public boolean isQuadratic()
      Returns:
      true if the current Matrix is a quadratic matrix, false otherwise.

    • isRegular

      public boolean isRegular()
      Returns:
      true if the current Matrix is regular, false otherwise.

    • multiply

      public Matrix multiply(double factor)
      Multiplies the current Matrix with the given factor.
      Parameters:
      factor -
      Returns:
      the current Matrix

    • multiplyRow

      public Matrix multiplyRow(int rowIndex, double factor)
      Multiplies the row with the given row index with the given factor.
      Parameters:
      rowIndex -
      factor -
      Returns:
      the current Matrix.
      Throws:
      RuntimeException - if the current Matrix does not contain a row with the given row index.

    • removeZeroRows

      public Matrix removeZeroRows()
      Removes the zero rows of the current Matrix using an epsilon
      Returns:
      the current Matrix

    • setAllValuesTo

      public Matrix setAllValuesTo(double value)
      Sets the values of the current Matrix to the given value.
      Parameters:
      value -
      Returns:
      the current Matrix

    • setValues

      public Matrix setValues(double... values)
      Sets the values of the current Matrix.
      Parameters:
      values -
      Returns:
      the current Matrix.
      Throws:
      RuntimeException - if not as many values are given as the current Matrix contains.

    • setValue

      public Matrix setValue(int rowIndex, int columnIndex, double value)
      Sets the value in the row with the given row index and the column with the given column index.
      Parameters:
      rowIndex -
      columnIndex -
      value -
      Returns:
      the current Matrix.
      Throws:
      RuntimeException - if the current Matrix does not contain a row with the given row index.
      RuntimeException - if the current Matrix does not contain a column with the given column index.

    • setDiagonalValuesTo

      public Matrix setDiagonalValuesTo(double value)
      Sets the diagonal values of the current Matrix to the given value.
      Parameters:
      value -
      Returns:
      the current Matrix
      Throws:
      RuntimeException - if the current Matrix is not quadratic

    • swapRows

      public Matrix swapRows(int row1Index, int row2Index)
      Swaps the rows with the given indexes.
      Parameters:
      row1Index -
      row2Index -
      Returns:
      the current Matrix.
      Throws:
      RuntimeException - if the current Matrix does not have a row with the given row1 index.
      RuntimeException - if the current Matrix does not have a row with the given row1 index.

    • toPolynom

      public Polynom toPolynom()
      Returns:
      a polynom representation of the current Matrix
      Throws:
      RuntimeException - if the current Matrix does not represent a Polynom.

    • toVector

      public Vector toVector()
      Returns:
      a vector representation of the current Matrix
      Throws:
      RuntimeException - if the current Matrix does not represent a Vector.

    • tranformFirstPartToIdentityMatrix

      public Matrix tranformFirstPartToIdentityMatrix()
      Transforms the first part of the current Matrix to an identity matrix.
      Returns:
      the current Matrix
      Throws:
      RuntimeException - if the current Matrix has more rows than columns.
      RuntimeException - if the current Matrix has linear depending rows.

    • transformToEquivalentUpperLeftMatrix

      public Matrix transformToEquivalentUpperLeftMatrix()
      Transforms the current Matrix to an equivalent upper left matrix.
      Returns:
      the current Matrix

    • toString

      public String toString()
      Overrides:
      toString in class Object
      Returns:
      a String representation of this object

    • transpose

      public Matrix transpose()
      Transposes the current Matrix.
      Returns:
      the current Matrix