pal.misc
Class MultiParameterized

java.lang.Object
  pal.misc.MultiParameterized

All Implemented Interfaces:

Parameterized

public class MultiParameterized
extends java.lang.Object
implements Parameterized

Title: MultiParameterized

Description: A utility class for integrating multiple parameterized objects into one

Version:

1.0

Author:

Matthew Goode

Nested Class Summary

static interface

MultiParameterized.ParameterAccessWatcher An interface for classes that wish to find out about particular parameter access

Nested classes/interfaces inherited from interface pal.misc.Parameterized

Parameterized.Null, Parameterized.ParameterizedBase, Parameterized.ParameterizedUser, Parameterized.Utils

Constructor Summary

MultiParameterized(Parameterized[] bases)

MultiParameterized(Parameterized[] bases, MultiParameterized.ParameterAccessWatcher watcher)

MultiParameterized(Parameterized b1, Parameterized b2)

Method Summary

protected static int	countParameters(Parameterized[] ps)
double[]	getBaseParameters(int baseIndex)
double[]	getBaseParameters(Parameterized base)
double	getDefaultValue(int n) get default value of parameter
protected int	getIndex(Parameterized base) Get the index of a base parameterized object
double	getLowerLimit(int n) get lower parameter limit
int	getNumParameters() get number of parameters
double	getParameter(int n) get model parameter
double	getUpperLimit(int n) get upper parameter limit
void	setParameter(double param, int n) set model parameter
void	setParameterSE(double paramSE, int n) set standard errors for model parameter
protected static void	setup(Parameterized[] ps, int[] baseLookup, int[] baseParameter)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiParameterized

public MultiParameterized(Parameterized b1,
                          Parameterized b2)

MultiParameterized

public MultiParameterized(Parameterized[] bases)

MultiParameterized

public MultiParameterized(Parameterized[] bases,
                          MultiParameterized.ParameterAccessWatcher watcher)

Method Detail

countParameters

protected static final int countParameters(Parameterized[] ps)

getIndex

protected final int getIndex(Parameterized base)

Get the index of a base parameterized object

Parameters:

base - the base to check

Returns:

the index

Throws:

java.lang.IllegalArgumentException - if base unknown

getBaseParameters

public final double[] getBaseParameters(Parameterized base)

getBaseParameters

public final double[] getBaseParameters(int baseIndex)

setup

protected static final void setup(Parameterized[] ps,
                                  int[] baseLookup,
                                  int[] baseParameter)

getNumParameters

public final int getNumParameters()

Description copied from interface: Parameterized

get number of parameters

Specified by:

getNumParameters in interface Parameterized

Returns:

number of parameters

setParameterSE

public void setParameterSE(double paramSE,
                           int n)

Description copied from interface: Parameterized

set standard errors for model parameter

Specified by:

setParameterSE in interface Parameterized

Parameters:

paramSE - standard error of parameter value

n - parameter number

setParameter

public void setParameter(double param,
                         int n)

Description copied from interface: Parameterized

set model parameter

Specified by:

setParameter in interface Parameterized

Parameters:

param - parameter value

n - parameter number

getParameter

public double getParameter(int n)

Description copied from interface: Parameterized

get model parameter

Specified by:

getParameter in interface Parameterized

Parameters:

n - parameter number

Returns:

parameter value

getUpperLimit

public double getUpperLimit(int n)

Description copied from interface: Parameterized

get upper parameter limit

Specified by:

getUpperLimit in interface Parameterized

Parameters:

n - parameter number

Returns:

upper bound

getLowerLimit

public double getLowerLimit(int n)

Description copied from interface: Parameterized

get lower parameter limit

Specified by:

getLowerLimit in interface Parameterized

Parameters:

n - parameter number

Returns:

lower bound

getDefaultValue

public double getDefaultValue(int n)

Description copied from interface: Parameterized

get default value of parameter

Specified by:

getDefaultValue in interface Parameterized

Parameters:

n - parameter number

Returns:

default value

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object