magpie.data.utilities.generators

Class GridBaseEntryGenerator

java.lang.Object

magpie.data.utilities.generators.BaseEntryGenerator

magpie.data.utilities.generators.GridBaseEntryGenerator

All Implemented Interfaces:

java.lang.Iterable<BaseEntry>, Options

public class GridBaseEntryGenerator
extends BaseEntryGenerator

Generate BaseEntry objects that represent a grid. User defines the dimension of grid, maximum value, minimum value, and grid spacing.

Usage: <dimension> <min> <step> <step>
dimension: Number of dimensions in grid
min: Minimum value in each direction
step: Distance in each direction between points
max: Maximum value in each direction

Constructor Summary

Constructors

Constructor and Description
GridBaseEntryGenerator()

Method Summary

Modifier and Type	Method and Description
java.util.Iterator<BaseEntry>	iterator()
java.lang.String	printUsage() Print out required format for options.
void	setDimension(int dimension) Define dimension of grid.
void	setGridSpacing(double gridSpacing) Define grid step size.
void	setMaxValue(double maxValue) Define maximum value in all directions
void	setMinValue(double minValue) Define minimum value in all directions.
void	setOptions(java.util.List<java.lang.Object> Options) Set any options for this object.

Methods inherited from class magpie.data.utilities.generators.BaseEntryGenerator

addEntriesToDataset, generateEntries, train

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

GridBaseEntryGenerator

public GridBaseEntryGenerator()

Method Detail

setDimension

public void setDimension(int dimension)

Define dimension of grid.

Parameters:

dimension - Desired dimension

setMinValue

public void setMinValue(double minValue)

Define minimum value in all directions.

Parameters:

minValue - Desired minimum value

setGridSpacing

public void setGridSpacing(double gridSpacing)

Define grid step size.

Parameters:

gridSpacing - Desired step size

setMaxValue

public void setMaxValue(double maxValue)

Define maximum value in all directions

Parameters:

maxValue - Desired maximum value

setOptions

public void setOptions(java.util.List<java.lang.Object> Options)
                throws java.lang.Exception

Description copied from interface: Options

Set any options for this object. If parsing the options fails, return an Exception with the usage as its message.

Parameters:

Options - Array of options as Objects - can be null

Throws:

java.lang.Exception - if problem with inputs

printUsage

public java.lang.String printUsage()

Description copied from interface: Options

Print out required format for options. For consistency, should start with "Usage: ".

Returns:

Usage for this function

iterator

public java.util.Iterator<BaseEntry> iterator()