com.lobsterman.JavaGrinders

Class Grid

java.lang.Object

com.lobsterman.JavaGrinders.Grid

public class Grid
extends java.lang.Object

provides the interface for obtaining descriptive statistics from continuous variables.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	doWarnings
double[]	itsGrid
double	Origin
float	roundingFactor

Constructor Summary

Constructors

Constructor and Description
Grid() standard constructor for the Grid class with maximum values provided
Grid(double high) standard constructor for the Grid class with maximum values provided
Grid(double low, double high) standard constructor for the Grid class with minimum and maximum values provided
Grid(double lowVal, double highVal, double gridIntSize) standard constructor for the Grid class with minimum and maximum values provided
Grid(double lowVal, double highVal, float roundFac) standard constructor for the Grid class with minimum and maximum values provided
Grid(double lowVal, double highVal, float roundFac, boolean forceLowerZero) standard constructor for the Grid class with minimum and maximum values provided
Grid(double lowVal, double highVal, float roundFac, boolean forceLowerZero, double gridIntSize) standard constructor for the Grid class with minimum and maximum values provided
Grid(double lowVal, double highVal, float roundFac, double gridIntSize) standard constructor for the Grid class with minimum and maximum values provided
Grid(NumberVariable numVar, float roundFac) standard constructor for the Grid class with minimum and maximum values provided

Method Summary

Modifier and Type	Method and Description
boolean	containsZero() returns whether the space contains the zero value
void	fillGrid() fills grid with values
int	getAutoNUnits() automatically finds and sets the number of units in the space
boolean	getDirection() returns the direction of the Axis
double[]	getGrid() returns the grid in the dimension
double	getGridInterval() returns the grid interval for the axis
double	getHigh() returns the high value
double	getLow() returns the low x
int	getNUnits() returns the number of units in the space
double	getOrigin() returns the origin of the dimension
double	getSpace() returns the dimension of the grid space
void	includeZero() returns whether the space contains the zero value
void	multGridIntervals(int multVal) increases the number of grid units by a factor
void	setAutoNUnits() automatically finds and sets the number of units in the space
void	setDirection(boolean Direction) sets the direction of the Axis
void	setGridInterval(double gridInt) sets the grid interval for the axis
void	setNUnits(int Units) sets the number of units in the space
void	setWarnings(boolean warn) controls whether warnings are issued
java.lang.String	toString() returns the Grid as a String
void	updateGrid() updates the grid

Methods inherited from class java.lang.Object

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

Field Detail

Origin

public double Origin

itsGrid

public double[] itsGrid

doWarnings

public boolean doWarnings

roundingFactor

public float roundingFactor

Constructor Detail

Grid

public Grid()

standard constructor for the Grid class with maximum values provided

Grid

public Grid(double high)

standard constructor for the Grid class with maximum values provided

Parameters:

high - coordinate in double precision

Grid

public Grid(double low,
            double high)

standard constructor for the Grid class with minimum and maximum values provided

Parameters:

low - coordinate in double precision

high - coordinate in double precision

Grid

public Grid(double lowVal,
            double highVal,
            float roundFac)

standard constructor for the Grid class with minimum and maximum values provided

Parameters:

lowVal - coordinate in double precision

highVal - coordinate in double precision

roundFac - scale factor for the size of bin dimensions beyond the absolute dataspace

Grid

public Grid(double lowVal,
            double highVal,
            double gridIntSize)

standard constructor for the Grid class with minimum and maximum values provided

Parameters:

lowVal - coordinate in double precision

highVal - coordinate in double precision

gridIntSize - the width of the grid interval

Grid

public Grid(double lowVal,
            double highVal,
            float roundFac,
            boolean forceLowerZero)

standard constructor for the Grid class with minimum and maximum values provided

Parameters:

lowVal - coordinate in double precision

highVal - coordinate in double precision

roundFac - scale the bin dimensions beyond the absolute dataspace

forceLowerZero - start the bin borders at zero?

Grid

public Grid(double lowVal,
            double highVal,
            float roundFac,
            double gridIntSize)

standard constructor for the Grid class with minimum and maximum values provided

Parameters:

lowVal - coordinate in double precision

highVal - coordinate in double precision

roundFac - scale the bin dimensions beyond the absolute dataspace

gridIntSize - the width of the grid interval

Grid

public Grid(NumberVariable numVar,
            float roundFac)
     throws java.lang.Exception

standard constructor for the Grid class with minimum and maximum values provided

Parameters:

numVar - the NumberVariable to use

roundFac - scale the bin dimensions beyond the absolute data space

Throws:

java.lang.Exception

Grid

public Grid(double lowVal,
            double highVal,
            float roundFac,
            boolean forceLowerZero,
            double gridIntSize)

standard constructor for the Grid class with minimum and maximum values provided

Parameters:

lowVal - coordinate in double precision

highVal - coordinate in double precision

roundFac - scale the bin dimensions beyond the absolute dataspace

forceLowerZero - start the bin borders at zero?

gridIntSize - extent of each grid unit

Method Detail

setWarnings

public void setWarnings(boolean warn)

controls whether warnings are issued

setAutoNUnits

public void setAutoNUnits()
                   throws java.lang.Exception

automatically finds and sets the number of units in the space

Throws:

java.lang.Exception

getAutoNUnits

public int getAutoNUnits()
                  throws java.lang.Exception

automatically finds and sets the number of units in the space

Throws:

java.lang.Exception

setNUnits

public void setNUnits(int Units)
               throws java.lang.Exception

sets the number of units in the space

Parameters:

Units - the number of grid units in the dimension

Throws:

java.lang.Exception

updateGrid

public void updateGrid()

updates the grid

getNUnits

public int getNUnits()

returns the number of units in the space

getOrigin

public double getOrigin()

returns the origin of the dimension

fillGrid

public void fillGrid()

fills grid with values

containsZero

public boolean containsZero()

returns whether the space contains the zero value

includeZero

public void includeZero()

returns whether the space contains the zero value

getDirection

public boolean getDirection()

returns the direction of the Axis

setDirection

public void setDirection(boolean Direction)

sets the direction of the Axis

Parameters:

Direction - the direction of the axis

getSpace

public double getSpace()

returns the dimension of the grid space

getLow

public double getLow()

returns the low x

getHigh

public double getHigh()

returns the high value

setGridInterval

public void setGridInterval(double gridInt)
                     throws java.lang.Exception

sets the grid interval for the axis

Parameters:

gridInt - the grid interval for the axis

Throws:

java.lang.Exception

getGridInterval

public double getGridInterval()

returns the grid interval for the axis

getGrid

public double[] getGrid()

returns the grid in the dimension

multGridIntervals

public void multGridIntervals(int multVal)

increases the number of grid units by a factor

toString

public java.lang.String toString()

returns the Grid as a String

Overrides:

toString in class java.lang.Object