NumeRe v1.1.4
NumeRe: Framework für Numerische Rechnungen
mu::ParserInt Class Reference

Mathematical expressions parser. More...

#include <muParserInt.h>

Inheritance diagram for mu::ParserInt:
Collaboration diagram for mu::ParserInt:

Classes

class  change_dec_sep
 A facet class used to change decimal and thousands separator. More...
 

Public Member Functions

 ParserInt ()
 Constructor. More...
 
virtual void InitFun ()
 Initialize the default functions. More...
 
virtual void InitOprt ()
 Initialize operators. More...
 
virtual void InitConst ()
 
virtual void InitCharSets ()
 
- Public Member Functions inherited from mu::ParserBase
void ActivateLoopMode (unsigned int _nLoopLength)
 Activates the loop mode and prepares the internal arrays for storing the necessary data. More...
 
void DeactivateLoopMode ()
 Deactivates the loop mode and resets the internal arrays. More...
 
void SetIndex (unsigned int _nLoopElement)
 Activates the selected position in the internally stored bytecode. More...
 
void SetCompiling (bool _bCompiling=true)
 Activate the compiling step for the parser. More...
 
bool IsCompiling ()
 Returns true, if the parser is currently in compiling step. More...
 
void CacheCurrentAccess (const CachedDataAccess &_access)
 Store the passed data access for this position internally. More...
 
size_t HasCachedAccess ()
 Evaluate, whether there are any cached data accesses for this position. More...
 
void DisableAccessCaching ()
 Disable the data access caching for this position. More...
 
bool CanCacheAccess ()
 Check, whether the current position can cache any data accesses. More...
 
const CachedDataAccessGetCachedAccess (size_t nthAccess)
 Returns the cached data access for the passed position. More...
 
void CacheCurrentEquation (const std::string &sEquation)
 Caches the passed equation for this position. More...
 
const std::string & GetCachedEquation () const
 Returns the stored equation for this position. More...
 
void CacheCurrentTarget (const std::string &sEquation)
 Caches the passed target equation for this position. More...
 
const std::string & GetCachedTarget () const
 Returns the stored target equation for this position. More...
 
int IsValidByteCode (unsigned int _nthLoopElement=-1, unsigned int _nthPartEquation=0)
 This member function returns, whether the current equation is already parsed and there's a valid bytecode for it. More...
 
bool ActiveLoopMode () const
 Check, whether the loop mode is active. This function returns true even if the loop mode is paused. More...
 
bool IsLockedPause () const
 Check, whether the pause mode is locked. More...
 
void LockPause (bool _bLock=true)
 This member function locks the pause mode so that it cannot be accidentally activated. More...
 
void PauseLoopMode (bool _bPause=true)
 This member function pauses the loop mode, so that the new assigned equation does not invalidate already parsed equations. More...
 
bool IsAlreadyParsed (StringView sNewEquation)
 This member function checks, whether the passed expression is already parsed, so that the parsing step may be omitted. More...
 
bool IsNotLastStackItem () const
 Check, whether there are more elements on the parsing stack remaining. More...
 
 ParserBase ()
 Constructor. More...
 
 ParserBase (const ParserBase &a_Parser)
 Copy constructor. More...
 
ParserBaseoperator= (const ParserBase &a_Parser)
 Assignement operator. More...
 
virtual ~ParserBase ()
 
value_type Eval ()
 Single-value wrapper around the vectorized overload of this member function. More...
 
value_typeEval (int &nStackSize)
 Evaluate an expression containing comma seperated subexpressions. More...
 
void Eval (value_type *results, int nBulkSize)
 This member function evaluates the expression in parallel. Is not used at the moment. More...
 
void SetExpr (StringView a_sExpr)
 Set the expression. Triggers first time calculation thus the creation of the bytecode and scanning of used variables. More...
 
void SetVarFactory (facfun_type a_pFactory, void *pUserData=NULL)
 Set a function that can create variable pointer for unknown expression variables. More...
 
void SetDecSep (char_type cDecSep)
 Set the decimal separator. More...
 
void SetThousandsSep (char_type cThousandsSep=0)
 Sets the thousands operator. More...
 
void ResetLocale ()
 Resets the locale. More...
 
void EnableOptimizer (bool a_bIsOn=true)
 Enable or disable the formula optimization feature. More...
 
void EnableBuiltInOprt (bool a_bIsOn=true)
 Enable or disable the built in binary operators. More...
 
bool HasBuiltInOprt () const
 Query status of built in variables. More...
 
