Class NormalizedMatrixSeries

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable

    public class NormalizedMatrixSeries
    extends MatrixSeries
    Represents a dense normalized matrix M[i,j] where each Mij item of the matrix has a value (default is 0). When a matrix item is observed using getItem() method, it is normalized, that is, divided by the total sum of all items. It can be also be scaled by setting a scale factor.
    See Also:
    Serialized Form
    • Field Detail

      • DEFAULT_SCALE_FACTOR

        public static final double DEFAULT_SCALE_FACTOR
        The default scale factor.
        See Also:
        Constant Field Values
      • m_scaleFactor

        private double m_scaleFactor
        A factor that multiplies each item in this series when observed using getItem method.
      • m_totalSum

        private double m_totalSum
        The sum of all items in this matrix
    • Constructor Detail

      • NormalizedMatrixSeries

        public NormalizedMatrixSeries​(java.lang.String name,
                                      int rows,
                                      int columns)
        Constructor for NormalizedMatrixSeries.
        Parameters:
        name - the series name.
        rows - the number of rows.
        columns - the number of columns.
    • Method Detail

      • setScaleFactor

        public void setScaleFactor​(double factor)
        Sets the factor that multiplies each item in this series when observed using getItem mehtod.
        Parameters:
        factor - new factor to set.
        See Also:
        DEFAULT_SCALE_FACTOR
      • getScaleFactor

        public double getScaleFactor()
        Returns the factor that multiplies each item in this series when observed using getItem mehtod.
        Returns:
        The factor
      • update

        public void update​(int i,
                           int j,
                           double mij)
        Updates the value of the specified item in this matrix series.
        Overrides:
        update in class MatrixSeries
        Parameters:
        i - the row of the item.
        j - the column of the item.
        mij - the new value for the item.
        See Also:
        MatrixSeries.get(int, int)