Calculate control coefficients and sensitivities. More...

Functions
RRListPtr	getElasticityCoefficientIds (RRHandle handle)
	Obtain the list of elasticity coefficient Ids. More...

RRListPtr	getUnscaledFluxControlCoefficientIds (RRHandle handle)
	Obtain the list of unscaled flux control coefficient Ids. More...

RRListPtr	getFluxControlCoefficientIds (RRHandle handle)
	Obtain the list of flux control coefficient Ids. More...

RRListPtr	getUnscaledConcentrationControlCoefficientIds (RRHandle handle)
	Obtain the list of unscaled concentration control coefficient Ids. More...

RRListPtr	getConcentrationControlCoefficientIds (RRHandle handle)
	Obtain the list of concentration coefficient Ids. More...

RRDoubleMatrixPtr	getUnscaledElasticityMatrix (RRHandle handle)
	Retrieve the unscaled elasticity matrix for the current model. More...

RRDoubleMatrixPtr	getScaledElasticityMatrix (RRHandle handle)
	Retrieve the scaled elasticity matrix for the current model. More...

bool	getScaledFloatingSpeciesElasticity (RRHandle handle, const char reactionId, const char speciesId, double *value)
	Retrieve the scaled elasticity matrix for the current model. More...

RRDoubleMatrixPtr	getUnscaledConcentrationControlCoefficientMatrix (RRHandle handle)
	Retrieve the matrix of unscaled concentration control coefficients for the current model. More...

RRDoubleMatrixPtr	getScaledConcentrationControlCoefficientMatrix (RRHandle handle)
	Retrieve the matrix of scaled concentration control coefficients for the current model. More...

RRDoubleMatrixPtr	getUnscaledFluxControlCoefficientMatrix (RRHandle handle)
	Retrieve the matrix of unscaled flux control coefficients for the current model. More...

RRDoubleMatrixPtr	getScaledFluxControlCoefficientMatrix (RRHandle handle)
	Retrieve the matrix of scaled flux control coefficients for the current model. More...

bool	getuCC (RRHandle handle, const char variable, const char parameter, double *value)
	Retrieve a single unscaled control coefficient. More...

bool	getCC (RRHandle handle, const char variable, const char parameter, double *value)
	Retrieve a single control coefficient. More...

bool	getEE (RRHandle handle, const char name, const char species, double *value)
	Retrieve a single elasticity coefficient. More...

bool	getuEE (RRHandle handle, const char name, const char species, double *value)
	Retrieve a single unscaled elasticity coefficient. More...

Detailed Description

Calculate control coefficients and sensitivities.

Function Documentation

bool getCC	(	RRHandle	handle,
		const char *	variable,
		const char *	parameter,
		double *	value
	)

Retrieve a single control coefficient.

Parameters

[in]	handle	Handle to a RoadRunner instance
[in]	variable	This is the dependent variable of the coefficient, for example a flux or species concentration
[in]	parameter	This is the independent parameter, for example a kinetic constant or boundary species
[out]	value	This is the value of the control coefficeint returns to the caller

Returns: Returns true if successful

RRListPtr getConcentrationControlCoefficientIds ( RRHandle handle )

Obtain the list of concentration coefficient Ids.

Parameters

[in] handle Handle to a RoadRunner instance

Returns: Returns null if it fails, if succesful it returns a list of Ids

bool getEE	(	RRHandle	handle,
		const char *	name,
		const char *	species,
		double *	value
	)

Retrieve a single elasticity coefficient.

Parameters

[in]	handle	Handle to a RoadRunner instance
[in]	name	This is the reaction variable for the elasticity
[in]	species	This is the independent parameter, for example a floating of boundary species
[out]	value	This is the value of the elasticity coefficient returns to the caller

Returns: Returns true if successful

RRListPtr getElasticityCoefficientIds ( RRHandle handle )

Obtain the list of elasticity coefficient Ids.

Parameters

[in] handle Handle to a RoadRunner instance

Returns: Returns null if it fails, if succesful it returns a list

RRListPtr getFluxControlCoefficientIds ( RRHandle handle )

Obtain the list of flux control coefficient Ids.