void AddValIdent (identfun_type a_pCallback)
 Add a value parsing function. More...
 
template<typename T >
void DefineFun (const string_type &a_strName, T a_pFun, bool optimizeAway=true)
 Define a parser function without arguments. More...
 
void DefineOprt (const string_type &a_strName, fun_type2 a_pFun, unsigned a_iPri=0, EOprtAssociativity a_eAssociativity=oaLEFT, bool optimizeAway=true)
 Define a binary operator. More...
 
void DefineConst (const string_type &a_sName, value_type a_fVal)
 Add a user defined constant. More...
 
void DefineStrConst (const string_type &a_sName, const string_type &a_strVal)
 Define a new string constant. More...
 
void DefineVar (const string_type &a_sName, value_type *a_fVar)
 Add a user defined variable. More...
 
void DefinePostfixOprt (const string_type &a_strFun, fun_type1 a_pOprt, bool optimizeAway=true)
 Add a user defined operator. More...
 
void DefineInfixOprt (const string_type &a_strName, fun_type1 a_pOprt, int a_iPrec=prINFIX, bool optimizeAway=true)
 Add a user defined operator. More...
 
void ClearVar ()
 Clear all user defined variables. More...
 
void ClearFun ()
 Clear all functions. More...
 
void ClearConst ()
 Clear all user defined constants. More...
 
void ClearInfixOprt ()
 Clear the user defined Prefix operators. More...
 
void ClearPostfixOprt ()
 Clear all user defined postfix operators. More...
 
void ClearOprt ()
 Clear all user defined binary operators. More...
 
void RemoveVar (const string_type &a_strVarName)
 Remove a variable from internal storage. More...
 
const varmap_typeGetUsedVar ()
 Return a map containing the used variables only. More...
 
const varmap_typeGetVar () const
 Return a map containing the used variables only. More...
 
const valmap_typeGetConst () const
 Return a map containing all parser constants. More...
 
const string_typeGetExpr () const
 Retrieve the formula. More...
 
const funmap_typeGetFunDef () const
 Return prototypes of all parser functions. More...
 
const std::map< std::string, std::vector< mu::value_type > > & GetVectors () const
 
string_type GetVersion (EParserVersionInfo eInfo=pviFULL) const
 Returns the version of muparser. More...
 
const char_type ** GetOprtDef () const
 Get the default symbols used for the built in operators. More...
 
void DefineNameChars (const char_type *a_szCharset)
 Define the set of valid characters to be used in names of functions, variables, constants. More...
 
void DefineOprtChars (const char_type *a_szCharset)
 Define the set of valid characters to be used in names of binary operators and postfix operators. More...
 
void DefineInfixOprtChars (const char_type *a_szCharset)
 Define the set of valid characters to be used in names of infix operators. More...
 
const char_typeValidNameChars () const
 Virtual function that defines the characters allowed in name identifiers. More...
 
const char_typeValidOprtChars () const
 Virtual function that defines the characters allowed in operator definitions. More...
 
const char_typeValidInfixOprtChars () const
 Virtual function that defines the characters allowed in infix operator definitions. More...
 
void SetArgSep (char_type cArgSep)
 Set argument separator. More...
 
char_type GetArgSep () const
 Get the argument separator character. More...
 
void Error (EErrorCodes a_iErrc, int a_iPos=(int) mu::string_type::npos, const string_type &a_strTok=string_type()) const
 Create an error containing the parse error position. More...
 
void Error (EErrorCodes a_iErrc, const string_type &a_Expr, int a_iPos=(int) mu::string_type::npos, const string_type &a_strTok=string_type()) const
 Create an error containing the parse error position. More...
 
string_type CreateTempVectorVar (const std::vector< mu::value_type > &vVar)
 This member function copies the passed vector into the internal storage referencing it with a auto-generated variable name. More...
 
void SetVectorVar (const std::string &sVarName, const std::vector< mu::value_type > &vVar, bool bAddVectorType=false)
 This member function copies the passed vector into the internal storage referencing it with the passed name. More...
 
std::vector< mu::value_type > * GetVectorVar (const std::string &sVarName)
 This member function returns a pointer to the vector stored internally. More...
 
void UpdateVectorVar (const std::string &sVarName)
 This member function updates the corresponding variable of a vector with the previously newly assigned value. More...
 
void ClearVectorVars (bool bIgnoreProcedureVects=false)
 This member function cleares the internal vector storage. More...
 
bool ContainsVectorVars (StringView sExpr, bool ignoreSingletons)
 This member function checks, whether the passed expression contains a vector. More...
 

