Package weka.core

Class Matrix

java.lang.Object
weka.core.Matrix
All Implemented Interfaces:
Serializable, Cloneable, RevisionHandler
@Deprecated public class Matrix extends Object implements Cloneable, Serializable, RevisionHandler
Deprecated.
Use weka.core.matrix.Matrix instead - only for backwards compatibility.
Class for performing operations on a matrix of floating-point values.

Deprecated: Uses internally the code of the sub-package weka.core.matrix - only for backwards compatibility.

Version:
$Revision: 10203 $
Author:
Gabi Schmidberger (gabi@cs.waikato.ac.nz), Yong Wang (yongwang@cs.waikato.ac.nz), Eibe Frank (eibe@cs.waikato.ac.nz), Len Trigg (eibe@cs.waikato.ac.nz), Fracpete (fracpete at waikato dot ac dot nz)
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    Matrix(double[][] array)
    Deprecated.
    Constructs a matrix using a given array.
    Matrix(int nr, int nc)
    Deprecated.
    Constructs a matrix and initializes it with default values.
    Matrix(Reader r)
    Deprecated.
    Reads a matrix from a reader.

  • Method Summary

    Modifier and Type
    Method
    Description
    final Matrix
    add(Matrix other)
    Deprecated.
    Returns the sum of this matrix with another.
    final void
    addElement(int rowIndex, int columnIndex, double value)
    Deprecated.
    Add a value to an element.
    Object
    clone()
    Deprecated.
    Creates and returns a clone of this object.
    void
    eigenvalueDecomposition(double[][] V, double[] d)
    Deprecated.
    Performs Eigenvalue Decomposition using Householder QR Factorization Matrix must be symmetrical.
    double[]
    getColumn(int index)
    Deprecated.
    Gets a column of the matrix and returns it as a double array.
    final double
    getElement(int rowIndex, int columnIndex)
    Deprecated.
    Returns the value of a cell in the matrix.
    Matrix
    getL()
    Deprecated.
    Returns the L part of the matrix.
    String
    getRevision()
    Deprecated.
    Returns the revision string.
    double[]
    getRow(int index)
    Deprecated.
    Gets a row of the matrix and returns it as double array.
    Matrix
    getU()
    Deprecated.
    Returns the U part of the matrix.
    boolean
    isSymmetric()
    Deprecated.
    Returns true if the matrix is symmetric.
    int[]
    LUDecomposition()
    Deprecated.
    Performs a LUDecomposition on the matrix.
    static void
    main(String[] ops)
    Deprecated.
    Main method for testing this class.
    final Matrix
    multiply(Matrix b)
    Deprecated.
    Returns the multiplication of two matrices
    final int
    numColumns()
    Deprecated.
    Returns the number of columns in the matrix.
    final int
    numRows()
    Deprecated.
    Returns the number of rows in the matrix.
    static Matrix
    parseMatlab(String matlab)
    Deprecated.
    creates a matrix from the given Matlab string.
    final double[]
    regression(Matrix y, double ridge)
    Deprecated.
    Performs a (ridged) linear regression.
    final double[]
    regression(Matrix y, double[] w, double ridge)
    Deprecated.
    Performs a weighted (ridged) linear regression.
    final void
    setColumn(int index, double[] newColumn)
    Deprecated.
    Sets a column of the matrix to the given column.
    final void
    setElement(int rowIndex, int columnIndex, double value)
    Deprecated.
    Sets an element of the matrix to the given value.
    final void
    setRow(int index, double[] newRow)
    Deprecated.
    Sets a row of the matrix to the given row.
    void
    solve(double[] bb)
    Deprecated.
    Solve A*X = B using backward substitution.
    String
    toMatlab()
    Deprecated.
    converts the Matrix into a single line Matlab string: matrix is enclosed by parentheses, rows are separated by semicolon and single cells by blanks, e.g., [1 2; 3 4].
    String
    toString()
    Deprecated.
    Converts a matrix to a string
    final Matrix
    transpose()
    Deprecated.
    Returns the transpose of a matrix.
    void
    write(Writer w)
    Deprecated.
    Writes out a matrix.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Matrix

      public Matrix(int nr, int nc)
      Deprecated.
      Constructs a matrix and initializes it with default values.
      Parameters:
      nr - the number of rows
      nc - the number of columns

    • Matrix

      public Matrix(double[][] array) throws Exception
      Deprecated.
      Constructs a matrix using a given array.
      Parameters:
      array - the values of the matrix
      Throws:
      Exception

    • Matrix

      public Matrix(Reader r) throws Exception
      Deprecated.
      Reads a matrix from a reader. The first line in the file should contain the number of rows and columns. Subsequent lines contain elements of the matrix.
      Parameters:
      r - the reader containing the matrix
      Throws:
      Exception - if an error occurs

  • Method Details

    • clone

      public Object clone()
      Deprecated.
      Creates and returns a clone of this object.
      Returns:
      a clone of this instance.
      Throws:
      Exception - if an error occurs

    • write

      public void write(Writer w) throws Exception
      Deprecated.
      Writes out a matrix.
      Parameters:
      w - the output Writer
      Throws:
      Exception - if an error occurs

    • getElement

      public final double getElement(int rowIndex, int columnIndex)
      Deprecated.
      Returns the value of a cell in the matrix.
      Parameters:
      rowIndex - the row's index
      columnIndex - the column's index
      Returns:
      the value of the cell of the matrix

    • addElement

      public final void addElement(int rowIndex, int columnIndex, double value)
      Deprecated.
      Add a value to an element.
      Parameters:
      rowIndex - the row's index.
      columnIndex - the column's index.
      value - the value to add.

    • numRows

      public final int numRows()
      Deprecated.
      Returns the number of rows in the matrix.
      Returns:
      the number of rows

    • numColumns

      public final int numColumns()
      Deprecated.
      Returns the number of columns in the matrix.
      Returns:
      the number of columns

    • setElement

      public final void setElement(int rowIndex, int columnIndex, double value)
      Deprecated.
      Sets an element of the matrix to the given value.
      Parameters:
      rowIndex - the row's index
      columnIndex - the column's index
      value - the value

    • setRow

      public final void setRow(int index, double[] newRow)
      Deprecated.
      Sets a row of the matrix to the given row. Performs a deep copy.
      Parameters:
      index - the row's index
      newRow - an array of doubles

    • getRow

      public double[] getRow(int index)
      Deprecated.
      Gets a row of the matrix and returns it as double array.
      Parameters:
      index - the row's index
      Returns:
      an array of doubles

    • getColumn

      public double[] getColumn(int index)
      Deprecated.
      Gets a column of the matrix and returns it as a double array.
      Parameters:
      index - the column's index
      Returns:
      an array of doubles

    • setColumn

      public final void setColumn(int index, double[] newColumn)
      Deprecated.
      Sets a column of the matrix to the given column. Performs a deep copy.
      Parameters:
      index - the column's index
      newColumn - an array of doubles

    • toString

      public String toString()
      Deprecated.
      Converts a matrix to a string
      Overrides:
      toString in class Object
      Returns:
      the converted string

    • add

      public final Matrix add(Matrix other)
      Deprecated.
      Returns the sum of this matrix with another.
      Returns:
      a matrix containing the sum.

    • transpose

      public final Matrix transpose()
      Deprecated.
      Returns the transpose of a matrix.
      Returns:
      the transposition of this instance.

    • isSymmetric

      public boolean isSymmetric()
      Deprecated.
      Returns true if the matrix is symmetric.
      Returns:
      boolean true if matrix is symmetric.

    • multiply

      public final Matrix multiply(Matrix b)
      Deprecated.
      Returns the multiplication of two matrices
      Parameters:
      b - the multiplication matrix
      Returns:
      the product matrix

    • regression

      public final double[] regression(Matrix y, double ridge)
      Deprecated.
      Performs a (ridged) linear regression.
      Parameters:
      y - the dependent variable vector
      ridge - the ridge parameter
      Returns:
      the coefficients
      Throws:
      IllegalArgumentException - if not successful

    • regression

      public final double[] regression(Matrix y, double[] w, double ridge)
      Deprecated.
      Performs a weighted (ridged) linear regression.
      Parameters:
      y - the dependent variable vector
      w - the array of data point weights
      ridge - the ridge parameter
      Returns:
      the coefficients
      Throws:
      IllegalArgumentException - if the wrong number of weights were provided.

    • getL

      public Matrix getL() throws Exception
      Deprecated.
      Returns the L part of the matrix. This does only make sense after LU decomposition.
      Returns:
      matrix with the L part of the matrix;
      Throws:
      Exception
      See Also:

    • getU

      public Matrix getU() throws Exception
      Deprecated.
      Returns the U part of the matrix. This does only make sense after LU decomposition.
      Returns:
      matrix with the U part of a matrix;
      Throws:
      Exception
      See Also:

    • LUDecomposition

      public int[] LUDecomposition() throws Exception
      Deprecated.
      Performs a LUDecomposition on the matrix. It changes the matrix into its LU decomposition.
      Returns:
      the indices of the row permutation
      Throws:
      Exception

    • solve

      public void solve(double[] bb) throws Exception
      Deprecated.
      Solve A*X = B using backward substitution. A is current object (this). Note that this matrix will be changed! B parameter bb. X returned in parameter bb.
      Parameters:
      bb - first vector B in above equation then X in same equation.
      Throws:
      Exception

    • eigenvalueDecomposition

      public void eigenvalueDecomposition(double[][] V, double[] d) throws Exception
      Deprecated.
      Performs Eigenvalue Decomposition using Householder QR Factorization Matrix must be symmetrical. Eigenvectors are return in parameter V, as columns of the 2D array. (Real parts of) Eigenvalues are returned in parameter d.
      Parameters:
      V - double array in which the eigenvectors are returned
      d - array in which the eigenvalues are returned
      Throws:
      Exception - if matrix is not symmetric

    • toMatlab

      public String toMatlab()
      Deprecated.
      converts the Matrix into a single line Matlab string: matrix is enclosed by parentheses, rows are separated by semicolon and single cells by blanks, e.g., [1 2; 3 4].
      Returns:
      the matrix in Matlab single line format

    • parseMatlab

      public static Matrix parseMatlab(String matlab) throws Exception
      Deprecated.
      creates a matrix from the given Matlab string.
      Parameters:
      matlab - the matrix in matlab format
      Returns:
      the matrix represented by the given string
      Throws:
      Exception
      See Also:

    • getRevision

      public String getRevision()
      Deprecated.
      Returns the revision string.
      Specified by:
      getRevision in interface RevisionHandler
      Returns:
      the revision

    • main

      public static void main(String[] ops)
      Deprecated.
      Main method for testing this class.