rrc_types.h File Reference

roadRunner C API 2012 More...

Go to the source code of this file.

Data Structures
struct	RRVector
	Structure for a simple vector of doubles. More...
struct	RRStringArray
	Structure for a simple vector of strings. More...
struct	RRDoubleMatrix
	Structure for a simple double Matrix type. More...
struct	RRComplex
	Structure for a complex number. More...
struct	RRComplexVector
	Structure for a simple complex Vector type. More...
struct	RRComplexMatrix
	Structure for a simple complex Matrix type. More...
struct	RRCData
	Structure for the result type from the simulate calls. More...
struct	RRListItem
	A single list element type. More...
struct	RRList
	A list type, stores int, double, strings and lists. More...

Typedefs
typedef void *	RRHandle
	Void pointer to a RoadRunner instance.
typedef void *	RRDataHandle
	Void pointer to a RoadRunner data instance. More...
typedef struct RRVector *	RRVectorPtr
	Structure for a simple vector of doubles. More...
typedef struct RRStringArray *	RRStringArrayPtr
	Structure for a simple vector of strings. More...
typedef struct RRDoubleMatrix *	RRDoubleMatrixPtr
	Structure for a simple double Matrix type. More...
typedef struct RRComplex *	RRComplexPtr
	Structure for a complex number. More...
typedef struct RRComplexVector *	RRComplexVectorPtr
	Structure for a simple complex Vector type. More...
typedef struct RRComplexMatrix *	RRComplexMatrixPtr
	Structure for a simple complex Matrix type. More...
typedef struct RRCData *	RRCDataPtr
	Structure for the result type from the simulate calls. More...
typedef struct RRListItem *	RRListItemPtr
	A single list element type. More...
typedef struct RRList *	RRListPtr
	A list type, stores int, double, strings and lists. More...

Enumerations
enum	ListItemType { litString, litInteger, litDouble, litList }
	The list type supports strings, integers, double and lists.
enum	RRParameterType {   ptString, ptBool, ptInteger, ptDouble,   ptVector, ptMatrix }
	A parameters type can be string, bool, integer, double, vector or a matrix.

Detailed Description

roadRunner C API 2012

Author

Totte Karlsson & Herbert M Sauro

<-----------------------------------------------------------— This file is part of cRoadRunner. See http://code.google.com/p/roadrunnerlib/ for more details.

Copyright (C) 2012 University of Washington, Seattle, WA, USA

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

In plain english this means:

You CAN freely download and use this software, in whole or in part, for personal, company internal, or commercial purposes;

You CAN use the software in packages or distributions that you create.

You SHOULD include a copy of the license in any redistribution you may make;

You are NOT required include the source of software, or of any modifications you may have made to it, in any redistribution you may assemble that includes it.

YOU CANNOT:

redistribute any piece of this software without proper attribution;

Typedef Documentation

typedef struct RRCData * RRCDataPtr

Structure for the result type from the simulate calls.

Pointer to RRCDataPtr struct

typedef struct RRComplexMatrix * RRComplexMatrixPtr

Structure for a simple complex Matrix type.

Pointer to RRDoubleMatrixPtr struct

typedef struct RRComplex * RRComplexPtr

Structure for a complex number.

Pointer to a RRComplex number

typedef struct RRComplexVector * RRComplexVectorPtr

Structure for a simple complex Vector type.

Pointer to RRVectorHandle struct

typedef void* RRDataHandle

Void pointer to a RoadRunner data instance.

Void pointer to a RoadRunner instance

typedef struct RRDoubleMatrix * RRDoubleMatrixPtr

Structure for a simple double Matrix type.

Pointer to RRDoubleMatrixPtr struct

typedef struct RRListItem * RRListItemPtr

A single list element type.

Pointer to cRRArrayListItemHandle struct

typedef struct RRList * RRListPtr

A list type, stores int, double, strings and lists.

Pointer to cRRArrayListHandle struct

typedef struct RRStringArray * RRStringArrayPtr

Structure for a simple vector of strings.

Pointer to RRStringListHandle struct

typedef struct RRVector * RRVectorPtr

Structure for a simple vector of doubles.

Pointer to RRVectorHandle struct