Static Private Member Functions

static int Round (value_type v)
 
static value_type Abs (value_type)
 
static value_type Sign (value_type)
 
static value_type Ite (value_type, value_type, value_type)
 
static value_type UnaryMinus (value_type)
 
static value_type Sum (const value_type *a_afArg, int a_iArgc)
 
static value_type Min (const value_type *a_afArg, int a_iArgc)
 
static value_type Max (const value_type *a_afArg, int a_iArgc)
 
static value_type Add (value_type v1, value_type v2)
 
static value_type Sub (value_type v1, value_type v2)
 
static value_type Mul (value_type v1, value_type v2)
 
static value_type Div (value_type v1, value_type v2)
 
static value_type Mod (value_type v1, value_type v2)
 
static value_type Pow (value_type v1, value_type v2)
 
static value_type Shr (value_type v1, value_type v2)
 
static value_type Shl (value_type v1, value_type v2)
 
static value_type LogAnd (value_type v1, value_type v2)
 
static value_type LogOr (value_type v1, value_type v2)
 
static value_type And (value_type v1, value_type v2)
 
static value_type Or (value_type v1, value_type v2)
 
static value_type Xor (value_type v1, value_type v2)
 
static value_type Less (value_type v1, value_type v2)
 
static value_type Greater (value_type v1, value_type v2)
 
static value_type LessEq (value_type v1, value_type v2)
 
static value_type GreaterEq (value_type v1, value_type v2)
 
static value_type Equal (value_type v1, value_type v2)
 
static value_type NotEqual (value_type v1, value_type v2)
 
static value_type Not (value_type v1)
 
static int IsHexVal (const char_type *a_szExpr, int *a_iPos, value_type *a_iVal)
 Check a given position in the expression for the presence of a hex value. More...
 
static int IsBinVal (const char_type *a_szExpr, int *a_iPos, value_type *a_iVal)
 
static int IsVal (const char_type *a_szExpr, int *a_iPos, value_type *a_iVal)
 

Additional Inherited Members

- Public Types inherited from mu::ParserBase
typedef ParserError exception_type
 Type of the error class. More...
 
- Static Public Member Functions inherited from mu::ParserBase
static void EnableDebugDump (bool bDumpCmd, bool bDumpStack)
 Enable the dumping of bytecode amd stack content on the console. More...
 
- Public Attributes inherited from mu::ParserBase
std::map< std::string, std::string > * mVarMapPntr
 
std::list< mu::value_type * > m_lDataStorage
 
- Protected Member Functions inherited from mu::ParserBase
void Init ()
 Initialize user defined functions. More...
 
virtual void InitCharSets ()=0
 
virtual void InitFun ()=0
 
virtual void InitConst ()=0
 
virtual void InitOprt ()=0
 
virtual void OnDetectVar (string_type *pExpr, int &nStart, int &nEnd)
 
- Static Protected Attributes inherited from mu::ParserBase
static const char_typec_DefaultOprt []
 Identifiers for built in binary operators. More...
 
static std::locale s_locale = std::locale(std::locale::classic(), new change_dec_sep<char_type>('.'))
 The locale used by the parser. More...
 
static bool g_DbgDumpCmdCode = false
 
static bool g_DbgDumpStack = false
 

Detailed Description

Mathematical expressions parser.

This version of the parser handles only integer numbers. It disables the built in operators thus it is slower than muParser. Integer values are stored in the double value_type and converted if needed.

Definition at line 46 of file muParserInt.h.

Constructor & Destructor Documentation

◆ ParserInt()

mu::ParserInt::ParserInt ( )

Constructor.

Call ParserBase class constructor and trigger Function, Operator and Constant initialization.

Definition at line 206 of file muParserInt.cpp.

References mu::ParserBase::AddValIdent(), InitCharSets(), InitFun(), InitOprt(), IsBinVal(), IsHexVal(), and IsVal().

Here is the call graph for this function:

Member Function Documentation

◆ Abs()

value_type mu::ParserInt::Abs ( value_type  v)
staticprivate

Definition at line 41 of file muParserInt.cpp.

References Round().

Referenced by InitFun().

Here is the call graph for this function:

◆ Add()

value_type mu::ParserInt::Add ( value_type  v1,
value_type  v2 
)
staticprivate

Definition at line 46 of file muParserInt.cpp.

References Round().

Referenced by InitOprt().

Here is the call graph for this function:

◆ And()

