com.mockturtlesolutions.snifflib.datatypes

Class DblParamSet

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap

com.mockturtlesolutions.snifflib.datatypes.DblParamSet

All Implemented Interfaces:

Displayable, NamedParameters, java.io.Serializable, java.lang.Cloneable, java.util.Map

public class DblParamSet
extends java.util.LinkedHashMap
implements Displayable, NamedParameters, java.io.Serializable

Note that DblParamSet itself implements NamedParameters so you may use reflection when implementing a NamedParameter that uses DblParamSet.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Constructor Summary

Constructors

Constructor and Description
DblParamSet()
DblParamSet(int SIZE) Specify the initial capacity of the parameter set's underlying HashMap.
DblParamSet(java.lang.String[] fieldnames, DblMatrix[] values) Define constructor for DblParamSet.

Method Summary

Methods

Modifier and Type	Method and Description
static DblParamSet	abs(DblParamSet X) Take absolute value of parameter guesses.
DblParamSet	copy() Makes a deep copy of the parameter set.
DblMatrix	Dblget(java.lang.String fieldname) Provides a Dblget method.
void	Dblput(java.lang.String fieldname, DblMatrix value) Provides a Dblput method.
void	Dblput(java.lang.String fieldname, double value) Provides a Dblput method.
void	Dblput(java.lang.String fieldname, java.lang.Double value) Provides a Dblput method.
void	Dblput(java.lang.String fieldname, int value) Provides a Dblput method.
DblParamSet	divideBy(DblMatrix X) Divide parameter set by scalar.
DblParamSet	divideBy(DblParamSet X) Divide one parameter set by another parameter set.
DblParamSet	divideBy(double X) Divide parameter set by scalar.
DblParamSet	divideBy(int X) Divide parameter set by scalar.
DblMatrix	getParam(java.lang.String name)
boolean	hasParameter(java.lang.String pname)
DblParamSet	minus(DblMatrix X) Subtract scalar from parameter set.
DblParamSet	minus(DblParamSet X) Subtract two parameter sets.
DblParamSet	minus(double X) Subtract scalar from parameter set.
DblParamSet	minus(int X) Subtract scalar from parameter set.
java.lang.String[]	parameterSet()
DblParamSet	plus(DblMatrix X) Add scalar to a parameter set.
DblParamSet	plus(DblParamSet X) Add two parameter sets.
DblParamSet	plus(double X) Add scalar to a parameter set.
DblParamSet	plus(int X) Add scalar to a parameter set.
void	refactorAgainst(DblParamSet P) Adds the given parameters only if they are not currently declared.
void	replaceAllWith(DblMatrix x)
void	replaceAllWith(double x)
void	replaceAllWith(java.lang.Double x)
void	replaceParams(DblParamSet P) Sets the given parameters.
void	setParam(java.lang.String name, DblMatrix value)
void	setParam(java.lang.String name, double value) Convenience syntax for setting a scalar parameter value.
void	setParam(java.lang.String name, java.lang.Double value) Convenience syntax for setting a scalar parameter value.
void	show() Show values on screen.
void	show(java.lang.String label) Show values on screen.
void	show(java.lang.String label, java.lang.String numfmt) Show values on screen formated using the given number format string.
DblParamSet	times(DblMatrix X) Multiply parameter sets by scalar.
DblParamSet	times(DblParamSet X) Multiply two parameter sets.
DblParamSet	times(double X) Multiply parameter sets by scalar.
DblParamSet	times(int X) Multiply parameter sets by scalar.
DblMatrix	toDblVector() Extract the values of parameters as a DblMatrix vector.

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, get, removeEldestEntry

Methods inherited from class java.util.HashMap

clone, containsKey, entrySet, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

containsKey, entrySet, equals, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Constructor Detail

DblParamSet

public DblParamSet()

DblParamSet

public DblParamSet(int SIZE)

Specify the initial capacity of the parameter set's underlying HashMap.

DblParamSet