Parameters

[in] handle Handle to a RoadRunner instance

Returns: Returns null if it fails, if succesful it returns a list of Ids

RRDoubleMatrixPtr getScaledConcentrationControlCoefficientMatrix ( RRHandle handle )

Retrieve the matrix of scaled concentration control coefficients for the current model.

Parameters

[in] handle Handle to a RoadRunner instance

Returns: Returns null if it fails, otherwise returns a matrix of scaled concentration control coefficients

RRDoubleMatrixPtr getScaledElasticityMatrix ( RRHandle handle )

Retrieve the scaled elasticity matrix for the current model.

Parameters

[in] handle Handle to a RoadRunner instance

Returns: Returns null if it fails, otherwise returns a matrix of scaled elasticities.

bool getScaledFloatingSpeciesElasticity	(	RRHandle	handle,
		const char *	reactionId,
		const char *	speciesId,
		double *	value
	)

Retrieve the scaled elasticity matrix for the current model.

Parameters

[in]	handle	Handle to a RoadRunner instance
[in]	reactionId	The reaction Id for computing the elasticity
[in]	speciesId	The floating species to compute the elasticity for
[out]	value	The return value for the elasticity

Returns: Returns false if it fails

RRDoubleMatrixPtr getScaledFluxControlCoefficientMatrix ( RRHandle handle )

Retrieve the matrix of scaled flux control coefficients for the current model.

Parameters

[in] handle Handle to a RoadRunner instance

Returns: Returns null if it fails, otherwise returns a matrix of scaled flux control coefficients

bool getuCC	(	RRHandle	handle,
		const char *	variable,
		const char *	parameter,
		double *	value
	)

Retrieve a single unscaled control coefficient.

Parameters

[in]	handle	Handle to a RoadRunner instance
[in]	variable	This is the dependent variable of the coefficient, for example a flux or species concentration
[in]	parameter	This is the independent parameter, for example a kinetic constant or boundary species
[out]	value	This is the value of the unscaled control coefficeint returns to the caller

Returns: Returns true if successful

bool getuEE	(	RRHandle	handle,
		const char *	name,
		const char *	species,
		double *	value
	)

Retrieve a single unscaled elasticity coefficient.

Parameters

[in]	handle	Handle to a RoadRunner instance
[in]	name	This is the reaction variable for the unscaled elasticity
[in]	species	This is the independent parameter, for example a floating of boundary species
[out]	value	This is the value of the unscaled elasticity coefficient returns to the caller

Returns: Returns true if successful

RRListPtr getUnscaledConcentrationControlCoefficientIds ( RRHandle handle )

Obtain the list of unscaled concentration control coefficient Ids.

Parameters

[in] handle Handle to a RoadRunner instance

Returns: Returns null if it fails, if succesful it returns a list of Ids

RRDoubleMatrixPtr getUnscaledConcentrationControlCoefficientMatrix ( RRHandle handle )

Retrieve the matrix of unscaled concentration control coefficients for the current model.

Parameters

[in] handle Handle to a RoadRunner instance

Returns: Returns null if it fails, otherwise returns a matrix of unscaled concentration control coefficients The first column will contain the real values and the second column the imaginary values

RRDoubleMatrixPtr getUnscaledElasticityMatrix ( RRHandle handle )

Retrieve the unscaled elasticity matrix for the current model.

Parameters

[in] handle Handle to a RoadRunner instance

Returns: Returns nil if it fails, otherwise returns a matrix of unscaled elasticities

RRListPtr getUnscaledFluxControlCoefficientIds ( RRHandle handle )

Obtain the list of unscaled flux control coefficient Ids.

Parameters

[in] handle Handle to a RoadRunner instance

Returns: Returns null if it fails, if succesful it returns a list of Ids

RRDoubleMatrixPtr getUnscaledFluxControlCoefficientMatrix ( RRHandle handle )

Retrieve the matrix of unscaled flux control coefficients for the current model.

Parameters

[in] handle Handle to a RoadRunner instance

Returns: Returns null if it fails, otherwise returns a matrix of unscaled flux control coefficients

Functions

Detailed Description

Function Documentation