Parameters

Class Parameter

java.lang.Object

Parameters.Parameter

All Implemented Interfaces:

java.io.Serializable

public class Parameter
extends java.lang.Object
implements java.io.Serializable

Represents a parameter of a model

Version:

2.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Parameter.FormatException Exception thrown when the format of a parameter string is incorrect

Method Summary

Methods

Modifier and Type	Method and Description
Parameter	clone()
boolean	getEstimate() Returns whether this parameter is a parameter that should be estimated
double	getLowerBound() Gets the lower bound of a parameter
java.lang.String	getName() Gets the name of the parameter
double	getUpperBound() Gets the upper bound of a parameter
double	getValue() Gets the value of the parameter
static Parameter	newEstimatedBoundedParameter(java.lang.String name, double lbound, double ubound) Creates a new bounded parameter that is estimated.
static Parameter	newEstimatedBoundedParameter(java.lang.String name, double lbound, double ubound, double start) Creates a new bounded parameter that is estimated.
static Parameter	newEstimatedParameter(java.lang.String name) Creates a new (unbounded) parameter that is estimated.
static Parameter	newEstimatedParameter(java.lang.String name, double start) Creates a new (unbounded) parameter that is estimated.
static Parameter	newEstimatedPositiveParameter(java.lang.String name) Creates a new parameter that has to be positive and is estimated.
static Parameter	newEstimatedPositiveParameter(java.lang.String name, double start) Creates a new parameter that has to be positive and is estimated.
static Parameter	newFixedParameter(java.lang.String name, double value) Creates a new fixed parameter (i.e.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

clone

public Parameter clone()

Overrides:

clone in class java.lang.Object

getName

public java.lang.String getName()

Gets the name of the parameter

Returns:

The name

getValue

public double getValue()

Gets the value of the parameter

Returns:

The value

getLowerBound

public double getLowerBound()

Gets the lower bound of a parameter

Returns:

The lower bound

getUpperBound

public double getUpperBound()

Gets the upper bound of a parameter

Returns:

The upper bound

getEstimate

public boolean getEstimate()

Returns whether this parameter is a parameter that should be estimated

Returns:

Whether this parameter is to be estimated

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

newEstimatedPositiveParameter

public static Parameter newEstimatedPositiveParameter(java.lang.String name)

Creates a new parameter that has to be positive and is estimated.

Parameters:

name - The name of the parameter

Returns:

The parameter

newEstimatedPositiveParameter

public static Parameter newEstimatedPositiveParameter(java.lang.String name,
                                      double start)

Creates a new parameter that has to be positive and is estimated.

Parameters:

name - The name of the parameter

start - The initial value to use when optimising this parameter

Returns:

The parameter

newEstimatedParameter

public static Parameter newEstimatedParameter(java.lang.String name)

Creates a new (unbounded) parameter that is estimated.

Parameters:

name - The name of the parameter

Returns:

The parameter

newEstimatedParameter

public static Parameter newEstimatedParameter(java.lang.String name,
                              double start)

Creates a new (unbounded) parameter that is estimated.

Parameters:

name - The name of the parameter

start - The initial value to use when optimising this parameter

Returns:

The parameter

newEstimatedBoundedParameter

public static Parameter newEstimatedBoundedParameter(java.lang.String name,
                                     double lbound,
                                     double ubound)

Creates a new bounded parameter that is estimated.

Parameters:

name - The name of the parameter

lbound - The lower bound of the value the parameter can take

ubound - The upper bound of the value the parameter can take

Returns:

The parameter

newEstimatedBoundedParameter

public static Parameter newEstimatedBoundedParameter(java.lang.String name,
                                     double lbound,
                                     double ubound,
                                     double start)

Creates a new bounded parameter that is estimated.

Parameters:

name - The name of the parameter

lbound - The lower bound of the value the parameter can take

ubound - The upper bound of the value the parameter can take

start - The initial value to use when optimising this parameter

Returns:

The parameter

newFixedParameter

public static Parameter newFixedParameter(java.lang.String name,
                          double value)

Creates a new fixed parameter (i.e. it is not estimated).

Parameters:

name - The parameters name

value - The value of the parameter

Returns:

The parameter