Module platform

Class MatrixSeries

java.lang.Object
org.jfree.data.general.Series
org.jfree.data.xy.MatrixSeries
All Implemented Interfaces:
Serializable, Cloneable
Direct Known Subclasses:
NormalizedMatrixSeries

public class MatrixSeries extends Series implements Serializable
Represents a dense matrix M[i,j] where each Mij item of the matrix has a value (default is 0).
See Also:
  • Field Details

    • data

      protected double[][] data
      Series matrix values
  • Constructor Details

    • MatrixSeries

      public MatrixSeries(String name, int rows, int columns)
      Constructs a new matrix series.

      By default, all matrix items are initialzed to 0.

      Parameters:
      name - series name (null not permitted).
      rows - the number of rows.
      columns - the number of columns.
  • Method Details

    • getColumnsCount

      public int getColumnsCount()
      Returns the number of columns in this matrix series.
      Returns:
      The number of columns in this matrix series.
    • getItem

      public Number getItem(int itemIndex)
      Return the matrix item at the specified index. Note that this method creates a new double instance every time it is called.
      Parameters:
      itemIndex - item index.
      Returns:
      The matrix item at the specified index.
      See Also:
    • getItemColumn

      public int getItemColumn(int itemIndex)
      Returns the column of the specified item.
      Parameters:
      itemIndex - the index of the item.
      Returns:
      The column of the specified item.
    • getItemCount

      public int getItemCount()
      Returns the number of items in the series.
      Specified by:
      getItemCount in class Series
      Returns:
      The item count.
    • getItemRow

      public int getItemRow(int itemIndex)
      Returns the row of the specified item.
      Parameters:
      itemIndex - the index of the item.
      Returns:
      The row of the specified item.
    • getRowCount

      public int getRowCount()
      Returns the number of rows in this matrix series.
      Returns:
      The number of rows in this matrix series.
    • get

      public double get(int i, int j)
      Returns the value of the specified item in this matrix series.
      Parameters:
      i - the row of the item.
      j - the column of the item.
      Returns:
      The value of the specified item in this matrix series.
      See Also:
    • update

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

      public void zeroAll()
      Sets all matrix values to zero and sends a SeriesChangeEvent to all registered listeners.
    • equals

      public boolean equals(Object obj)
      Tests this object instance for equality with an arbitrary object.
      Overrides:
      equals in class Series
      Parameters:
      obj - the object (null permitted).
      Returns:
      A boolean.