Package es.upm.etsisi.cf4j.util.optimization

Class ParamsGrid

java.lang.Object

es.upm.etsisi.cf4j.util.optimization.ParamsGrid

public class ParamsGrid
extends Object

This class generates the development set for a grid search. You can add two kind of params:

• Fixed params: They take the same value in all entries of the development set.
• Params: Development set is generated with all the permutations defined by params valid values.

The development set is generated as an iterator of Map<String, Object> that contains the parameter name (String) and value (Object) of each development set entry. The casting of the values into the appropriate data type must be performed by the methods that uses the development set entries.

Constructor Summary

Constructors

Constructor	Description
ParamsGrid()	Creates a new ParamsGrid

Method Summary

Modifier and Type	Method	Description
void	addFixedParam(String name, boolean value)	Adds a fixed parameter
void	addFixedParam(String name, double value)	Adds a fixed parameter
void	addFixedParam(String name, int value)	Adds a fixed parameter
void	addFixedParam(String name, long value)	Adds a fixed parameter
void	addFixedParam(String name, Object value)	Adds a fixed parameter
void	addFixedParam(String name, String value)	Adds a fixed parameter
void	addParam(String name, boolean[] values)	Adds a variable parameter
void	addParam(String name, double[] values)	Adds a variable parameter
void	addParam(String name, int[] values)	Adds a variable parameter
void	addParam(String name, long[] values)	Adds a variable parameter
void	addParam(String name, Object[] values)	Adds a variable parameter
void	addParam(String name, String[] values)	Adds a variable parameter
Iterator<Map<String,Object>>	getDevelopmentSetIterator()	Returns the development set created from the grid parameters
Iterator<Map<String,Object>>	getDevelopmentSetIterator(boolean shuffle)	Returns the development set created from the grid parameters
Iterator<Map<String,Object>>	getDevelopmentSetIterator(boolean shuffle, long seed)	Returns the development set created from the grid parameters
int	getDevelopmentSetSize()
String[]	getParamsName()	Returns String Array with the name of the params

Methods inherited from class java.lang.Object

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

Constructor Detail

ParamsGrid

public ParamsGrid()

Creates a new ParamsGrid

Method Detail

getParamsName

public String[] getParamsName()

Returns String Array with the name of the params

Returns:

Name of params

addParam

public void addParam(String name,
                     Object[] values)

Adds a variable parameter

Parameters:

name - Name of the parameter

values - Values to be evaluated

addFixedParam

public void addFixedParam(String name,
                          Object value)

Adds a fixed parameter

Parameters:

name - Name of the parameter

value - Value

addFixedParam

public void addFixedParam(String name,
                          String value)

Adds a fixed parameter

Parameters:

name - Name of the parameter

value - String value

addParam

public void addParam(String name,
                     String[] values)

Adds a variable parameter

Parameters:

name - Name of the parameter

values - String values to be evaluated

addFixedParam

public void addFixedParam(String name,
                          double value)

Adds a fixed parameter

Parameters:

name - Name of the parameter

value - double value

addParam

public void addParam(String name,
                     double[] values)

Adds a variable parameter

Parameters:

name - Name of the parameter

values - double values to be evaluated

addFixedParam

public void addFixedParam(String name,
                          int value)

Adds a fixed parameter

Parameters:

name - Name of the parameter

value - int value

addParam

public void addParam(String name,
                     int[] values)

Adds a variable parameter

Parameters:

name - Name of the parameter

values - int values to be evaluated

addFixedParam

public void addFixedParam(String name,
                          long value)

Adds a fixed parameter

Parameters:

name - Name of the parameter

value - long value

addParam

public void addParam(String name,
                     long[] values)

Adds a variable parameter

Parameters:

name - Name of the parameter

values - long values to be evaluated

addFixedParam

public void addFixedParam(String name,
                          boolean value)

Adds a fixed parameter

Parameters:

name - Name of the parameter

value - boolean

addParam

public void addParam(String name,
                     boolean[] values)

Adds a variable parameter

Parameters:

name - Name of the parameter

values - boolean values to be evaluated

getDevelopmentSetSize

public int getDevelopmentSetSize()

getDevelopmentSetIterator

public Iterator<Map<String,Object>> getDevelopmentSetIterator()

Returns the development set created from the grid parameters

Returns:

Development set

getDevelopmentSetIterator

public Iterator<Map<String,Object>> getDevelopmentSetIterator(boolean shuffle)

Returns the development set created from the grid parameters

Parameters:

shuffle - True if development set order must be shuffled

Returns:

Development set

getDevelopmentSetIterator

public Iterator<Map<String,Object>> getDevelopmentSetIterator(boolean shuffle,
                                                                    long seed)

Returns the development set created from the grid parameters

Parameters:

shuffle - True if development set order must be shuffled

seed - Random seed to allow reproducibility of the shuffle

Returns:

Development set