Package repast.simphony.context.space.graph

Class AdjacencyDoubleMatrix

  • All Implemented Interfaces:
    AdjacencyMatrix
    public class AdjacencyDoubleMatrix
extends Object
implements AdjacencyMatrix
    A network adjacency matrix that stores its values as doubles.
    Author:
    Nick Collier

    • Constructor Summary

      Constructors 
      Constructor Description
      AdjacencyDoubleMatrix​(double[][] m)
      Constructs an AdjacencyMatrix from the specified two dimensional double array.
      AdjacencyDoubleMatrix​(int rows, int cols)
      Constructs an AdjacencyMatrix with the specified number of rows and columns.
      AdjacencyDoubleMatrix​(cern.colt.matrix.impl.DenseDoubleMatrix2D m)
      Constructs an AdjacencyMatrix from the specified DenseDoubleMatrix2D
      AdjacencyDoubleMatrix​(List<String> labels)
      Constructs an AdjacencyMatrix with the specified row/col labels.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int columns()
      Returns the number of columns in the matrix.
      double get​(int row, int col)
      Gets the value at row, col.
      List<String> getLabels()
      Gets the node labels, if any, for this matrix.
      String getMatrixLabel()
      Gets the label for this matrix.
      cern.colt.matrix.impl.DenseDoubleMatrix1D getRow​(int row)
      Gets the specified row of data for this matrix.
      String matrixToString()
      Returns a String representation of only the actual data matrix.
      int rows()
      Returns the number of rows int matrix.
      void set​(int row, int col, double val)
      Sets a data value in this matrix.
      void setMatrix​(double[][] m)
      Sets the actual matrix for this AdjacencyMatrix.
      void setMatrix​(cern.colt.matrix.impl.DenseDoubleMatrix2D m)
      Sets the actual matrix for this AdjacencyMatrix.
      void setMatrixLabel​(String label)
      Sets the matrix label.
      String toString()
      Returns a String representation of this AdjacencyMatrix (comment etc.) together with the actual data matrix.

    • Constructor Detail

      • AdjacencyDoubleMatrix

        public AdjacencyDoubleMatrix​(int rows,
                             int cols)
        Constructs an AdjacencyMatrix with the specified number of rows and columns. The intial state of every ij is 0.
        Parameters:
        rows - the number of rows in the matrix
        cols - the number of cols in the matrix

      • AdjacencyDoubleMatrix

        public AdjacencyDoubleMatrix​(List<String> labels)
        Constructs an AdjacencyMatrix with the specified row/col labels. The matrix row and column size are set equal to the size of the lables vector.
        Parameters:
        labels - the row & column labels

      • AdjacencyDoubleMatrix

        public AdjacencyDoubleMatrix​(cern.colt.matrix.impl.DenseDoubleMatrix2D m)
        Constructs an AdjacencyMatrix from the specified DenseDoubleMatrix2D
        Parameters:
        m - the DenseDoubleMatrix2D to construct this AdjacencyMatrix from

      • AdjacencyDoubleMatrix

        public AdjacencyDoubleMatrix​(double[][] m)
        Constructs an AdjacencyMatrix from the specified two dimensional double array.
        Parameters:
        m - the 2D double array to construct this AdjacencyMatrix from.

    • Method Detail

      • setMatrix

        public void setMatrix​(cern.colt.matrix.impl.DenseDoubleMatrix2D m)
        Sets the actual matrix for this AdjacencyMatrix.
        Parameters:
        m - the actual matrix data for this AdjacencyMatrix

      • setMatrix

        public void setMatrix​(double[][] m)
        Sets the actual matrix for this AdjacencyMatrix.
        Parameters:
        m - the actual matrix data for this AdjacencyMatrix

      • getRow

        public cern.colt.matrix.impl.DenseDoubleMatrix1D getRow​(int row)
        Gets the specified row of data for this matrix.
        Specified by:
        getRow in interface AdjacencyMatrix
        Parameters:
        row - the index of the row to get
        Returns:
        the specified row of data for this matrix.

      • set

        public void set​(int row,
                int col,
                double val)
        Sets a data value in this matrix.
        Parameters:
        row - the row index (i)
        col - the col index (j)
        val - the value to set ij to.

      • get

        public double get​(int row,
                  int col)
        Gets the value at row, col.
        Specified by:
        get in interface AdjacencyMatrix
        Parameters:
        row - the row index (i)
        col - the col index (j)
        Returns:
        the double value at row, col (ij)

      • rows

        public int rows()
        Returns the number of rows int matrix.
        Specified by:
        rows in interface AdjacencyMatrix
        Returns:
        the row count

      • columns

        public int columns()
        Returns the number of columns in the matrix.
        Specified by:
        columns in interface AdjacencyMatrix
        Returns:
        the column count

      • matrixToString

        public String matrixToString()
        Returns a String representation of only the actual data matrix.
        Specified by:
        matrixToString in interface AdjacencyMatrix
        Returns:
        a String representation of only the actual data matrix.

      • toString

        public String toString()
        Returns a String representation of this AdjacencyMatrix (comment etc.) together with the actual data matrix.
        Overrides:
        toString in class Object

      • getLabels

        public List<String> getLabels()
        Gets the node labels, if any, for this matrix.
        Specified by:
        getLabels in interface AdjacencyMatrix
        Returns:
        the node labels, if any, for this matrix.

      • getMatrixLabel

        public String getMatrixLabel()
        Gets the label for this matrix.
        Specified by:
        getMatrixLabel in interface AdjacencyMatrix
        Returns:
        the label for this matrix.

      • setMatrixLabel

        public void setMatrixLabel​(String label)
        Sets the matrix label.
        Parameters:
        label - the matrix label