RealMatrix (CML Euclid 2.9 API)

java.lang.Object
- org.xmlcml.euclid.RealMatrix

All Implemented Interfaces:

EuclidConstants

Direct Known Subclasses:

RealSquareMatrix
```
public class RealMatrix
extends Object
implements EuclidConstants
```
rectangular real number matrix class RealMatrix represents a rectangular m-x-n matrix. The basic matrix algebra for non-square matrices is represented here and this class is also a base for square matrices.
Read the signature of each member function carefully as some MODIFY the object and some CREATE A NEW ONE. Among the reasons for this is that subclassing (e.g to RealSquareMatrix) is easier with one of these forms in certain cases. Note that if you modify an object, then all references to it will refer to the changed object

Author:

(C) P. Murray-Rust, 1996

Field Summary

Fields
Modifier and Type Field and Description

protected int cols
number of columns

protected double[][] flmat
the matrix

protected int rows
number of rows
- Fields inherited from interface org.xmlcml.euclid.EuclidConstants
  C_AMP, C_APOS, C_ATSIGN, C_BACKSLASH, C_BACKSPACE, C_CARET, C_COLON, C_COMMA, C_DEL, C_DOLLAR, C_EQUALS, C_FORMFEED, C_HASH, C_LANGLE, C_LBRAK, C_LCURLY, C_LSQUARE, C_MINUS, C_NBSP, C_NEWLINE, C_NL, C_PERCENT, C_PERIOD, C_PIPE, C_PLUS, C_POUND, C_QUERY, C_QUOT, C_RANGLE, C_RBRAK, C_RCURLY, C_RETURN, C_RSQUARE, C_SEMICOLON, C_SHRIEK, C_SLASH, C_SPACE, C_STAR, C_TAB, C_TILDE, C_UNDER, EPS, F_S, NONWHITEPUNC, NONWHITEPUNC0, NONWHITEPUNC0REGEX, ONE_THIRD, PUNC, S_AMP, S_APOS, S_ATSIGN, S_BACKSLASH, S_CARET, S_COLON, S_COMMA, S_DOLLAR, S_EMPTY, S_EQUALS, S_FORMFEED, S_HASH, S_LANGLE, S_LBRAK, S_LCURLY, S_LSQUARE, S_MINUS, S_NEWLINE, S_NL, S_PERCENT, S_PERIOD, S_PIPE, S_PLUS, S_POUND, S_QUERY, S_QUOT, S_RANGLE, S_RBRAK, S_RCURLY, S_RETURN, S_RSQUARE, S_SEMICOLON, S_SHRIEK, S_SLASH, S_SPACE, S_STAR, S_TAB, S_TILDE, S_UNDER, S_WHITEREGEX, TWO_THIRDS, U_S, WHITESPACE

Fields
Modifier and Type	Field and Description
`protected int`	`cols` number of columns
`protected double[][]`	`flmat` the matrix
`protected int`	`rows` number of rows

Constructor Summary

