libRoadRunner C API  1.0.0
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Functions
Reaction group

Get information about reaction rates. More...

Functions

int getNumberOfReactions (RRHandle handle)
 Obtain the number of reactions in the loaded model. More...
 
bool getReactionRate (RRHandle handle, const int index, double *rate)
 Retrieve a give reaction rate as indicated by the index parameter. More...
 
RRVectorPtr getReactionRates (RRHandle handle)
 Retrieve a vector of reaction rates as determined by the current state of the model. More...
 
RRVectorPtr getReactionRatesEx (RRHandle handle, const RRVectorPtr vec)
 Retrieve a vector of reaction rates given a vector of species concentrations. More...
 
RRStringArrayPtr getReactionIds (RRHandle handle)
 Obtain the list of reaction Ids. More...
 

Detailed Description

Get information about reaction rates.

Function Documentation

int getNumberOfReactions ( RRHandle  handle)

Obtain the number of reactions in the loaded model.

Example:

1 number = getNumberOfReactions (RRHandle handle);
Parameters
[in]handleHandle to a RoadRunner instance
Returns
Returns -1 if it fails, if successful it return 0 or more, indicating the number of reactions
RRStringArrayPtr getReactionIds ( RRHandle  handle)

Obtain the list of reaction Ids.

Parameters
[in]handleHandle to a RoadRunner instance
Returns
Returns null if it fails, if successful it returns a pointer to a RRStringArrayPtr struct
bool getReactionRate ( RRHandle  handle,
const int  index,
double *  rate 
)

Retrieve a give reaction rate as indicated by the index parameter.

Parameters
[in]handleHandle to a RoadRunner instance
index- The index is used to specify which reaction rate to retrieve
rate- The reaction rate is returned in the rate argument
Returns
Returns false if it fails
RRVectorPtr getReactionRates ( RRHandle  handle)

Retrieve a vector of reaction rates as determined by the current state of the model.

Parameters
[in]handleHandle to a RoadRunner instance
Returns
Returns null if it fails, otherwise it returns a vector of reaction rates
RRVectorPtr getReactionRatesEx ( RRHandle  handle,
const RRVectorPtr  vec 
)

Retrieve a vector of reaction rates given a vector of species concentrations.

Parameters
[in]handleHandle to a RoadRunner instance
vecThe vector of floating species concentrations
Returns
Returns null if it fails otherwise it returns a vector of reaction rates