gum::FormulaPart Class Reference

Represents part of a formula. More...

#include <agrum/base/core/math/formula.h>

Collaboration diagram for gum::FormulaPart:

Public Types
enum	token_type {   NUMBER , OPERATOR , PARENTHESIS , NIL ,   FUNCTION , ARG_SEP }
	The tokens constituting a formula. More...
enum	token_function {   exp , log , ln , pow ,   sqrt , nil }
	The functions allowed in a formula. More...

Public Member Functions
Constructors and destructor
	FormulaPart ()
	Class constructor.
	FormulaPart (token_type t, double n)
	Constructor for doubles.
	FormulaPart (token_type t, char c)
	Constructor for chars.
	FormulaPart (token_type t, token_function func)
	Constructor for functions.
	FormulaPart (const FormulaPart &source)
	Copy constructor.
	FormulaPart (FormulaPart &&source)
	Move constructor.
	~FormulaPart ()
	Class destuctor.
source The gum::FormulaPart to copy.
Move operator. Returns Returns this gum::FormulaPart.
FormulaPart &	operator= (const FormulaPart &source)
FormulaPart &	operator= (FormulaPart &&source)
Getters and setters
std::string	str () const
	Returns a string representation of this gum::FormulaPart value.
bool	isLeftAssociative () const
	Returns true if this gum::FormulaPart is left associative.
bool	isRightAssociative () const
	Returns true if this gum::FormulaPart is right associative.
int	precedence () const
	Returns the precedence priority of the value stored in this gum::FormulaPart.
size_t	argc () const
	Returns the number of argument of the function stored in this gum::FormulaPart.
FormulaPart	eval (const std::vector< FormulaPart > &args) const
	Returns the evaluation of the vector of gum::FormulaPart as arguments of the value stored in this gum::FormulaPart.

Public Attributes
token_type	type
	The token_type stored by this gum::FormulaPart.
double	number
	The value stored by this gum::FormulaPart.
char	character
	The value stored by this gum::FormulaPart.
token_function	function
	The value stored by this gum::FormulaPart.

Private Member Functions
double	_operator_eval_ (const std::vector< FormulaPart > &args) const
	Returns the evaluation of the vector of gum::FormulaPart as arguments of the value stored in this gum::FormulaPart.
double	_function_eval_ (const std::vector< FormulaPart > &args) const
	Returns the evaluation of the vector of gum::FormulaPart as arguments of the value stored in this gum::FormulaPart.
size_t	_operator_argc_ () const
	Returns the number of arguments expected by the operator stored in this gum::FormulaPart.
size_t	_function_argc_ () const
	Returns the number of arguments expected by the function stored in this gum::FormulaPart.

Detailed Description

Represents part of a formula.

This class is used by the gum::Formula class to store intermediate results when solving the formula using the Shuntin-yard algorithm.

Definition at line 79 of file formula.h.

Member Enumeration Documentation

token_function

enum gum::FormulaPart::token_function

The functions allowed in a formula.

Enumerator
exp
log
ln
pow
sqrt
nil

Definition at line 85 of file formula.h.

{ exp, log, ln, pow, sqrt, nil };

token_type

enum gum::FormulaPart::token_type

The tokens constituting a formula.

Enumerator
NUMBER
OPERATOR
PARENTHESIS
NIL
FUNCTION
ARG_SEP

Definition at line 82 of file formula.h.

{ NUMBER, OPERATOR, PARENTHESIS, NIL, FUNCTION, ARG_SEP };

Constructor & Destructor Documentation

FormulaPart() [1/6]

gum::FormulaPart::FormulaPart

(

)

Class constructor.

Definition at line 105 of file formula.cpp.

                           : type(token_type::NIL), number(NAN), character('\0'), function(nil) {
    GUM_CONSTRUCTOR(FormulaPart);
  }

References FormulaPart(), character, function, NIL, nil, number, and type.