Constructors
Constructor and Description
`RealMatrix()` construct default matrix.
`RealMatrix(double[][] m)` create from a java matrix.
`RealMatrix(int r, int c)` Create matrix with given rows and columns.
`RealMatrix(int r, int c, double f)` creates matrix with initialised values.
`RealMatrix(int rows, int cols, double[] array)` Create from 1-D array.
`RealMatrix(IntMatrix m)` construct from a IntMatrix.
`RealMatrix(RealMatrix m)` copy constructor.
`RealMatrix(RealMatrix m, int lowrow, int hirow, int lowcol, int hicol)` create from submatrix of another matrix.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`appendColumnData(RealArray f)` append data to matrix columnwise.
`void`	`appendColumnData(RealMatrix m)` append data to matrix columnwise.
`void`	`appendRowData(RealArray f)` append data to matrix rowwise.
`void`	`appendRowData(RealMatrix m)` append data to matrix rowwise.
`protected boolean`	`checkNonEmptyMatrix()`
`void`	`clearMatrix()` clear matrix.
`void`	`columnwiseDivide(RealArray f)` divide each column of a matrix by a vector of scalars (that is mat[i][j] = mat[i][j] / vect[i] - MODIFIES matrix
`RealMatrix`	`createMatrixWithOriginShifted(double deltax, double deltay)`
`void`	`deleteColumn(int col)` delete column from matrix and close up.
`void`	`deleteColumns(int low, int high)` delete 2 or more adjacent columns (inclusive) from matrix and close up.
`void`	`deleteRow(int row)` delete row from matrix and close up.
`void`	`deleteRows(int low, int high)` delete 2 or more adjacent rows (inclusive) from matrix and close up.
`double`	`elementAt(Int2 rowcol)` extracts a given element.
`double`	`elementAt(int row, int col)` extracts a given element.
`IntMatrix`	`elementsInRange(RealRange r)` produce a mask of those elements which fall in a range.
`double`	`euclideanColumnLength(int jcol)` get Euclidean length of column.
`RealArray`	`euclideanColumnLengths()` get array of Euclidean column lengths
`double`	`euclideanRowLength(int i)` get Euclidean length of row.
`RealArray`	`euclideanRowLengths()` get array of Euclidean row lengths.
`RealArray`	`extractColumnData(int col)` get column data from matrix.
`Real2Array`	`extractColumns(int col1, int col2)` make an Real2_Array from columns.
`RealArray`	`extractRowData(int row)` get row data from matrix.
`Real2Array`	`extractRows(int row1, int row2)` make an Real2_Array from rows.
`RealMatrix`	`extractSubMatrixData(int low_row, int high_row, int low_col, int high_col)` extract a RealMatrix submatrix from a RealMatrix
`RealMatrix`	`format(int places)` round to decimal places.
`int`	`getCols()` get number of columns.
`DecimalFormat`	`getFormat()` get output format.
`IntMatrix`	`getIntMatrix()` constructs an IntMatrix.
`double[][]`	`getMatrix()` get matrix as java matrix.
`double[]`	`getMatrixAsArray()` get matrix as array.
`int`	`getRows()` get number of rows.
`RealMatrix`	`getTranspose()` transpose matrix - creates new Matrix
`Int2`	`indexOfLargestElement()` get index of largest element.
`int`	`indexOfLargestElementInColumn(int jcol)` get index of largest element in column.
`int`	`indexOfLargestElementInRow(int irow)` get index of largest element in row.
`Int2`	`indexOfSmallestElement()` get index of smallest element.
`int`	`indexOfSmallestElementInColumn(int jcol)` get index of smallest element in column.
`int`	`indexOfSmallestElementInRow(int irow)` get index of smallest element in row.
`void`	`insertColumnData(int after_col, RealArray f)` add data as column or column block into matrix and expand.
`void`	`insertColumnData(int afterCol, RealMatrix m)` add data as column or column block into matrix and expand.
`void`	`insertRowData(int after_row, RealArray f)` insert row of data into matrix and expand.
`void`	`insertRowData(int afterRow, RealMatrix m)` insert 2 or more adjacent rows of data into matrix and expand
`void`	`insertRows(int after_row, int delta_rows)` make space for new rows in matrix and expand.
`boolean`	`isEqualTo(RealMatrix m)` tests matrices for equality.
`boolean`	`isOrthogonal()` is matrix Orthogonal row-wise.
`boolean`	`isSquare()` is the matrix square
`boolean`	`isZero(double eps)` are all elements of matrix zero?
`double`	`largestElement()` get value of largest element.
`double`	`largestElementInColumn(int jcol)` get value of largest element in a column
`double`	`largestElementInRow(int irow)` get value of largest element in a row.
`void`	`makeSpaceForNewColumns(int after_col, int delta_cols)` insert a hole into the matrix and expand.
`RealArray`	`multiply(RealArray f)` matrix multiplication of a COLUMN vector.
`RealMatrix`	`multiply(RealMatrix m)` matrix multiplication.
`void`	`multiplyBy(double f)` matrix multiplication by a scalar.
`void`	`multiplyEquals(RealMatrix m)` matrix multiplication.
`void`	`negative()` unary minus.
`void`	`normaliseByColumns()` normalise matrix columns to length of unity
`void`	`normaliseByRows()` normalise matrix rows to length of unity
`RealMatrix`	`plus(RealMatrix m2)` matrix addition.
`RealMatrix`	`reorderColumnsBy(IntSet is)` reorder the columns of a matrix.
`RealMatrix`	`reorderRowsBy(IntSet is)` reorder the rows of a matrix Deleting rows is allowed
`void`	`replaceColumnData(int starting_col, double[] f)` replace data in a single column.
`void`	`replaceColumnData(int column, RealArray f)` replace data in a single column.
`void`	`replaceColumnData(int start_column, RealMatrix m)` replace data in a block of columns.
`void`	`replaceRowData(int row, double[] f)` overwrite existing row of data.
`void`	`replaceRowData(int row, RealArray f)` overwrite existing row of data.
`void`	`replaceRowData(int afterRow, RealMatrix m)` overwrite existing block of rows; if too big, copying is truncated
`void`	`replaceSubMatrixData(int low_row, int low_col, RealMatrix m)` replaces the data in a submatrix.
`RealMatrix`	`scaleAndInterpolate(int newRows, int newCols)`
`void`	`setAllElements(double f)` initialise matrix to given double.
`void`	`setElementAt(int row, int col, double f)` sets a given element MODIFIES matrix
`void`	`setFormat(DecimalFormat f)` set output format.
`void`	`shallowCopy(RealMatrix m)` shallow copy constructor.
`double`	`smallestElement()` get value of smallest element.
`double`	`smallestElementInColumn(int jcol)` get smallest element in a column.
`double`	`smallestElementInRow(int irow)` get smallest element in a row.
`RealMatrix`	`subtract(RealMatrix m2)` matrix subtraction.
`String`	`toString()` output matrix - very crude
`void`	`translateByColumn(double[] d)` subtract value from each colum.
`void`	`writeXML(Writer w)` output xml as a CML matrix.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - rows
```
protected int rows
```
    number of rows
  - cols
```
protected int cols
```
    number of columns
  - flmat
```
protected double[][] flmat
```
    the matrix
- Constructor Detail
  - RealMatrix
```
public RealMatrix()
```
    construct default matrix. cols = rows = 0
  - RealMatrix
```
public RealMatrix(int r,
                  int c)
```
    Create matrix with given rows and columns. A rows*cols matrix values set to 0 (rows or cols < 0 defaults to 0)
    
    Parameters:
    
    r - number of rows
    
    c - number of columns
  - RealMatrix
```
public RealMatrix(int rows,
                  int cols,
                  double[] array)
           throws EuclidRuntimeException
```
    Create from 1-D array. Formed by feeding in an existing 1-D array to a rowsXcols matrix THE COLUMN IS THE FASTEST MOVING INDEX, that is the matrix is filled as flmat(0,0), flmat(0,1) ... C-LIKE. COPIES the array
    
    Parameters:
    
    rows -
    
    cols -
    
    array -
    
    Throws:
    
    EuclidRuntimeException - size of array is not rows*cols
  - RealMatrix
```
public RealMatrix(int r,
                  int c,
                  double f)
```
    creates matrix with initialised values.
    
    Parameters:
    
    r - rows
    
    c - columns
    
    f - value to initialize with
  - RealMatrix
```
public RealMatrix(RealMatrix m,
                  int lowrow,
                  int hirow,
                  int lowcol,
                  int hicol)
           throws EuclidRuntimeException
```
    create from submatrix of another matrix. fails if lowrow > hirow, lowrow < 0, etc COPIES the parts of m
    
    Parameters:
    
    m - the matrix to slice
    
    lowcol - lowest column index
    
    hicol - highest column index
    
    lowrow - lowest row index
    
    hirow - highest row index
    
    Throws:
    
    EuclidRuntimeException - impossible value of hirow, hicol, lowrow, lowcol
  - RealMatrix
```
public RealMatrix(RealMatrix m)
```
    copy constructor. copies matrix including values
    
    Parameters:
    
    m - matrix to copy
  - RealMatrix
```
public RealMatrix(IntMatrix m)
```
    construct from a IntMatrix.
    
    Parameters:
    
    m - matrix to copy (this(i,j) = m(i,j))
  - RealMatrix
```
public RealMatrix(double[][] m)
           throws EuclidRuntimeException
```
    create from a java matrix. must be rectangular copies matrix values (i.e. m can be discarded)
    
    Parameters:
    
    m - natrix to copy from
    
    Throws:
    
    EuclidRuntimeException - m has rows of different lengths
- Method Detail
  - shallowCopy
```
public void shallowCopy(RealMatrix m)
```
    shallow copy constructor. copies references (uses same internal array)
    
    Parameters:
    
    m - matrix to copy
  - getIntMatrix
```
public IntMatrix getIntMatrix()
```
    constructs an IntMatrix. intm(i,j) = (int) this(i,j), i.e.gets nearest integers as matrix.
    
    Returns:
    
    the nearest IntMatrix
  - setFormat
```
public void setFormat(DecimalFormat f)
```
    set output format.
    
    Parameters:
    
    f - the format
  - getFormat
```
public DecimalFormat getFormat()
```
    get output format.
    
    Returns:
    
    the format
  - getRows
```
public int getRows()
```
    get number of rows.
    
    Returns:
    
    number of rows
  - getCols
```
public int getCols()
```
    get number of columns.
    
    Returns:
    
    number of columns
  - getMatrix
```
public double[][] getMatrix()
```
    get matrix as java matrix. shallow copy - any alterations to java matrix will alter this and vice versa.
    
    Returns:
    
    matrix as java matrix
  - getMatrixAsArray
```
public double[] getMatrixAsArray()
```
    get matrix as array.
    
    Returns:
    
    matrix as 1-D array in C order: (m(0,0), m(0,1) ...)
  - isEqualTo
```
public boolean isEqualTo(RealMatrix m)
```
    tests matrices for equality. uses Real.isEqual(double) for tests
    
    Parameters:
    
    m -
    
    Returns:
    
    true if all corresponding elements are equal
  - plus
```
public RealMatrix plus(RealMatrix m2)
                throws EuclidRuntimeException
```
    matrix addition. adds conformable matrices giving NEW matrix. this is unaltered
    
    Parameters:
    
    m2 -
    
    Returns:
    
    new matrix
    
    Throws:
    
    EuclidRuntimeException - m and this are different sizes
  - subtract
```
public RealMatrix subtract(RealMatrix m2)
                    throws EuclidRuntimeException
```
    matrix subtraction. subtracts conformable matrices giving NEW matrix this is unaltered
    
    Parameters:
    
    m2 -
    
    Returns:
    
    new matrix
    
    Throws:
    
    EuclidRuntimeException - m and this are different sizes
  - negative
```
public void negative()
```
    unary minus. negate all elements of matrix; MODIFIES matrix
  - multiply
```
public RealMatrix multiply(RealMatrix m)
                    throws EuclidRuntimeException
```
    matrix multiplication. multiplies conformable matrices to give NEW matrix. this is unaltered result = 'this' * m; (order matters)
    
    Parameters:
    
    m -
    
    Returns:
    
    new matrix
    
    Throws:
    
    EuclidRuntimeException - m and this are different sizes
  - multiplyBy
```
public void multiplyBy(double f)
```
    matrix multiplication by a scalar. creates this(i,j) = f*this(i,j) MODIFIES matrix
    
    Parameters:
    
    f - scalar
  - multiplyEquals
```
public void multiplyEquals(RealMatrix m)
                    throws EuclidRuntimeException
```
    matrix multiplication. multiplies conformable matrices and stores result in this matrix. this = 'this' * m;
    
    Parameters:
    
    m - matrix to multiply by
    
    Throws:
    
    EuclidRuntimeException - m and this are different sizes
  - translateByColumn
```
public void translateByColumn(double[] d)
                       throws EuclidRuntimeException
```
    subtract value from each colum. this[i,j] = this[i,j] - d[i] modifies this
    
    Parameters:
    
    d - array of doubles to subtract
    
    Throws:
    
    EuclidRuntimeException
  - multiply
```
public RealArray multiply(RealArray f)
                   throws EuclidRuntimeException
```
    matrix multiplication of a COLUMN vector. creates new vector
    
    Parameters:
    
    f - vector to multiply
    
    Returns:
    
    transformed array
    
    Throws:
    
    EuclidRuntimeException - f.size() differs from cols
  - columnwiseDivide
```
public void columnwiseDivide(RealArray f)
                      throws EuclidRuntimeException
```
    divide each column of a matrix by a vector of scalars (that is mat[i][j] = mat[i][j] / vect[i] - MODIFIES matrix
    
    Parameters:
    
    f - array to divide by
    
    Throws:
    
    EuclidRuntimeException - f.size() and rows differ
  - elementAt
```
public double elementAt(int row,
                        int col)
                 throws EuclidRuntimeException
```
    extracts a given element.
    
    Parameters:
    
    row -
    
    col -
    
    Returns:
    
    the element at row,col
    
    Throws:
    
    EuclidRuntimeException - bad value of row or column
  - elementAt
```
public double elementAt(Int2 rowcol)
                 throws EuclidRuntimeException
```
    extracts a given element.
    
    Parameters:
    
    rowcol - represents row,col
    
    Returns:
    
    the element at row,col
    
    Throws:
    
    EuclidRuntimeException
  - setElementAt
```
public void setElementAt(int row,
                         int col,
                         double f)
                  throws EuclidRuntimeException
```
    sets a given element MODIFIES matrix
    
    Parameters:
    
    row -
    
    col -
    
    f -
    
    Throws:
    
    EuclidRuntimeException
  - largestElement
```
public double largestElement()
```
    get value of largest element.
    
    Returns:
    
    value of largest element
  - indexOfLargestElement
```
public Int2 indexOfLargestElement()
```
    get index of largest element.
    
    Returns:
    
    (row, col)
  - largestElementInColumn
```
public double largestElementInColumn(int jcol)
                              throws EuclidRuntimeException
```
    get value of largest element in a column
    
    Parameters:
    
    jcol -
    
    Returns:
    
    the value
    
    Throws:
    
    EuclidRuntimeException
  - indexOfLargestElementInColumn
```
public int indexOfLargestElementInColumn(int jcol)
                                  throws EuclidRuntimeException
```
    get index of largest element in column.
    
    Parameters:
    
    jcol - index
    
    Returns:
    
    index (-1 if empty matrix)
    
    Throws:
    
    EuclidRuntimeException - bad value of jcol
  - indexOfLargestElementInRow
```
public int indexOfLargestElementInRow(int irow)
                               throws EuclidRuntimeException
```
    get index of largest element in row.
    
    Parameters:
    
    irow - index
    
    Returns:
    
    index (-1 if empty matrix)
    
    Throws:
    
    EuclidRuntimeException - bad value of irow
  - indexOfSmallestElementInColumn
```
public int indexOfSmallestElementInColumn(int jcol)
                                   throws EuclidRuntimeException
```
    get index of smallest element in column.
    
    Parameters:
    
    jcol - index
    
    Returns:
    
    index (-1 if empty matrix)
    
    Throws:
    
    EuclidRuntimeException - bad value of jcol
  - checkNonEmptyMatrix
```
protected boolean checkNonEmptyMatrix()
```
  - largestElementInRow
```
public double largestElementInRow(int irow)
                           throws EuclidRuntimeException
```
    get value of largest element in a row.
    
    Parameters:
    
    irow -
    
    Returns:
    
    value (0 if no columns)
    
    Throws:
    
    EuclidRuntimeException
  - indexOfSmallestElementInRow
```
public int indexOfSmallestElementInRow(int irow)
                                throws EuclidRuntimeException
```
    get index of smallest element in row.
    
    Parameters:
    
    irow - index
    
    Returns:
    
    index (-1 if empty matrix)
    
    Throws:
    
    EuclidRuntimeException - bad value of irow
  - smallestElement
```
public double smallestElement()
                       throws EuclidRuntimeException
```
    get value of smallest element.
    
    Returns:
    
    value
    
    Throws:
    
    EuclidRuntimeException
  - indexOfSmallestElement
```
public Int2 indexOfSmallestElement()
```
    get index of smallest element.
    
    Returns:
    
    (row,col) or null for empty matrix
  - smallestElementInColumn
```
public double smallestElementInColumn(int jcol)
                               throws EuclidRuntimeException
```
    get smallest element in a column.
    
    Parameters:
    
    jcol -
    
    Returns:
    
    smallest value
    
    Throws:
    
    EuclidRuntimeException - bad value of jcol
  - smallestElementInRow
```
public double smallestElementInRow(int irow)
                            throws EuclidRuntimeException
```
    get smallest element in a row.
    
    Parameters:
    
    irow -
    
    Returns:
    
    smallest value
    
    Throws:
    
    EuclidRuntimeException - bad value of irow
  - isOrthogonal
```
public boolean isOrthogonal()
```
    is matrix Orthogonal row-wise. that is row(i) * row(j) = 0 if i not equals j.
    
    Returns:
    
    true if orthogonal
  - euclideanRowLength
```
public double euclideanRowLength(int i)
                          throws EuclidRuntimeException
```
    get Euclidean length of row.
    
    Parameters:
    
    i - the row
    
    Returns:
    
    length of row
    
    Throws:
    
    EuclidRuntimeException - bad row number
  - euclideanRowLengths
```
public RealArray euclideanRowLengths()
```
    get array of Euclidean row lengths.
    
    Returns:
    
    the array (of dimension cols)
  - euclideanColumnLength
```
public double euclideanColumnLength(int jcol)
                             throws EuclidRuntimeException
```
    get Euclidean length of column.
    
    Parameters:
    
    jcol - the column
    
    Returns:
    
    the length
    
    Throws:
    
    EuclidRuntimeException
  - euclideanColumnLengths
```
public RealArray euclideanColumnLengths()
```
    get array of Euclidean column lengths
    
    Returns:
    
    the array (of dimension rows)
  - extractColumnData
```
public RealArray extractColumnData(int col)
                            throws EuclidRuntimeException
```
    get column data from matrix.
    
    Parameters:
    
    col - the column
    
    Returns:
    
    the column data (or length rows)
    
    Throws:
    
    EuclidRuntimeException - bad index
  - extractRowData
```
public RealArray extractRowData(int row)
                         throws EuclidRuntimeException
```
    get row data from matrix.
    
    Parameters:
    
    row - the column
    
    Returns:
    
    the row data (of length cols)
    
    Throws:
    
    EuclidRuntimeException - bad index
  - clearMatrix
```
public void clearMatrix()
```
    clear matrix.
  - setAllElements
```
public void setAllElements(double f)
```
    initialise matrix to given double.
    
    Parameters:
    
    f -
  - normaliseByRows
```
public void normaliseByRows()
```
    normalise matrix rows to length of unity
  - normaliseByColumns
```
public void normaliseByColumns()
```
    normalise matrix columns to length of unity
  - getTranspose
```
public RealMatrix getTranspose()
```
    transpose matrix - creates new Matrix
    
    Returns:
    
    transpoe
  - isSquare
```
public boolean isSquare()
```
    is the matrix square
    
    Returns:
    
    is square
  - isZero
```
public boolean isZero(double eps)
```
    are all elements of matrix zero?
    
    Parameters:
    
    eps - tolerance
    
    Returns:
    
    true if all elements zero
  - deleteColumn
```
public void deleteColumn(int col)
```
    delete column from matrix and close up. no-op if impermissible value of col
    
    Parameters:
    
    col - the column
  - deleteColumns
```
public void deleteColumns(int low,
                          int high)
```
    delete 2 or more adjacent columns (inclusive) from matrix and close up. no action if impermissible value of low and high
    
    Parameters:
    
    low - start column
    
    high - end column
  - deleteRow
```
public void deleteRow(int row)
```
    delete row from matrix and close up.
    
    Parameters:
    
    row -
  - deleteRows
```
public void deleteRows(int low,
                       int high)
```
    delete 2 or more adjacent rows (inclusive) from matrix and close up. if (high > rows-1 high -> rows-1; or low < 0, low -> 0
    
    Parameters:
    
    low - start row
    
    high - end row
  - replaceColumnData
```
public void replaceColumnData(int column,
                              RealArray f)
                       throws EuclidRuntimeException
```
    replace data in a single column.
    
    Parameters:
    
    column -
    
    f - data must be of length rows
    
    Throws:
    
    EuclidRuntimeException
  - replaceColumnData
```
public void replaceColumnData(int starting_col,
                              double[] f)
                       throws EuclidRuntimeException
```
    replace data in a single column.
    
    Parameters:
    
    starting_col -
    
    f - data must be of length rows
    
    Throws:
    
    EuclidRuntimeException
  - replaceColumnData
```
public void replaceColumnData(int start_column,
                              RealMatrix m)
                       throws EuclidRuntimeException
```
    replace data in a block of columns.
    
    Parameters:
    
    start_column - (gets overwritten)
    
    m - must have same row count and fit into gap
    
    Throws:
    
    EuclidRuntimeException
  - makeSpaceForNewColumns
```
public void makeSpaceForNewColumns(int after_col,
                                   int delta_cols)
```
    insert a hole into the matrix and expand. result is blank space in matrix
    
    Parameters:
    
    after_col -
    
    delta_cols -
  - insertColumnData
```
public void insertColumnData(int after_col,
                             RealArray f)
                      throws EuclidRuntimeException
```
    add data as column or column block into matrix and expand. column is inserted after given column
    
    Parameters:
    
    after_col - -1 to cols-1
    
    f -
    
    Throws:
    
    EuclidRuntimeException
  - insertColumnData
```
public void insertColumnData(int afterCol,
                             RealMatrix m)
                      throws EuclidRuntimeException
```
    add data as column or column block into matrix and expand.
    
    Parameters:
    
    afterCol - -1 to cols-1
    
    m -
    
    Throws:
    
    EuclidRuntimeException
  - insertRows
```
public void insertRows(int after_row,
                       int delta_rows)
```
    make space for new rows in matrix and expand.
    
    Parameters:
    
    after_row - -1 to rows-1
    
    delta_rows - size of space
  - replaceRowData
```
public void replaceRowData(int row,
                           RealArray f)
                    throws EuclidRuntimeException
```
    overwrite existing row of data.
    
    Parameters:
    
    row - to replace
    
    f - row to use
    
    Throws:
    
    EuclidRuntimeException - f.size() and cols differ
  - replaceRowData
```
public void replaceRowData(int row,
                           double[] f)
                    throws EuclidRuntimeException
```
    overwrite existing row of data.
    
    Parameters:
    
    row - to replace
    
    f - row to use
    
    Throws:
    
    EuclidRuntimeException - f.length and cols differ
  - replaceRowData
```
public void replaceRowData(int afterRow,
                           RealMatrix m)
                    throws EuclidRuntimeException
```
    overwrite existing block of rows; if too big, copying is truncated
    
    Parameters:
    
    afterRow - from -1 to rows-1
    
    m - data to replace with
    
    Throws:
    
    EuclidRuntimeException - m.rows and this.rows differ
  - insertRowData
```
public void insertRowData(int afterRow,
                          RealMatrix m)
                   throws EuclidRuntimeException
```
    insert 2 or more adjacent rows of data into matrix and expand
    
    Parameters:
    
    afterRow - from -1 to rows-1
    
    m - data to insert
    
    Throws:
    
    EuclidRuntimeException - m.cols and this.colsdiffer
  - insertRowData
```
public void insertRowData(int after_row,
                          RealArray f)
                   throws EuclidRuntimeException
```
    insert row of data into matrix and expand.
    
    Parameters:
    
    after_row - from -1 to rows-1
    
    f - data to insert
    
    Throws:
    
    EuclidRuntimeException - f.size() and this.cols differ
  - appendColumnData
```
public void appendColumnData(RealArray f)
                      throws EuclidRuntimeException
```
    append data to matrix columnwise.
    
    Parameters:
    
    f - data to append
    
    Throws:
    
    EuclidRuntimeException - f.size() and this.rows differ
  - appendColumnData
```
public void appendColumnData(RealMatrix m)
                      throws EuclidRuntimeException
```
    append data to matrix columnwise.
    
    Parameters:
    
    m - data to append
    
    Throws:
    
    EuclidRuntimeException - m.rows and this.rows differ
  - appendRowData
```
public void appendRowData(RealArray f)
                   throws EuclidRuntimeException
```
    append data to matrix rowwise.
    
    Parameters:
    
    f - data to append
    
    Throws:
    
    EuclidRuntimeException - m.cols and this.cols differ
  - appendRowData
```
public void appendRowData(RealMatrix m)
                   throws EuclidRuntimeException
```
    append data to matrix rowwise.
    
    Parameters:
    
    m - data to append
    
    Throws:
    
    EuclidRuntimeException - m.cols and this.cols differ
  - replaceSubMatrixData
```
public void replaceSubMatrixData(int low_row,
                                 int low_col,
                                 RealMatrix m)
```
    replaces the data in a submatrix. starts at (low_row, low_col) and extends by the dimensions for the matrix m
    
    Parameters:
    
    low_row - starting row
    
    low_col - starting col
    
    m - data to append
  - reorderColumnsBy
```
public RealMatrix reorderColumnsBy(IntSet is)
                            throws EuclidRuntimeException
```
    reorder the columns of a matrix.
    
    Parameters:
    
    is - indexes to reorder by
    
    Returns:
    
    matrix
    
    Throws:
    
    EuclidRuntimeException - is.size() and this.cols differ
  - reorderRowsBy
```
public RealMatrix reorderRowsBy(IntSet is)
                         throws EuclidRuntimeException
```
    reorder the rows of a matrix Deleting rows is allowed
    
    Parameters:
    
    is - indexes to reprder by
    
    Returns:
    
    matrix
    
    Throws:
    
    EuclidRuntimeException - is.size() and this.rows differ
  - extractSubMatrixData
```
public RealMatrix extractSubMatrixData(int low_row,
                                       int high_row,
                                       int low_col,
                                       int high_col)
                                throws EuclidRuntimeException
```
    extract a RealMatrix submatrix from a RealMatrix
    
    Parameters:
    
    low_row - starting row
    
    high_row - end row
    
    low_col - starting col
    
    high_col - end col
    
    Returns:
    
    matrix
    
    Throws:
    
    EuclidRuntimeException - low/high_row/col are outside range of this
  - extractColumns
```
public Real2Array extractColumns(int col1,
                                 int col2)
                          throws EuclidRuntimeException
```
    make an Real2_Array from columns.
    
    Parameters:
    
    col1 -
    
    col2 -
    
    Returns:
    
    2*rows data
    
    Throws:
    
    EuclidRuntimeException - bad values of columns
  - extractRows
```
public Real2Array extractRows(int row1,
                              int row2)
                       throws EuclidRuntimeException
```
    make an Real2_Array from rows.
    
    Parameters:
    
    row1 -
    
    row2 -
    
    Returns:
    
    2*cols data
    
    Throws:
    
    EuclidRuntimeException - bad values of rows
  - elementsInRange
```
public IntMatrix elementsInRange(RealRange r)
                          throws EuclidRuntimeException
```
    produce a mask of those elements which fall in a range. result is matrix with (1) else (0)
    
    Parameters:
    
    r - the range
    
    Returns:
    
    matrix with 1s where data is in range else 0
    
    Throws:
    
    EuclidRuntimeException - bad values of rows
  - format
```
public RealMatrix format(int places)
```
    round to decimal places.
    
    Parameters:
    
    places -
    
    Returns:
    
    this
  - toString
```
public String toString()
```
    output matrix - very crude
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the string
  - writeXML
```
public void writeXML(Writer w)
              throws IOException
```
    output xml as a CML matrix.
    
    Parameters:
    
    w - the writer
    
    Throws:
    
    IOException
  - createMatrixWithOriginShifted
```
public RealMatrix createMatrixWithOriginShifted(double deltax,
                                                double deltay)
```
  - scaleAndInterpolate
```
public RealMatrix scaleAndInterpolate(int newRows,
                                      int newCols)
```

Class RealMatrix

Field Summary

Fields inherited from interface org.xmlcml.euclid.EuclidConstants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

rows

cols

flmat

Constructor Detail

RealMatrix

RealMatrix

RealMatrix

RealMatrix

RealMatrix

RealMatrix

RealMatrix

RealMatrix

Method Detail

shallowCopy

getIntMatrix

setFormat

getFormat

getRows

getCols

getMatrix

getMatrixAsArray

isEqualTo

plus

subtract

negative

multiply

multiplyBy

multiplyEquals

translateByColumn

multiply

columnwiseDivide

elementAt

elementAt

setElementAt

largestElement

indexOfLargestElement

largestElementInColumn

indexOfLargestElementInColumn

indexOfLargestElementInRow

indexOfSmallestElementInColumn

checkNonEmptyMatrix

largestElementInRow

indexOfSmallestElementInRow

smallestElement

indexOfSmallestElement

smallestElementInColumn

smallestElementInRow

isOrthogonal

euclideanRowLength

euclideanRowLengths

euclideanColumnLength

euclideanColumnLengths

extractColumnData

extractRowData

clearMatrix

setAllElements

normaliseByRows

normaliseByColumns

getTranspose

isSquare

isZero

deleteColumn

deleteColumns

deleteRow

deleteRows

replaceColumnData

replaceColumnData

replaceColumnData

makeSpaceForNewColumns

insertColumnData

insertColumnData

insertRows

replaceRowData