Main Page | Modules | Data Structures | Directories | File List | Data Fields | Globals

Parameter Variation Settings
[High Level Interfaces]

Collaboration diagram for Parameter Variation Settings:

Create the varySettings structure with a series of parameter values used for the batch functions. More...

Functions

SBML_ODESOLVER_API varySettings_tVarySettings_allocate (int nrparams, int nrdesignpoints)
 Allocate varySettings structure for settings for parameter variation batch runs: nrparams is the number of parameters to be varied, and nrdesignpoints is the number of values to be tested for each parameter.
SBML_ODESOLVER_API int VarySettings_addParameter (varySettings_t *vs, char *id, char *rid, double start, double end)
 Add a parameter to the varySettings.
SBML_ODESOLVER_API const char * VarySettings_getName (varySettings_t *vs, int i)
 Get the name (SBML ID) of the ith parameter,.
SBML_ODESOLVER_API const char * VarySettings_getReactionName (varySettings_t *vs, int i)
 Get the name (SBML ID) of the reaction of the ith parameter,.
SBML_ODESOLVER_API int VarySettings_setName (varySettings_t *vs, int i, char *id, char *rid)
 Set the id (SBML ID) of the ith parameter,.
SBML_ODESOLVER_API double VarySettings_getValue (varySettings_t *vs, int i, int j)
 Get the jth value of the ith parameter,.
SBML_ODESOLVER_API void VarySettings_setValue (varySettings_t *vs, int i, int j, double value)
 Set the jth value of the ith parameter,.
SBML_ODESOLVER_API void VarySettings_dump (varySettings_t *vs)
 Print all parameters and their values in varySettings.
SBML_ODESOLVER_API void VarySettings_free (varySettings_t *vs)
 Frees varySettings structure.
int VarySettings_addParameterSet (varySettings_t *vs, double **designpoints, char **id, char **rid)

Detailed Description

Create the varySettings structure with a series of parameter values used for the batch functions.


Function Documentation

SBML_ODESOLVER_API varySettings_t* VarySettings_allocate int  nrparams,
int  nrdesignpoints
 

Allocate varySettings structure for settings for parameter variation batch runs: nrparams is the number of parameters to be varied, and nrdesignpoints is the number of values to be tested for each parameter.

SBML_ODESOLVER_API int VarySettings_addParameter varySettings_t vs,
char *  id,
char *  rid,
double  start,
double  end
 

Add a parameter to the varySettings.

For local (reaction/kineticLaw) parameters, the reaction id must be passed as `rid'. For global parameters `rid' must be passed as NULL.

SBML_ODESOLVER_API const char* VarySettings_getName varySettings_t vs,
int  i
 

Get the name (SBML ID) of the ith parameter,.

where
0 <= i < nrparams
as used for varySettings_allocate

SBML_ODESOLVER_API const char* VarySettings_getReactionName varySettings_t vs,
int  i
 

Get the name (SBML ID) of the reaction of the ith parameter,.

where
0 <= i < nrparams
as used for varySettings_allocate. Returns NULL, if the parameter is global.

SBML_ODESOLVER_API int VarySettings_setName varySettings_t vs,
int  i,
char *  id,
char *  rid
 

Set the id (SBML ID) of the ith parameter,.

where
0 <= i < nrparams
as used for varySettings_allocate.
`rid' is the SBML reaction id, if a local parameter shall be varied. For global parameters rid must be passed as NULL.

SBML_ODESOLVER_API double VarySettings_getValue varySettings_t vs,
int  i,
int  j
 

Get the jth value of the ith parameter,.

where
0 <= i < nrparams and
0 <= j < nrdesignpoints
as used for varySettings_allocate

SBML_ODESOLVER_API void VarySettings_setValue varySettings_t vs,
int  i,
int  j,
double  value
 

Set the jth value of the ith parameter,.

where
0 <= i < nrparams and
0 <= j < nrdesignpoints
as used for varySettings_allocate

SBML_ODESOLVER_API void VarySettings_dump varySettings_t vs  ) 
 

Print all parameters and their values in varySettings.

SBML_ODESOLVER_API void VarySettings_free varySettings_t vs  ) 
 

Frees varySettings structure.

int VarySettings_addParameterSet varySettings_t vs,
double **  designpoints,
char **  id,
char **  rid
 


Generated on Wed Dec 21 18:10:38 2005 for SBML ODE Solver Library API by  doxygen 1.4.4