Referenced by FormulaPart(), FormulaPart(), FormulaPart(), FormulaPart(), FormulaPart(), FormulaPart(), ~FormulaPart(), eval(), operator=(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

FormulaPart() [2/6]

gum::FormulaPart::FormulaPart	(	token_type	t,
		double	n )

Constructor for doubles.

Parameters

t	The token_type of this gum::FormulaPart.
n	The value of this gum::FormulaPart.

Definition at line 109 of file formula.cpp.

                                                 :
      type(t), number(n), character('\0'), function(nil) {
    GUM_CONSTRUCTOR(FormulaPart);
  }

References FormulaPart(), character, function, nil, number, and type.

Here is the call graph for this function:

FormulaPart() [3/6]

gum::FormulaPart::FormulaPart	(	token_type	t,
		char	c )

Constructor for chars.

Parameters

t	The token_type of this gum::FormulaPart.
c	The value of this gum::FormulaPart.

Definition at line 114 of file formula.cpp.

                                               :
      type(t), number(NAN), character(c), function(nil) {
    GUM_CONSTRUCTOR(FormulaPart);
  }

References FormulaPart(), character, function, nil, number, and type.

Here is the call graph for this function:

FormulaPart() [4/6]

gum::FormulaPart::FormulaPart	(	token_type	t,
		token_function	func )

Constructor for functions.

Parameters

t	The token_type of this gum::FormulaPart.
func	The value of this gum::FormulaPart.

Definition at line 119 of file formula.cpp.

                                                            :
      type(t), number(NAN), character('\0'), function(func) {
    GUM_CONSTRUCTOR(FormulaPart);
  }

References FormulaPart(), character, function, number, and type.

Here is the call graph for this function:

FormulaPart() [5/6]

gum::FormulaPart::FormulaPart

(

const FormulaPart &

source

)

Copy constructor.

Parameters

source

The gum::FormulaPart to copy.

Definition at line 124 of file formula.cpp.

                                                    :
      type(source.type), number(source.number), character(source.character),
      function(source.function) {
    GUM_CONS_CPY(FormulaPart);
  }

References FormulaPart(), character, function, number, and type.

Here is the call graph for this function:

FormulaPart() [6/6]

gum::FormulaPart::FormulaPart

(

FormulaPart &&

source

)

Move constructor.

Parameters

source

The gum::FormulaPart to move.

Definition at line 130 of file formula.cpp.

                                               :
      type(std::move(source.type)), number(std::move(source.number)),
      character(std::move(source.character)), function(std::move(source.function)) {
    GUM_CONS_MOV(FormulaPart);
  }

References FormulaPart(), character, function, number, and type.

Here is the call graph for this function:

~FormulaPart()

gum::FormulaPart::~FormulaPart

(

)

Class destuctor.

Definition at line 136 of file formula.cpp.

                            {
    GUM_DESTRUCTOR(FormulaPart);
    ;
  }

References FormulaPart().

Here is the call graph for this function:

Member Function Documentation

_function_argc_()

size_t gum::FormulaPart::_function_argc_ ( ) const

private

Returns the number of arguments expected by the function stored in this gum::FormulaPart.

Returns

Returns the number of arguments expected by the function stored in this gum::FormulaPart.

Definition at line 421 of file formula.cpp.

                                            {
    switch (function) {
      case FormulaPart::token_function::exp : {
        return 1;
      }
      case FormulaPart::token_function::log : {
        return 1;
      }
      case FormulaPart::token_function::ln : {
        return 1;
      }
      case FormulaPart::token_function::pow : {
        return 2;
      }
      case FormulaPart::token_function::sqrt : {
        return 1;
      }
      // case FormulaPart::token_function::nil: { return "nil"; }
      default : {
        GUM_ERROR(OperationNotAllowed, "unknown function")
      }
    }
  }

References exp, function, GUM_ERROR, ln, log, pow, and sqrt.

Referenced by argc().

Here is the caller graph for this function:

_function_eval_()

double gum::FormulaPart::_function_eval_ ( const std::vector< FormulaPart > & args ) const

private

Returns the evaluation of the vector of gum::FormulaPart as arguments of the value stored in this gum::FormulaPart.

Warning

Args must be backwards !

Parameters

args	The arguments, in backards, passed to the value stored in this gum::FormulaPart.

Returns

Returns the evaluation of the vector of gum::FormulaPart as arguments of the value stored in this gum::FormulaPart.

Exceptions

OperationNotAllowed

Raised if the value stored is not a function.

Definition at line 477 of file formula.cpp.

                                                                                {
    switch (function) {
      case FormulaPart::token_function::exp : {
        return std::exp(args[0].number);
      }
      case FormulaPart::token_function::log : {
        return std::log(args[0].number);
      }
      case FormulaPart::token_function::ln : {
        return std::log(args[0].number);
      }
      case FormulaPart::token_function::pow : {
        return std::pow(args[1].number, args[0].number);
      }
      case FormulaPart::token_function::sqrt : {
        return std::sqrt(args[0].number);
      }
      // case FormulaPart::token_function::nil: { return "nil"; }
      default : {
        GUM_ERROR(OperationNotAllowed, "unknown function")
      }
    }
  }

References exp, function, GUM_ERROR, ln, log, number, pow, and sqrt.

Referenced by eval().

Here is the caller graph for this function:

_operator_argc_()

size_t gum::FormulaPart::_operator_argc_ ( ) const

private

Returns the number of arguments expected by the operator stored in this gum::FormulaPart.

Returns

Returns the number of arguments expected by the operator stored in this gum::FormulaPart.

Definition at line 402 of file formula.cpp.

                                            {
    switch (character) {
      case '_' : {
        return (size_t)1;
      }
      case '+' :
      case '-' :
      case '*' :
      case '/' :
      case '^' : {
        return (size_t)2;
      }
 
      default : {
        GUM_ERROR(OperationNotAllowed, "C - not an operator")
      }
    }
  }

References character, and GUM_ERROR.

Referenced by argc().

Here is the caller graph for this function:

_operator_eval_()

double gum::FormulaPart::_operator_eval_ ( const std::vector< FormulaPart > & args ) const

private

Returns the evaluation of the vector of gum::FormulaPart as arguments of the value stored in this gum::FormulaPart.

Warning

Args must be backwards !

Parameters

args	The arguments, in backards, passed to the value stored in this gum::FormulaPart.

Returns

Returns the evaluation of the vector of gum::FormulaPart as arguments of the value stored in this gum::FormulaPart.

Exceptions

OperationNotAllowed

Raised if the value stored is not an operator.

Definition at line 445 of file formula.cpp.

                                                                                {
    switch (character) {
      case '+' : {
        return args[1].number + args[0].number;
      }
 
      case '-' : {
        return args[1].number - args[0].number;
      }
 
      case '*' : {
        return args[1].number * args[0].number;
      }
 
      case '/' : {
        return args[1].number / args[0].number;
      }
 
      case '^' : {
        return std::pow(args[1].number, args[0].number);
      }
 
      case '_' : {
        return 0 - args[0].number;
      }
 
      default : {
        GUM_ERROR(OperationNotAllowed, "D - not an operator")
      }
    }
  }

References character, GUM_ERROR, and number.

Referenced by eval().

Here is the caller graph for this function:

argc()

size_t gum::FormulaPart::argc

(

)

const

Returns the number of argument of the function stored in this gum::FormulaPart.

Returns

Returns the number of argument of the function stored in this gum::FormulaPart.

Exceptions

OperationNotAllowed

Raised if the value stored is not a function.

Definition at line 386 of file formula.cpp.

                                 {
    switch (type) {
      case OPERATOR : {
        return _operator_argc_();
      }
 
      case FUNCTION : {
        return _function_argc_();
      }
 
      default : {
        GUM_ERROR(OperationNotAllowed, "expecting a function or an operator")
      }
    }
  }

References _function_argc_(), _operator_argc_(), FUNCTION, GUM_ERROR, OPERATOR, and type.

Referenced by gum::Formula::_reduceOperatorOrFunction_().

Here is the call graph for this function:

Here is the caller graph for this function:

eval()

FormulaPart gum::FormulaPart::eval

(

const std::vector< FormulaPart > &

args

)

const

Returns the evaluation of the vector of gum::FormulaPart as arguments of the value stored in this gum::FormulaPart.

Warning

Args must be backwards !

Parameters

args	The arguments, in backards, passed to the value stored in this gum::FormulaPart.

Returns

Returns the evaluation of the vector of gum::FormulaPart as arguments of the value stored in this gum::FormulaPart.

Exceptions

OperationNotAllowed

Raised if the value stored is neither a function nor an operator.

Definition at line 501 of file formula.cpp.

                                                                          {
    switch (type) {
      case OPERATOR : {
        return {token_type::NUMBER, _operator_eval_(args)};
      }
 
      case FUNCTION : {
        return {token_type::NUMBER, _function_eval_(args)};
      }
 
      default : {
        GUM_ERROR(OperationNotAllowed, "cannot evaluate expression")
      }
    }
  }

References FormulaPart(), _function_eval_(), _operator_eval_(), FUNCTION, GUM_ERROR, NUMBER, OPERATOR, and type.

Referenced by gum::Formula::_reduceOperatorOrFunction_().

Here is the call graph for this function:

Here is the caller graph for this function:

isLeftAssociative()

bool gum::FormulaPart::isLeftAssociative

(

)

const

Returns true if this gum::FormulaPart is left associative.

Returns

Returns true if this gum::FormulaPart is left associative.

Exceptions

OperationNotAllowed

Raised if the value stored is not an operator.

Definition at line 338 of file formula.cpp.

                                            {
    switch (character) {
      case '+' :
      case '-' :
      case '*' :
      case '/' : {
        return true;
      }
 
      case '_' : {
        return false;
      }
      case '^' : {
        return false;
      }
 
      default : {
        GUM_ERROR(OperationNotAllowed, "A - not an operator")
      }
    }
  }

References character, and GUM_ERROR.

Referenced by gum::Formula::_popOperator_(), and isRightAssociative().

Here is the caller graph for this function:

isRightAssociative()

INLINE bool gum::FormulaPart::isRightAssociative

(

)

const

Returns true if this gum::FormulaPart is right associative.

Returns

Returns true if this gum::FormulaPart is right associative.

Exceptions

OperationNotAllowed

Raised if the value stored is not an operator.

Definition at line 54 of file formula_inl.h.

                                             {
    switch (character) {
      case '_' : {
        return false;
      }
      default : {
        return !isLeftAssociative();
      }
    }
  }

References character, and isLeftAssociative().

Referenced by gum::Formula::_popOperator_().

Here is the call graph for this function:

Here is the caller graph for this function:

operator=() [1/2]

FormulaPart & gum::FormulaPart::operator=

(

const FormulaPart &

source

)

Definition at line 141 of file formula.cpp.

                                                             {
    if (this == &source) { return *this; }
 
    type      = source.type;
    number    = source.number;
    character = source.character;
    function  = source.function;
 
    return *this;
  }

References FormulaPart(), character, function, number, and type.

Here is the call graph for this function:

operator=() [2/2]

FormulaPart & gum::FormulaPart::operator=

(

FormulaPart &&

source

)

Definition at line 152 of file formula.cpp.

                                                        {
    if (this == &source) { return *this; }
 
    type      = std::move(source.type);
    number    = std::move(source.number);
    character = std::move(source.character);
    function  = std::move(source.function);
 
    return *this;
  }

References FormulaPart(), character, function, number, and type.

Here is the call graph for this function:

precedence()

int gum::FormulaPart::precedence

(

)

const

Returns the precedence priority of the value stored in this gum::FormulaPart.

Returns

Returns the precedence priority of the value stored in this gum::FormulaPart.

Exceptions

OperationNotAllowed

Raised if the value stored is not an operator.

Definition at line 360 of file formula.cpp.

                                    {
    switch (character) {
      case '+' :
      case '-' : {
        return 2;
      }
 
      case '*' :
      case '/' : {
        return 3;
      }
 
      case '^' : {
        return 4;
      }
 
      case '_' : {
        return 5;
      }
 
      default : {
        GUM_ERROR(OperationNotAllowed, "B - not an operator")
      }
    }
  }

References character, and GUM_ERROR.

Referenced by gum::Formula::_popOperator_().

Here is the caller graph for this function:

str()

std::string gum::FormulaPart::str

(

)

const

Returns a string representation of this gum::FormulaPart value.

Returns

Returns a string representation of this gum::FormulaPart value.

Definition at line 163 of file formula.cpp.

                                   {
    switch (type) {
      case token_type::NUMBER : {
        return std::format("{}", number);
      }
 
      case token_type::PARENTHESIS :
      case token_type::OPERATOR : {
        return (character == '\0') ? "\\0" : std::string(1, character);
      }
 
      case token_type::FUNCTION : {
        return func2str(function);
      }
 
      default : {
        GUM_ERROR(OperationNotAllowed, "unknown type")
      }
    }
  }

References character, gum::func2str(), FUNCTION, function, GUM_ERROR, NUMBER, number, OPERATOR, PARENTHESIS, and type.

Here is the call graph for this function:

Member Data Documentation

character

char gum::FormulaPart::character

The value stored by this gum::FormulaPart.

Warning

Only one of these three members will hold the value, given the type of this gum::FormulaPart.

Definition at line 98 of file formula.h.

Referenced by FormulaPart(), FormulaPart(), FormulaPart(), FormulaPart(), FormulaPart(), FormulaPart(), _operator_argc_(), _operator_eval_(), isLeftAssociative(), isRightAssociative(), operator=(), operator=(), precedence(), and str().

function

token_function gum::FormulaPart::function

The value stored by this gum::FormulaPart.

Warning

Only one of these three members will hold the value, given the type of this gum::FormulaPart.

Definition at line 99 of file formula.h.

Referenced by FormulaPart(), FormulaPart(), FormulaPart(), FormulaPart(), FormulaPart(), FormulaPart(), _function_argc_(), _function_eval_(), operator=(), operator=(), and str().

number

double gum::FormulaPart::number

The value stored by this gum::FormulaPart.

Warning

Only one of these three members will hold the value, given the type of this gum::FormulaPart.

Definition at line 97 of file formula.h.

Referenced by FormulaPart(), FormulaPart(), FormulaPart(), FormulaPart(), FormulaPart(), FormulaPart(), _function_eval_(), _operator_eval_(), operator=(), operator=(), and str().

type

token_type gum::FormulaPart::type

The token_type stored by this gum::FormulaPart.

Definition at line 88 of file formula.h.

Referenced by FormulaPart(), FormulaPart(), FormulaPart(), FormulaPart(), FormulaPart(), FormulaPart(), argc(), eval(), operator=(), operator=(), and str().

---

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

• agrum/base/core/math/formula.h
• agrum/base/core/math/formula.cpp
• agrum/base/core/math/formula_inl.h