Package microsim.space

Class DoubleSpace

java.lang.Object
microsim.space.AbstractSpace<Double>
microsim.space.DoubleSpace
Direct Known Subclasses:
DoubleDiffuseSpace
public class DoubleSpace extends AbstractSpace<Double>
A bidimensional grid containing double values.

Title: JAS

Description: Java Agent-based Simulation library

Copyright (C) 2002 Michele Sonnessa

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
Author:
Michele Sonnessa

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected double[]
    m
     

    Fields inherited from class microsim.space.AbstractSpace

    modCount, xSize, ySize

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    add(double 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.0 value.
    void
    copyGridTo(double[] dm)
    Copies the double[] matrix content in this grid.
    void
    copyGridTo(DoubleSpace dm)
    Copies the given DblGrid content in this grid.
    int
    countObjectsAt(int x, int y)
    Returns the number of objects allocated in cell (x,y).
    Double
    get(int x, int y)
    Return a Double object containing the value at given position.
    double
    getDbl(int x, int y)
    Return the value at given position.
    double[]
    getMatrix()
    Return the matrix of values representing the grid.
    double
    max()
    Get the maximum value stored into the grid.
    double
    mean()
    Compute the sample mean value of the values stored in the grid.
    double
    min()
    Get the minimum value stored into the grid.
    void
    multiply(double arg)
    Multiply the given value to the value of each cell.
    void
    resetTo(double initValue)
    Set all cells to the given value.
    void
    set(int x, int y, Object obj)
    Set the given value at given position.
    void
    setDbl(int x, int y, double value)
    Set the given value at given position.
    int
    size()
    Return the size of the grid.
    double
    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, getXSize, getYSize, 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 double[] m

  • Constructor Details

    • DoubleSpace

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

    • DoubleSpace

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

  • Method Details

    • at

      protected int at(int x, int y)

    • get

      public Double get(int x, int y)
      Return a Double object containing the value at given position.
      Specified by:
      get in class AbstractSpace<Double>
      Parameters:
      x - The x coordinate. WARNING: No bounds checking for fast access.
      y - The y coordinate. WARNING: No bounds checking for fast access.
      Returns:
      The Double wrapper for value stored at x,y position of the grid.

    • getDbl

      public double getDbl(int x, int y)
      Return the 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.
      Returns:
      The value stored at x,y position of the grid.

    • set

      public void set(int x, int y, Object obj)
      Set the given value at given position.
      Specified by:
      set in class AbstractSpace<Double>
      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 Interger, Double, Float 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<Double>
      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.

    • setDbl

      public void setDbl(int x, int y, double 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 - A double value to put at x,y position.

    • size

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

    • clear

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

    • resetTo

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

    • add

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

    • multiply

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

    • min

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

    • max

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

    • sum

      public double 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 double[] getMatrix()
      Return the matrix of values representing the grid.
      Returns:
      A matrix of double with the same dimensions of the grid.

    • copyGridTo

      public void copyGridTo(DoubleSpace dm)
      Copies the given DblGrid content in this grid.
      Parameters:
      dm - The source DblGrid to be copied.

    • copyGridTo

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

    • countObjectsAt

      public int countObjectsAt(int x, int y)
      Description copied from class: AbstractSpace
      Returns the number of objects allocated in cell (x,y).
      Specified by:
      countObjectsAt in class AbstractSpace<Double>
      Parameters:
      x - The x coordinate.
      y - The y coordinate.
      Returns:
      the number of "entities" contained in the specified cell. See specific semantic in API of each extending class.