Documentation of 'cern.colt.matrix.tint.impl.DiagonalIntMatrix2D' Java class
DiagonalIntMatrix2D
Skip navigation links
cern.colt.matrix.tint.impl

Class DiagonalIntMatrix2D

    • Constructor Detail

      • DiagonalIntMatrix2D

        public DiagonalIntMatrix2D(int[][] values,
                           int dindex)
        Constructs a matrix with a copy of the given values. values is required to have the form values[row][column] and have exactly the same number of columns in every row. Only the values on the main diagonal, i.e. values[i][i] are used.

        The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.

        Parameters:
        values - The values to be filled into the new matrix.
        dindex - index of the diagonal.
        Throws:
        java.lang.IllegalArgumentException - if for any 1 <= row < values.length: values[row].length != values[row-1].length || index < -rows+1 || index > columns - 1 .

      • DiagonalIntMatrix2D

        public DiagonalIntMatrix2D(int rows,
                           int columns,
                           int dindex)
        Constructs a matrix with a given number of rows and columns. All entries are initially 0.
        Parameters:
        rows - the number of rows the matrix shall have.
        columns - the number of columns the matrix shall have.
        dindex - index of the diagonal.
        Throws:
        java.lang.IllegalArgumentException - if size<0 (int)size > Integer.MAX_VALUE.

    • Method Detail

      • assign

        public IntMatrix2D assign(IntFunction function)
        Description copied from class: IntMatrix2D
        Assigns the result of a function to each cell; x[row,col] = function(x[row,col]).

        Example: 

           matrix = 2 x 2 matrix 
   0.5 1.5      
   2.5 3.5
 
   // change each cell to its sine
   matrix.assign(cern.jet.math.Functions.sin);
   -->
   2 x 2 matrix
   0.479426  0.997495 
   0.598472 -0.350783
        For further examples, see the package doc.
        Overrides:
        assign in class IntMatrix2D
        Parameters:
        function - a function object taking as argument the current cell's value.
        Returns:
        this (for convenience only).
        See Also:
        IntFunctions

      • assign

        public IntMatrix2D assign(int value)
        Description copied from class: IntMatrix2D
        Sets all cells to the state specified by value.
        Overrides:
        assign in class IntMatrix2D
        Parameters:
        value - the value to be filled into the cells.
        Returns:
        this (for convenience only).

      • assign

        public IntMatrix2D assign(int[] values)
        Description copied from class: IntMatrix2D
        Sets all cells to the state specified by values. values is required to have the form values[row*column] and elements have to be stored in a row-wise order.

        The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.

        Overrides:
        assign in class WrapperIntMatrix2D
        Parameters:
        values - the values to be filled into the cells.
        Returns:
        this (for convenience only).

      • assign

        public IntMatrix2D assign(int[][] values)
        Description copied from class: IntMatrix2D
        Sets all cells to the state specified by values. values is required to have the form values[row][column] and have exactly the same number of rows and columns as the receiver.

        The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.

        Overrides:
        assign in class IntMatrix2D
        Parameters:
        values - the values to be filled into the cells.
        Returns:
        this (for convenience only).

      • assign

        public IntMatrix2D assign(IntMatrix2D source)
        Description copied from class: IntMatrix2D
        Replaces all cell values of the receiver with the values of another matrix. Both matrices must have the same number of rows and columns. If both matrices share the same cells (as is the case if they are views derived from the same matrix) and intersect in an ambiguous way, then replaces as if using an intermediate auxiliary deep copy of other.
        Overrides:
        assign in class IntMatrix2D
        Parameters:
        source - the source matrix to copy from (may be identical to the receiver).
        Returns:
        this (for convenience only).

      • assign

        public IntMatrix2D assign(IntMatrix2D y,
                          IntIntFunction function)
        Description copied from class: IntMatrix2D
        Assigns the result of a function to each cell; x[row,col] = function(x[row,col],y[row,col]).

        Example: 

           // assign x[row,col] = x[row,col]<sup>y[row,col]</sup>
   m1 = 2 x 2 matrix 
   0 1 
   2 3
 
   m2 = 2 x 2 matrix 
   0 2 
   4 6
 
   m1.assign(m2, cern.jet.math.Functions.pow);
   -->
   m1 == 2 x 2 matrix
   1   1 
   16 729
        For further examples, see the package doc.
        Overrides:
        assign in class WrapperIntMatrix2D
        Parameters:
        y - the secondary matrix to operate on.
        function - a function object taking as first argument the current cell's value of this, and as second argument the current cell's value of y,
        Returns:
        this (for convenience only).
        See Also:
        IntFunctions

      • cardinality

        public int cardinality()
        Description copied from class: IntMatrix2D
        Returns the number of cells having non-zero values; ignores tolerance.
        Overrides:
        cardinality in class IntMatrix2D
        Returns:
        cardinality

      • elements

        public int[] elements()
        Description copied from class: IntMatrix2D
        Returns the elements of this matrix.
        Overrides:
        elements in class WrapperIntMatrix2D
        Returns:
        the elements

      • equals

        public boolean equals(int value)
        Description copied from class: IntMatrix2D
        Returns whether all cells are equal to the given value.
        Overrides:
        equals in class WrapperIntMatrix2D
        Parameters:
        value - the value to test against.
        Returns:
        true if all cells are equal to the given value, false otherwise.

      • equals

        public boolean equals(java.lang.Object obj)
        Description copied from class: IntMatrix2D
        Compares this object against the specified object. The result is true if and only if the argument is not null and is at least a IntMatrix2D object that has the same number of columns and rows as the receiver and has exactly the same values at the same coordinates.
        Overrides:
        equals in class WrapperIntMatrix2D
        Parameters:
        obj - the object to compare with.
        Returns:
        true if the objects are the same; false otherwise.

      • forEachNonZero

        public IntMatrix2D forEachNonZero(IntIntIntFunction function)
        Description copied from class: IntMatrix2D
        Assigns the result of a function to each non-zero cell; x[row,col] = function(x[row,col]). Use this method for fast special-purpose iteration. If you want to modify another matrix instead of this (i.e. work in read-only mode), simply return the input value unchanged. Parameters to function are as follows: first==row, second==column, third==nonZeroValue.
        Overrides:
        forEachNonZero in class IntMatrix2D
        Parameters:
        function - a function object taking as argument the current non-zero cell's row, column and value.
        Returns:
        this (for convenience only).

      • diagonalLength

        public int diagonalLength()
        Returns the length of the diagonal
        Returns:
        the length of the diagonal

      • diagonalIndex

        public int diagonalIndex()
        Returns the index of the diagonal
        Returns:
        the index of the diagonal

      • getMaxLocation

        public int[] getMaxLocation()
        Description copied from class: IntMatrix2D
        Return the maximum value of this matrix together with its location
        Overrides:
        getMaxLocation in class IntMatrix2D
        Returns:
        maximum_value, row_location, column_location };

      • getMinLocation

        public int[] getMinLocation()
        Description copied from class: IntMatrix2D
        Return the minimum value of this matrix together with its location
        Overrides:
        getMinLocation in class IntMatrix2D
        Returns:
        minimum_value, row_location, column_location};

      • getQuick

        public int getQuick(int row,
                    int column)
        Description copied from class: IntMatrix2D
        Returns the matrix cell value at coordinate [row,column].

        Provided with invalid parameters this method may return invalid objects without throwing any exception. You should only use this method when you are absolutely sure that the coordinate is within bounds. Precondition (unchecked): 0 <= column < columns() && 0 <= row < rows().

        Overrides:
        getQuick in class WrapperIntMatrix2D
        Parameters:
        row - the index of the row-coordinate.
        column - the index of the column-coordinate.
        Returns:
        the value at the specified coordinate.

      • like

        public IntMatrix2D like(int rows,
                        int columns)
        Description copied from class: IntMatrix2D
        Construct and returns a new empty matrix of the same dynamic type as the receiver, having the specified number of rows and columns. For example, if the receiver is an instance of type DenseIntMatrix2D the new matrix must also be of type DenseIntMatrix2D, if the receiver is an instance of type SparseIntMatrix2D the new matrix must also be of type SparseIntMatrix2D, etc. In general, the new matrix should have internal parametrization as similar as possible.
        Overrides:
        like in class WrapperIntMatrix2D
        Parameters:
        rows - the number of rows the matrix shall have.
        columns - the number of columns the matrix shall have.
        Returns:
        a new empty matrix of the same dynamic type.

      • like1D

        public IntMatrix1D like1D(int size)
        Description copied from class: IntMatrix2D
        Construct and returns a new 1-d matrix of the corresponding dynamic type, entirelly independent of the receiver. For example, if the receiver is an instance of type DenseIntMatrix2D the new matrix must be of type DenseIntMatrix1D, if the receiver is an instance of type SparseIntMatrix2D the new matrix must be of type SparseIntMatrix1D, etc.
        Overrides:
        like1D in class WrapperIntMatrix2D
        Parameters:
        size - the number of cells the matrix shall have.
        Returns:
        a new matrix of the corresponding dynamic type.

      • setQuick

        public void setQuick(int row,
                     int column,
                     int value)
        Description copied from class: IntMatrix2D
        Sets the matrix cell at coordinate [row,column] to the specified value.

        Provided with invalid parameters this method may access illegal indexes without throwing any exception. You should only use this method when you are absolutely sure that the coordinate is within bounds. Precondition (unchecked): 0 <= column < columns() && 0 <= row < rows().

        Overrides:
        setQuick in class WrapperIntMatrix2D
        Parameters:
        row - the index of the row-coordinate.
        column - the index of the column-coordinate.
        value - the value to be filled into the specified cell.

      • zMult

        public IntMatrix1D zMult(IntMatrix1D y,
                         IntMatrix1D z,
                         int alpha,
                         int beta,
                         boolean transposeA)
        Description copied from class: IntMatrix2D
        Linear algebraic matrix-vector multiplication; z = alpha * A * y + beta*z. z[i] = alpha*Sum(A[i,j] * y[j]) + beta*z[i], i=0..A.rows()-1, j=0..y.size()-1 . Where A == this.
        Note: Matrix shape conformance is checked after potential transpositions.
        Overrides:
        zMult in class IntMatrix2D
        Parameters:
        y - the source vector.
        z - the vector where results are to be stored. Set this parameter to null to indicate that a new result vector shall be constructed.
        Returns:
        z (for convenience only).
Skip navigation links

DMelt 3.0 © DataMelt by jWork.ORG

You see the box below because you did not login.