Package microsim.space

Class IntSpace

java.lang.Object
microsim.space.AbstractSpace<Integer>
microsim.space.IntSpace
public class IntSpace extends AbstractSpace<Integer>
A bi-dimensional grid containing integer values.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected int[]
    m
     

    Fields inherited from class microsim.space.AbstractSpace

    modCount, xSize, ySize

  • Constructor Summary

    Constructors
    Constructor
    Description
    IntSpace(int xSize, int ySize)
    Create a grid of given size.
    IntSpace(@NonNull IntSpace grid)
    Create a copy of the given grid.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    add(int arg)
    Sum the given value to the value of each cell.
    protected int
    at(int x, int y)
     
    void
    clear()
    Set all cells to 0 value.
    void
    copyGridTo(int @NonNull [] dm)
    Copies the int[] matrix content in this grid.
    void
    copyGridTo(@NonNull IntSpace dm)
    Copies the given IntGrid content in this grid.
    int
    countObjectsAt(int x, int y)
    Return the value contained by the given cell.
    @NonNull Integer
    get(int x, int y)
    Return an Integer object containing the value at given position.
    int
    getInt(int x, int y)
    Return the value at given position.
    int @NonNull []
    getMatrix()
    Return the matrix of values representing the grid.
    int
    max()
    Get the maximum value stored into the grid.
    double
    mean()
    Compute the sample mean value of the values stored in the grid.
    int
    min()
    Get the minimum value stored into the grid.
    void
    multiply(int arg)
    Multiply the given value to the value of each cell.
    void
    randomPopulate(double splitProbability, int probableValue, int defaultValue)
     
    void
    resetTo(int initValue)
    Set all cells to the given value.
    void
    set(int x, int y, @Nullable Object obj)
    Set the given value at given position.
    void
    setInt(int x, int y, int value)
    Set the given value at given position.
    int
    size()
    Return the size of the grid that is width * height.
    int
    sum()
    Sum the value of each cell.
    void
    swapPositions(int x1, int y1, int x2, int y2)
    Swap the content of the (x1,y1) and (x2,y2) cells of the grid.
    double
    variance()
    Compute the sample variance value of the values stored in the grid.

    Methods inherited from class microsim.space.AbstractSpace

    boundX, boundY, equals, getMooreNeighborsPositions, getVonNeumannNeighborsPositions, reflectX, reflectY, torusX, torusY, toString

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Field Details

    • m

      protected int[] m

  • Constructor Details

    • IntSpace

      public IntSpace(int xSize, int ySize)
      Create a grid of given size.
      Parameters:
      xSize - The width of the grid.
      ySize - The height of the grid.

    • IntSpace

      public IntSpace(@NonNull @NonNull IntSpace grid)
      Create a copy of the given grid.
      Parameters:
      grid - The source grid.

  • Method Details

    • at

      protected int at(int x, int y)

    • randomPopulate

      public void randomPopulate(double splitProbability, int probableValue, int defaultValue)

    • get

      @NonNull public @NonNull Integer get(int x, int y)
      Return an Integer object containing the value at given position.
      Specified by:
      get in class AbstractSpace<Integer>
      Parameters:
      x - The x coordinate.
      y - The y coordinate.
      Returns:
      The Integer wrapper for value stored at x,y position of the grid.

    • getInt

      public int getInt(int x, int y)
      Return the value at given position.
      Parameters:
      x - The x coordinate.
      y - The y coordinate.
      Returns:
      The value stored at x,y position of the grid.

    • set

      public void set(int x, int y, @Nullable @Nullable Object obj)
      Set the given value at given position.
      Specified by:
      set in class AbstractSpace<Integer>
      Parameters:
      x - The x coordinate. WARNING: No bounds checking for fast access.
      y - The y coordinate. WARNING: No bounds checking for fast access.
      obj - An object wrapper for a number class. It is possible to pass Integer, Double, or Long values.

    • swapPositions

      public void swapPositions(int x1, int y1, int x2, int y2)
      Swap the content of the (x1,y1) and (x2,y2) cells of the grid.
      Specified by:
      swapPositions in class AbstractSpace<Integer>
      Parameters:
      x1 - The x coordinate for the first cell.
      y1 - The y coordinate for the first cell.
      x2 - The x coordinate for the second cell.
      y2 - The y coordinate for the second cell.

    • setInt

      public void setInt(int x, int y, int value)
      Set the given value at given position.
      Parameters:
      x - The x coordinate. WARNING: No bounds checking for fast access.
      y - The y coordinate. WARNING: No bounds checking for fast access.
      value - An integer value to put at x,y position.

    • size

      public int size()
      Return the size of the grid that is width * height.
      Specified by:
      size in class AbstractSpace<Integer>
      Returns:
      The number of cells in the grid.

    • clear

      public void clear()
      Set all cells to 0 value.
      Specified by:
      clear in class AbstractSpace<Integer>

    • resetTo

      public void resetTo(int initValue)
      Set all cells to the given value.
      Parameters:
      initValue - The value to put into each cell.

    • add

      public void add(int arg)
      Sum the given value to the value of each cell.
      Parameters:
      arg - The value to be added.

    • multiply

      public void multiply(int arg)
      Multiply the given value to the value of each cell.
      Parameters:
      arg - The value to be multiplied.

    • min

      public int min()
      Get the minimum value stored into the grid.
      Returns:
      The minimum value of the grid.

    • max

      public int max()
      Get the maximum value stored into the grid.
      Returns:
      The maximum value of the grid.

    • sum

      public int sum()
      Sum the value of each cell.
      Returns:
      The sum the value of each cell.

    • mean

      public double mean()
      Compute the sample mean value of the values stored in the grid.
      Returns:
      The mean value.

    • variance

      public double variance()
      Compute the sample variance value of the values stored in the grid.
      Returns:
      The variance value.

    • getMatrix

      public int @NonNull [] getMatrix()
      Return the matrix of values representing the grid.
      Returns:
      A matrix of integer with the same dimensions of the grid.

    • copyGridTo

      public void copyGridTo(@NonNull @NonNull IntSpace dm)
      Copies the given IntGrid content in this grid.
      Parameters:
      dm - The source IntGrid to be copied.

    • copyGridTo

      public void copyGridTo(int @NonNull [] dm)
      Copies the int[] matrix content in this grid.
      Parameters:
      dm - The source matrix to be copied.

    • countObjectsAt

      public int countObjectsAt(int x, int y)
      Return the value contained by the given cell.
      Specified by:
      countObjectsAt in class AbstractSpace<Integer>
      Parameters:
      x - The x coordinate.
      y - The y coordinate.
      Returns:
      The int value contained by the (x,y) cell.