INMOST
A toolkit for distributed mathematical modeling
INMOST::multivar_expression Class Reference

A class that represents a variable with multiple first order variations. More...

#include <inmost_expression.h>

Inheritance diagram for INMOST::multivar_expression:
Collaboration diagram for INMOST::multivar_expression:

Public Member Functions

 multivar_expression (INMOST_DATA_REAL_TYPE pvalue)
 
 multivar_expression (const multivar_expression &other)
 
 multivar_expression (INMOST_DATA_REAL_TYPE pvalue, Sparse::Row &pentries)
 
 multivar_expression (INMOST_DATA_REAL_TYPE pvalue, INMOST_DATA_ENUM_TYPE pindex, INMOST_DATA_REAL_TYPE pdmult=1.0)
 
 multivar_expression (const basic_expression &expr)
 
__INLINE INMOST_DATA_REAL_TYPE GetValue () const
 
__INLINE void SetValue (INMOST_DATA_REAL_TYPE val)
 
__INLINE void GetJacobian (INMOST_DATA_REAL_TYPE mult, Sparse::RowMerger &r) const
 
__INLINE void GetJacobian (INMOST_DATA_REAL_TYPE mult, Sparse::Row &r) const
 
__INLINE void GetHessian (INMOST_DATA_REAL_TYPE multJ, Sparse::Row &J, INMOST_DATA_REAL_TYPE multH, Sparse::HessianRow &H) const
 
__INLINE INMOST_DATA_ENUM_TYPE GetCount () const
 
__INLINE multivar_expressionoperator= (INMOST_DATA_REAL_TYPE pvalue)
 
__INLINE multivar_expressionoperator= (multivar_expression const &other)
 
__INLINE Sparse::RowGetRow ()
 
__INLINE const Sparse::RowGetRow () const
 
__INLINE INMOST_DATA_REAL_TYPE GetDerivative (INMOST_DATA_ENUM_TYPE index) const
 
__INLINE bool operator< (INMOST_DATA_REAL_TYPE right) const
 
__INLINE bool operator> (INMOST_DATA_REAL_TYPE right) const
 
__INLINE bool operator<= (INMOST_DATA_REAL_TYPE right) const
 
__INLINE bool operator>= (INMOST_DATA_REAL_TYPE right) const
 
__INLINE bool operator== (INMOST_DATA_REAL_TYPE right) const
 
__INLINE bool operator!= (INMOST_DATA_REAL_TYPE right) const
 
__INLINE bool operator< (basic_expression const &expr) const
 
__INLINE bool operator> (basic_expression const &expr) const
 
__INLINE bool operator<= (basic_expression const &expr) const
 
__INLINE bool operator>= (basic_expression const &expr) const
 
__INLINE bool operator== (basic_expression const &expr) const
 
__INLINE bool operator!= (basic_expression const &expr) const
 
__INLINE bool operator< (multivar_expression const &expr) const
 
__INLINE bool operator> (multivar_expression const &expr) const
 
__INLINE bool operator<= (multivar_expression const &expr) const
 
__INLINE bool operator>= (multivar_expression const &expr) const
 
__INLINE bool operator== (multivar_expression const &expr) const
 
__INLINE bool operator!= (multivar_expression const &expr) const
 
__INLINE multivar_expressionoperator+= (basic_expression const &expr)
 
__INLINE multivar_expressionoperator-= (basic_expression const &expr)
 
__INLINE multivar_expressionoperator*= (basic_expression const &expr)
 
__INLINE multivar_expressionoperator/= (basic_expression const &expr)
 
__INLINE multivar_expressionoperator+= (INMOST_DATA_REAL_TYPE right)
 
__INLINE multivar_expressionoperator-= (INMOST_DATA_REAL_TYPE right)
 
__INLINE multivar_expressionoperator*= (INMOST_DATA_REAL_TYPE right)
 
__INLINE multivar_expressionoperator/= (INMOST_DATA_REAL_TYPE right)
 
bool check_nans () const
 
bool check_infs () const
 
INMOST_DATA_ENUM_TYPE Record (Sparse::Row::entry *v) const
 Write variable into array of entries. More...
 
INMOST_DATA_ENUM_TYPE RecordSize () const
 Number of entries required to record the variable.
 
INMOST_DATA_ENUM_TYPE Retrieve (const Sparse::Row::entry *v)
 Retrieve variable from array of entries. More...
 
void Print (double eps=-1, std::ostream &sout=std::cout) const
 
void swap (multivar_expression &b)
 
- Public Member Functions inherited from INMOST::shell_expression< multivar_expression >
 operator multivar_expression & ()
 
 operator const multivar_expression & () const
 

Static Public Member Functions

static INMOST_DATA_ENUM_TYPE RetrieveSize (const Sparse::Row::entry *v)
 Number of entries used.
 

Friends

class multivar_expression_reference
 

Additional Inherited Members

- Static Protected Attributes inherited from INMOST::basic_expression
static thread_private< Sparse::RowMergermerger
 

Detailed Description

A class that represents a variable with multiple first order variations.

Short type name is variable.

Definition at line 130 of file inmost_expression.h.

Member Function Documentation

◆ Record()

INMOST_DATA_ENUM_TYPE INMOST::multivar_expression::Record ( Sparse::Row::entry v) const
inline

Write variable into array of entries.

Size of array can be determined via RecordSize. Used internally by Mesh::GetData.

Parameters
vArray of entries that will store data of the variable.
Returns
Number of entries used.

Definition at line 349 of file inmost_expression.h.

◆ Retrieve()

INMOST_DATA_ENUM_TYPE INMOST::multivar_expression::Retrieve ( const Sparse::Row::entry v)
inline

Retrieve variable from array of entries.

Size of array without retrieval can be determined via RetrieveSize.

Parameters
vArray of entries that will store data of the variable.
Returns
Number of entries red.

Definition at line 372 of file inmost_expression.h.


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