Public Member Functions | Public Attributes | List of all members
SparseJacobianMatrix Class Reference

a sparse Jacobian matrix data structure More...

#include <OSGeneral.h>

Public Member Functions

 SparseJacobianMatrix ()
 Default constructor. More...
 
 SparseJacobianMatrix (int startSize, int valueSize)
 Constructor. More...
 
 ~SparseJacobianMatrix ()
 Default destructor. More...
 

Public Attributes

bool bDeleteArrays
 bDeleteArrays is true if we delete the arrays in garbage collection set to true by default More...
 
int startSize
 startSize is the dimension of the starts array – should equal number of rows + 1 More...
 
int valueSize
 valueSize is the dimension of the values array More...
 
intstarts
 starts holds an integer array of start elements, each start element points to the start of partials for that row More...
 
intconVals
 conVals holds an integer array of integers, conVals[i] is the number of constant terms in the gradient for row i. More...
 
intindexes
 indexes holds an integer array of variable indices. More...
 
double * values
 values holds a double array of nonzero partial derivatives More...
 

Detailed Description

a sparse Jacobian matrix data structure

Definition at line 300 of file OSGeneral.h.

Constructor & Destructor Documentation

SparseJacobianMatrix::SparseJacobianMatrix ( )

Default constructor.

Definition at line 304 of file OSGeneral.cpp.

SparseJacobianMatrix::SparseJacobianMatrix ( int  startSize,
int  valueSize 
)

Constructor.

Parameters
startSizeholds the size of the start array.
valueSizeholds the size of the value and index arrays.

Definition at line 316 of file OSGeneral.cpp.

SparseJacobianMatrix::~SparseJacobianMatrix ( )

Default destructor.

Definition at line 328 of file OSGeneral.cpp.

Member Data Documentation

bool SparseJacobianMatrix::bDeleteArrays

bDeleteArrays is true if we delete the arrays in garbage collection set to true by default

Definition at line 308 of file OSGeneral.h.

int SparseJacobianMatrix::startSize

startSize is the dimension of the starts array – should equal number of rows + 1

Definition at line 313 of file OSGeneral.h.

int SparseJacobianMatrix::valueSize

valueSize is the dimension of the values array

Definition at line 318 of file OSGeneral.h.

int* SparseJacobianMatrix::starts

starts holds an integer array of start elements, each start element points to the start of partials for that row

Definition at line 324 of file OSGeneral.h.

int* SparseJacobianMatrix::conVals

conVals holds an integer array of integers, conVals[i] is the number of constant terms in the gradient for row i.

Definition at line 330 of file OSGeneral.h.

int* SparseJacobianMatrix::indexes

indexes holds an integer array of variable indices.

Definition at line 335 of file OSGeneral.h.

double* SparseJacobianMatrix::values

values holds a double array of nonzero partial derivatives

Definition at line 340 of file OSGeneral.h.


The documentation for this class was generated from the following files: