LinearMatrixElementTerm Class Reference

a data structure to represent a term in a linearMatrix element A term has the form c*x_{k}, where c defaults to 1 and k is a valid index for a variable This is essentially an index-value pair, but with the presence of a default value More...

#include <OSMatrix.h>

List of all members.

Public Member Functions

 LinearMatrixElementTerm ()
 ---------- Methods for class LinearMatrixElementTerm ----------
 ~LinearMatrixElementTerm ()
bool IsEqual (LinearMatrixElementTerm *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 (LinearMatrixElementTerm *that)
 A function to make a deep copy of an instance of this class.

Public Attributes

int idx
double coef

Detailed Description

a data structure to represent a term in a linearMatrix element A term has the form c*x_{k}, where c defaults to 1 and k is a valid index for a variable This is essentially an index-value pair, but with the presence of a default value

Definition at line 373 of file OSMatrix.h.


Constructor & Destructor Documentation

LinearMatrixElementTerm::LinearMatrixElementTerm (  ) 

---------- Methods for class LinearMatrixElementTerm ----------

Definition at line 4978 of file OSMatrix.cpp.

LinearMatrixElementTerm::~LinearMatrixElementTerm (  ) 

Definition at line 4987 of file OSMatrix.cpp.


Member Function Documentation

bool LinearMatrixElementTerm::IsEqual ( LinearMatrixElementTerm that  ) 

A function to check for the equality of two objects.

Definition at line 4994 of file OSMatrix.cpp.

bool LinearMatrixElementTerm::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 5032 of file OSMatrix.cpp.

bool LinearMatrixElementTerm::deepCopyFrom ( LinearMatrixElementTerm 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 5037 of file OSMatrix.cpp.


Member Data Documentation

Definition at line 376 of file OSMatrix.h.

Definition at line 377 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