Parameters

Class Parameters

java.lang.Object

Parameters.Parameters

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<Parameter>

public class Parameters
extends java.lang.Object
implements java.lang.Iterable<Parameter>, java.io.Serializable

Represents a set of parameters

Version:

2.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Parameters.ParameterException Exception related to the parameters

Constructor Summary

Constructors

Constructor and Description
Parameters() Creates an empty set of parameters
Parameters(java.util.List<Parameter> params) Creates a set of parameters containing the given parameters

Method Summary

Methods

Modifier and Type	Method and Description
void	addParameter(Parameter p) Add a parameter
void	addParameters(Parameters pp) Adds the parameters from another set of parameters
Parameters	clone()
static Parameters	fromFile(java.io.File f) Reads parameters from a file.
Parameter	getParam(java.lang.String name) Gets the parameter with the given name
double	getValue(java.lang.String name) Gets the value of a parameter
java.util.HashMap<java.lang.String,java.lang.Double>	getValues() Gets a map from parameter name to the value of that parameter
boolean	hasParam(java.lang.String name) Checks whether there is a parameter with the given name
java.util.Iterator<Parameter>	iterator()
int	numberEstimate() Gets the number of parameters to be estimated
void	setValue(Parameter p, double v) Sets the value of a parameter
void	toFile(java.io.File f) Writes the parameter values to a file.
void	toFile(java.io.File f, double like) Writes the parameter values to a file and writes a line labeled likelihood and which gives the likelihood given as input.
java.lang.String	toString()
java.lang.String	toString(boolean fixed) Returns a string representation of the parameters

Methods inherited from class java.lang.Object

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

Constructor Detail

Parameters

public Parameters()

Creates an empty set of parameters

Parameters

public Parameters(java.util.List<Parameter> params)
           throws Parameters.ParameterException

Creates a set of parameters containing the given parameters

Parameters:

params - A list of parameters

Throws:

Parameters.ParameterException - If there is already a parameter with the same name as one to be added.

Method Detail

clone

public Parameters clone()

Overrides:

clone in class java.lang.Object

addParameter

public final void addParameter(Parameter p)
                        throws Parameters.ParameterException

Add a parameter

Parameters:

p - The parameter

Throws:

Parameters.ParameterException - If there is already a parameter with that name.

addParameters

public void addParameters(Parameters pp)
                   throws Parameters.ParameterException

Adds the parameters from another set of parameters

Parameters:

pp - The other set of parameters

Throws:

Parameters.ParameterException - If there is already a parameter with the same name as one to be added.

setValue

public void setValue(Parameter p,
            double v)
              throws Parameters.ParameterException

Sets the value of a parameter

Parameters:

p - The parameter

v - The value

Throws:

Parameters.ParameterException - Thrown if an attempt is made to set the parameter to a value outside it's bounds

getValue

public double getValue(java.lang.String name)
                throws Parameters.ParameterException

Gets the value of a parameter

Parameters:

name - The parameters name

Returns:

The value of that parameter.

Throws:

Parameters.ParameterException - Thrown if there is no parameter with that name

getParam

public Parameter getParam(java.lang.String name)
                   throws Parameters.ParameterException

Gets the parameter with the given name

Parameters:

name - The name of the parameter

Returns:

The parameter

Throws:

Parameters.ParameterException - Thrown if there is no parameter with that name

hasParam

public final boolean hasParam(java.lang.String name)

Checks whether there is a parameter with the given name

Parameters:

name - The name of the parameter

Returns:

Whether there is a parameter with that name

getValues

public java.util.HashMap<java.lang.String,java.lang.Double> getValues()

Gets a map from parameter name to the value of that parameter

Returns:

Map from parameter name to parameter value

numberEstimate

public int numberEstimate()

Gets the number of parameters to be estimated

Returns:

The number of parameters to be estimated

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toString

public java.lang.String toString(boolean fixed)

Returns a string representation of the parameters

Parameters:

fixed - Whether to include fixed parameters in the output

Returns:

A string representation of the parameters

iterator

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

Specified by:

iterator in interface java.lang.Iterable<Parameter>

toFile

public void toFile(java.io.File f)
            throws OutputException

Writes the parameter values to a file. Each parameter uses one line and the format of that line is as described at Parameter.fromString(java.lang.String)

Parameters:

f - File to write the parameters to

Throws:

OutputException - Thrown if an error occurs writing the file

toFile

public void toFile(java.io.File f,
          double like)
            throws OutputException

Writes the parameter values to a file and writes a line labeled likelihood and which gives the likelihood given as input. Each parameter uses one line and the format of that line is as described at Parameter.fromString(java.lang.String)

Parameters:

f - File to write the parameters to

like - The likelihood value

Throws:

OutputException - Thrown if an error occurs writing the file

fromFile

public static Parameters fromFile(java.io.File f)
                           throws InputException,
                                  Parameters.ParameterException

Reads parameters from a file. Each parameter is a single line and is described at Parameter.fromString(java.lang.String).

Parameters:

f - The input file

Returns:

A Parameters instance

Throws:

InputException - If there is an input error

Parameters.ParameterException - If the file contains two parameters with the same name.