Looping parameters (lambda, mu, sigma, and nu)

Data Structures
struct	ParameterTypeNode
Defines
#define	NUM_PARAMETERS   MAX_FITS_PARMS
Typedefs
typedef struct ParameterTypeNode	ParameterType
Functions
void	incrementParameter (ParameterType *pt)
bool	moreParameters (ParameterType *pt)
void	addParameter (LambdaSet ls)
void	incrementSigma (ParameterType *pt)
ParameterType *	getSigma ()
void	setSigma (ParameterType *pt)
void	setSigmaStep (int steps)
ParameterType *	getParameters ()
ParameterType *	getMu ()
void	setMu (ParameterType *pt)
ParameterType *	getNu ()
void	setNu (ParameterType *pt)
ParameterType *	getEpsilon ()
void	setEpsilon (ParameterType *pt)
void	initLoopParameters (InputParms inputParms)
void	destroyParameters (ParameterType *pt)
void	doSomething (Float *parmValuesPtr, int *parmStepsPtr, int *nParms)

---

Define Documentation

#define NUM_PARAMETERS   MAX_FITS_PARMS

---

Typedef Documentation

typedef struct ParameterTypeNode ParameterType

---

Function Documentation

void addParameter

(

LambdaSet

ls

)

Add a LambdaSet that specifies a parameters range to the list of looping parameters.

Parameters:

[in]

ls

LambdaSet (dependency Pointer to ParameterData?? not sure what this means.)

void destroyParameters

(

ParameterType *

pt

)

Free all memory associated with a ParameterType.

Parameters:

[in]

pt

A pointer to a ParameterType.

void doSomething	(	Float *	parmValues,
		int *	parmSteps,
		int *	nParms
	)

send already allocated space for parmValues and parmSteps

ParameterType* getEpsilon

(

)

Get a pointer to looping parameter, Epsilon.

ParameterType* getMu

(

)

Get a pointer to looping parameter, Mu.

ParameterType* getNu

(

)

Get a pointer to looping parameter, Nu.

ParameterType* getParameters

(

)

Get the list of looping parameters.

ParameterType* getSigma

(

)

Get a pointer to looping parameter, Sigma.

void incrementParameter

(

ParameterType *

pt

)

Increment parameter to next value in its range.

Parameters:

[in]

pt

ParameterType Pointer to a looping parameter, for example, mu, sigma, lamda, nu.

void incrementSigma

(

ParameterType *

pt

)

Special function to increment sigma, since it requires computing a new target function.

Parameters:

[in]

pt

A pointer to a ParameterType.

void initLoopParameters

(

InputParms

inputParms

)

Initialize the looping parameters using information from the input file.

Parameters:

[in]

inputParms

InputParms structure containing parameter values parsed from the input file.

bool moreParameters

(

ParameterType *

pt

)

Return true, if there are more values in the parameter range.

Parameters:

[in]

pt

ParameterType Pointer to a looping parameter.

Returns:

True if more values, false if the all values in range have been used.

void setEpsilon

(

ParameterType *

pt

)

void setMu

(

ParameterType *

pt

)

void setNu

(

ParameterType *

pt

)

void setSigma

(

ParameterType *

pt

)

void setSigmaStep

(

int

steps

)