public DblParamSet(java.lang.String[] fieldnames,
           DblMatrix[] values)

Define constructor for DblParamSet. We require an array of DblMatrix to allow for multivariate "parameters" but also we want the return from a get operation on the Hashtable to be a DblMatrix (not a Double).

Method Detail

replaceAllWith

public void replaceAllWith(java.lang.Double x)

replaceAllWith

public void replaceAllWith(DblMatrix x)

replaceAllWith

public void replaceAllWith(double x)

getParam

public DblMatrix getParam(java.lang.String name)

Specified by:

getParam in interface NamedParameters

setParam

public void setParam(java.lang.String name,
            DblMatrix value)

Specified by:

setParam in interface NamedParameters

setParam

public void setParam(java.lang.String name,
            java.lang.Double value)

Convenience syntax for setting a scalar parameter value.

setParam

public void setParam(java.lang.String name,
            double value)

Convenience syntax for setting a scalar parameter value.

hasParameter

public boolean hasParameter(java.lang.String pname)

Specified by:

hasParameter in interface NamedParameters

parameterSet

public java.lang.String[] parameterSet()

Specified by:

parameterSet in interface NamedParameters

replaceParams

public void replaceParams(DblParamSet P)

Sets the given parameters. Note parameters not in the input set are not deleted.

Specified by:

replaceParams in interface NamedParameters

refactorAgainst

public void refactorAgainst(DblParamSet P)

Adds the given parameters only if they are not currently declared. Values of parameters already in the set are not copied over. Parameters not in the input set are deleted.

Dblput

public void Dblput(java.lang.String fieldname,
          DblMatrix value)

Provides a Dblput method.

Dblput

public void Dblput(java.lang.String fieldname,
          java.lang.Double value)

Provides a Dblput method.

Dblput

public void Dblput(java.lang.String fieldname,
          int value)

Provides a Dblput method.

Dblput

public void Dblput(java.lang.String fieldname,
          double value)

Provides a Dblput method.

Dblget

public DblMatrix Dblget(java.lang.String fieldname)

Provides a Dblget method.

toDblVector

public DblMatrix toDblVector()

Extract the values of parameters as a DblMatrix vector.

abs

public static DblParamSet abs(DblParamSet X)

Take absolute value of parameter guesses.

plus

public DblParamSet plus(DblParamSet X)

Add two parameter sets.

plus

public DblParamSet plus(double X)

Add scalar to a parameter set.

plus

public DblParamSet plus(int X)

Add scalar to a parameter set.

plus

public DblParamSet plus(DblMatrix X)

Add scalar to a parameter set.

minus

public DblParamSet minus(DblParamSet X)

Subtract two parameter sets.

minus

public DblParamSet minus(double X)

Subtract scalar from parameter set.

minus

public DblParamSet minus(int X)

Subtract scalar from parameter set.

minus

public DblParamSet minus(DblMatrix X)

Subtract scalar from parameter set.

times

public DblParamSet times(DblParamSet X)

Multiply two parameter sets.

times

public DblParamSet times(double X)

Multiply parameter sets by scalar.

times

public DblParamSet times(int X)

Multiply parameter sets by scalar.

times

public DblParamSet times(DblMatrix X)

Multiply parameter sets by scalar.

divideBy

public DblParamSet divideBy(DblParamSet X)

Divide one parameter set by another parameter set.

divideBy

public DblParamSet divideBy(double X)

Divide parameter set by scalar.

divideBy

public DblParamSet divideBy(int X)

Divide parameter set by scalar.

divideBy

public DblParamSet divideBy(DblMatrix X)

Divide parameter set by scalar.

show

public void show()

Show values on screen.

Specified by:

show in interface Displayable

show

public void show(java.lang.String label)

Show values on screen.

Specified by:

show in interface Displayable

show

public void show(java.lang.String label,
        java.lang.String numfmt)

Show values on screen formated using the given number format string.

copy

public DblParamSet copy()

Makes a deep copy of the parameter set.