value_type mu::ParserInt::And ( value_type  v1,
value_type  v2 
)
staticprivate

Definition at line 55 of file muParserInt.cpp.

References Round().

Referenced by InitOprt().

Here is the call graph for this function:

◆ Div()

value_type mu::ParserInt::Div ( value_type  v1,
value_type  v2 
)
staticprivate

Definition at line 49 of file muParserInt.cpp.

References Round().

Referenced by InitOprt().

Here is the call graph for this function:

◆ Equal()

value_type mu::ParserInt::Equal ( value_type  v1,
value_type  v2 
)
staticprivate

Definition at line 61 of file muParserInt.cpp.

References Round().

Referenced by InitOprt().

Here is the call graph for this function:

◆ Greater()

value_type mu::ParserInt::Greater ( value_type  v1,
value_type  v2 
)
staticprivate

Definition at line 58 of file muParserInt.cpp.

References Round().

Referenced by InitOprt().

Here is the call graph for this function:

◆ GreaterEq()

value_type mu::ParserInt::GreaterEq ( value_type  v1,
value_type  v2 
)
staticprivate

Definition at line 60 of file muParserInt.cpp.

References Round().

Referenced by InitOprt().

Here is the call graph for this function:

◆ InitCharSets()

void mu::ParserInt::InitCharSets ( )
virtual

Implements mu::ParserBase.

Definition at line 224 of file muParserInt.cpp.

References _nrT, mu::ParserBase::DefineInfixOprtChars(), mu::ParserBase::DefineNameChars(), and mu::ParserBase::DefineOprtChars().

Referenced by ParserInt().

Here is the call graph for this function:

◆ InitConst()

void mu::ParserInt::InitConst ( )
virtual

Implements mu::ParserBase.

Definition at line 219 of file muParserInt.cpp.

◆ InitFun()

void mu::ParserInt::InitFun ( )
virtual

Initialize the default functions.

Implements mu::ParserBase.

Definition at line 233 of file muParserInt.cpp.

References _nrT, Abs(), mu::ParserBase::DefineFun(), Ite(), Max(), Min(), Sign(), and Sum().

Referenced by ParserInt().

Here is the call graph for this function:

◆ InitOprt()

void mu::ParserInt::InitOprt ( )
virtual

Initialize operators.

Implements mu::ParserBase.

Definition at line 245 of file muParserInt.cpp.

References _nrT, Add(), And(), mu::ParserBase::DefineInfixOprt(), mu::ParserBase::DefineOprt(), Div(), mu::ParserBase::EnableBuiltInOprt(), Equal(), Greater(), GreaterEq(), Less(), LessEq(), LogAnd(), LogOr(), Mod(), Mul(), Not(), NotEqual(), mu::oaRIGHT, Or(), Pow(), mu::prADD_SUB, mu::prCMP, mu::prLOGIC, mu::prMUL_DIV, mu::prPOW, Shl(), Shr(), Sub(), and UnaryMinus().

Referenced by ParserInt().

Here is the call graph for this function:

◆ IsBinVal()

int mu::ParserInt::IsBinVal ( const char_type a_szExpr,
int *  a_iPos,
value_type a_iVal 
)
staticprivate

Definition at line 177 of file muParserInt.cpp.

References _nrT.

Referenced by ParserInt().

◆ IsHexVal()

int mu::ParserInt::IsHexVal ( const char_type a_szExpr,
int *  a_iPos,
value_type a_fVal 
)
staticprivate

Check a given position in the expression for the presence of a hex value.

Parameters
a_szExprPointer to the expression string
[in/out]a_iPos Pointer to an interger value holding the current parsing position in the expression.
[out]a_fValPointer to the position where the detected value shall be stored.

Hey values must be prefixed with "0x" in order to be detected properly.

Definition at line 155 of file muParserInt.cpp.

References fast_float::hex.

Referenced by ParserInt().

◆ IsVal()

int mu::ParserInt::IsVal ( const char_type a_szExpr,
int *  a_iPos,
value_type a_iVal 
)
staticprivate

Definition at line 118 of file muParserInt.cpp.

References _nrT.

Referenced by ParserInt().

◆ Ite()

value_type mu::ParserInt::Ite ( value_type  v1,
value_type  v2,
value_type  v3 
)
staticprivate

Definition at line 43 of file muParserInt.cpp.

References Round().

Referenced by InitFun().

Here is the call graph for this function:

◆ Less()

value_type mu::ParserInt::Less ( value_type  v1,
value_type  v2 
)
staticprivate

