LinearMatrixElement Class Reference

a data structure to represent an expression in a linearMatrix element A LinearMatrixElement is a (finite) sum of LinearMatrixElementTerms, with an optional additive constant More...

#include <OSMatrix.h>

Collaboration diagram for LinearMatrixElement:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 LinearMatrixElement ()
 ---------- Methods for class LinearMatrixElement ----------
 ~LinearMatrixElement ()
bool IsEqual (LinearMatrixElement *that)
 A function to check for the equality of two objects.
bool setRandom (double density, bool conformant, int iMin, int iMax)
 A function to make a random instance of this class.
bool deepCopyFrom (LinearMatrixElement *that)
 A function to make a deep copy of an instance of this class.

Public Attributes

int numberOfVarIdx
double constant
LinearMatrixElementTerm ** varIdx

Detailed Description

a data structure to represent an expression in a linearMatrix element A LinearMatrixElement is a (finite) sum of LinearMatrixElementTerms, with an optional additive constant

Parameters:
numberOfVarIdx gives the number of terms in the expression

Definition at line 411 of file OSMatrix.h.


Constructor & Destructor Documentation

LinearMatrixElement::LinearMatrixElement (  ) 

---------- Methods for class LinearMatrixElement ----------

Definition at line 4869 of file OSMatrix.cpp.

LinearMatrixElement::~LinearMatrixElement (  ) 

Definition at line 4880 of file OSMatrix.cpp.


Member Function Documentation

bool LinearMatrixElement::IsEqual ( LinearMatrixElement that  ) 

A function to check for the equality of two objects.

Definition at line 4910 of file OSMatrix.cpp.

bool LinearMatrixElement::setRandom ( double  density,
bool  conformant,
int  iMin,
int  iMax 
)

A function to make a random instance of this class.

Parameters:
density,: corresponds to the probability that a particular child element is created
conformant,: if true enforces side constraints not enforceable in the schema (e.g., agreement of "numberOfXXX" attributes and <XXX> children)
iMin,: lowest index value (inclusive) that a variable reference in this matrix can take
iMax,: greatest index value (inclusive) that a variable reference in this matrix can take

Definition at line 4951 of file OSMatrix.cpp.

bool LinearMatrixElement::deepCopyFrom ( LinearMatrixElement that  ) 

A function to make a deep copy of an instance of this class.

Parameters:
that,: the instance from which information is to be copied
Returns:
whether the copy was created successfully

Definition at line 4956 of file OSMatrix.cpp.


Member Data Documentation

Definition at line 414 of file OSMatrix.h.

Definition at line 415 of file OSMatrix.h.

Definition at line 417 of file OSMatrix.h.


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

Generated on 5 Jul 2015 by  doxygen 1.6.1