Definition at line 57 of file muParserInt.cpp.

References Round().

Referenced by InitOprt().

Here is the call graph for this function:

◆ LessEq()

value_type mu::ParserInt::LessEq ( value_type  v1,
value_type  v2 
)
staticprivate

Definition at line 59 of file muParserInt.cpp.

References Round().

Referenced by InitOprt().

Here is the call graph for this function:

◆ LogAnd()

value_type mu::ParserInt::LogAnd ( value_type  v1,
value_type  v2 
)
staticprivate

Definition at line 53 of file muParserInt.cpp.

References Round().

Referenced by InitOprt().

Here is the call graph for this function:

◆ LogOr()

value_type mu::ParserInt::LogOr ( value_type  v1,
value_type  v2 
)
staticprivate

Definition at line 54 of file muParserInt.cpp.

References Round().

Referenced by InitOprt().

Here is the call graph for this function:

◆ Max()

value_type mu::ParserInt::Max ( const value_type a_afArg,
int  a_iArgc 
)
staticprivate

Definition at line 104 of file muParserInt.cpp.

References _nrT, and max.

Referenced by InitFun().

◆ Min()

value_type mu::ParserInt::Min ( const value_type a_afArg,
int  a_iArgc 
)
staticprivate

Definition at line 91 of file muParserInt.cpp.

References _nrT, and min.

Referenced by InitFun().

◆ Mod()

value_type mu::ParserInt::Mod ( value_type  v1,
value_type  v2 
)
staticprivate

Definition at line 50 of file muParserInt.cpp.

References Round().

Referenced by InitOprt().

Here is the call graph for this function:

◆ Mul()

value_type mu::ParserInt::Mul ( value_type  v1,
value_type  v2 
)
staticprivate

Definition at line 48 of file muParserInt.cpp.

References Round().

Referenced by InitOprt().

Here is the call graph for this function:

◆ Not()

value_type mu::ParserInt::Not ( value_type  v1)
staticprivate

Definition at line 63 of file muParserInt.cpp.

References Round().

Referenced by InitOprt().

Here is the call graph for this function:

◆ NotEqual()

value_type mu::ParserInt::NotEqual ( value_type  v1,
value_type  v2 
)
staticprivate

Definition at line 62 of file muParserInt.cpp.

References Round().

Referenced by InitOprt().

Here is the call graph for this function:

◆ Or()

value_type mu::ParserInt::Or ( value_type  v1,
value_type  v2 
)
staticprivate

Definition at line 56 of file muParserInt.cpp.

References Round().

Referenced by InitOprt().

Here is the call graph for this function:

◆ Pow()

value_type mu::ParserInt::Pow ( value_type  v1,
value_type  v2 
)
staticprivate

Definition at line 65 of file muParserInt.cpp.

References Round().

Referenced by InitOprt().

Here is the call graph for this function:

◆ Round()

static int mu::ParserInt::Round ( value_type  v)
inlinestaticprivate

◆ Shl()

value_type mu::ParserInt::Shl ( value_type  v1,
value_type  v2 
)
staticprivate

Definition at line 52 of file muParserInt.cpp.

References Round().

Referenced by InitOprt().

Here is the call graph for this function:

◆ Shr()

value_type mu::ParserInt::Shr ( value_type  v1,
value_type  v2 
)
staticprivate

Definition at line 51 of file muParserInt.cpp.

References Round().

Referenced by InitOprt().

Here is the call graph for this function:

◆ Sign()

value_type mu::ParserInt::Sign ( value_type  v)
staticprivate

Definition at line 42 of file muParserInt.cpp.

References Round().

Referenced by InitFun().

Here is the call graph for this function:

◆ Sub()

value_type mu::ParserInt::Sub ( value_type  v1,
value_type  v2 
)
staticprivate

Definition at line 47 of file muParserInt.cpp.

References Round().

Referenced by InitOprt().

Here is the call graph for this function:

◆ Sum()

value_type mu::ParserInt::Sum ( const value_type a_afArg,
int  a_iArgc 
)
staticprivate

Definition at line 78 of file muParserInt.cpp.

References _nrT.

Referenced by InitFun().

◆ UnaryMinus()

value_type mu::ParserInt::UnaryMinus ( value_type  v)
staticprivate

Definition at line 72 of file muParserInt.cpp.

References Round().

Referenced by InitOprt().

Here is the call graph for this function:

◆ Xor()

static value_type mu::ParserInt::Xor ( value_type  v1,
value_type  v2 
)
staticprivate

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