gum::FormulaPart Class Reference

Represents part of a formula. More...

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

Collaboration diagram for gum::FormulaPart:

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

Public Member Functions
Constructors and destructor
	FormulaPart ()
	Class constructor. More...
	FormulaPart (token_type t, double n)
	Constructor for doubles. More...
	FormulaPart (token_type t, char c)
	Constructor for chars. More...
	FormulaPart (token_type t, token_function func)
	Constructor for functions. More...
	FormulaPart (const FormulaPart &source)
	Copy constructor. More...
	FormulaPart (FormulaPart &&source)
	Move constructor. More...
	~FormulaPart ()
	Class destuctor. More...
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. More...
bool	isLeftAssociative () const
	Returns true if this gum::FormulaPart is left associative. More...
bool	isRightAssociative () const
	Returns true if this gum::FormulaPart is right associative. More...
int	precedence () const
	Returns the precedence priority of the value stored in this gum::FormulaPart. More...
size_t	argc () const
	Returns the number of argument of the function stored in this gum::FormulaPart. More...
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. More...

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...

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 59 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 73 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 62 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 85 of file formula.cpp.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call 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 90 of file formula.cpp.

References gum::Set< Key, Alloc >::emplace().

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

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 95 of file formula.cpp.

References gum::Set< Key, Alloc >::emplace().

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

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 100 of file formula.cpp.

References gum::Set< Key, Alloc >::emplace().

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

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 105 of file formula.cpp.

References gum::Set< Key, Alloc >::emplace().

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

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 111 of file formula.cpp.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call graph for this function:

~FormulaPart()

gum::FormulaPart::~FormulaPart

(

)

Class destuctor.

Definition at line 118 of file formula.cpp.

References gum::Set< Key, Alloc >::emplace().

{ GUM_DESTRUCTOR(FormulaPart); }

Here is the call graph for this function:

Member Function Documentation

argc()

INLINE 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 94 of file formula_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                 {
    switch (type) {
      case OPERATOR: {
        return operator_argc__();
      }

      case FUNCTION: {
        return function_argc__();
      }

      default: {
        GUM_ERROR(OperationNotAllowed, "expecting a function or an operator");
      }
    }
  }

Here is the call graph for this function:

eval()

INLINE 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.

Args are backwards !

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 219 of file formula_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                          {
    switch (type) {
      case OPERATOR: {
        return FormulaPart(token_type::NUMBER, operator_eval__(args));
      }

      case FUNCTION: {
        return FormulaPart(token_type::NUMBER, function_eval__(args));
      }

      default: {
        GUM_ERROR(OperationNotAllowed, "cannot evaluate expression");
      }
    }
  }

Here is the call graph for this function:

function_argc__()

INLINE 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 131 of file formula_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                            {
    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");
      }
    }
  }

Here is the call graph for this function:

function_eval__()

INLINE 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.

Args are backwards !

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 193 of file formula_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                            {
    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::log2(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");
      }
    }
  }

Here is the call graph for this function:

isLeftAssociative()

INLINE 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 32 of file formula_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                            {
    switch (character) {
      case '+':
      case '-':
      case '*':
      case '/': {
        return true;
      }

      case '_': {
        return false;
      }
      case '^': {
        return false;
      }

      default: {
        GUM_ERROR(OperationNotAllowed, "A - not an operator");
      }
    }
  }

Here is the call 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 55 of file formula_inl.h.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call graph for this function:

operator=() [1/2]

FormulaPart & gum::FormulaPart::operator=

(

const FormulaPart &

source

)

Definition at line 120 of file formula.cpp.

References gum::Set< Key, Alloc >::emplace().

                                                               {
    if (this == &source) { return *this; }

    type      = source.type;
    number    = source.number;
    character = source.character;
    function  = source.function;

    return *this;
  }

Here is the call graph for this function:

operator=() [2/2]

FormulaPart & gum::FormulaPart::operator=

(

FormulaPart &&

source

)

Definition at line 131 of file formula.cpp.

References gum::Set< Key, Alloc >::emplace().

                                                          {
    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;
  }

Here is the call graph for this function:

operator_argc__()

INLINE 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 111 of file formula_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                            {
    switch (character) {
      case '_': {
        return (size_t)1;
      }
      case '+':
      case '-':
      case '*':
      case '/':
      case '^': {
        return (size_t)2;
      }

      default: {
        GUM_ERROR(OperationNotAllowed, "C - not an operator");
      }
    }
  }

Here is the call graph for this function:

operator_eval__()

INLINE 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.

Args are backwards !

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 158 of file formula_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                            {
    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");
      }
    }
  }

Here is the call graph for this function:

precedence()

INLINE 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 67 of file formula_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                    {
    switch (character) {
      case '+':
      case '-': {
        return 2;
      }

      case '*':
      case '/': {
        return 3;
      }

      case '^': {
        return 4;
      }

      case '_': {
        return 5;
      }

      default: {
        GUM_ERROR(OperationNotAllowed, "B - not an operator");
      }
    }
  }

Here is the call 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 142 of file formula.cpp.

References gum::Set< Key, Alloc >::emplace().

                                   {
    std::ostringstream s;
    switch (type) {
      case token_type::NUMBER: {
        s << number;
        break;
      }

      case token_type::PARENTHESIS:
      case token_type::OPERATOR: {
        if (character == '\0') {
          s << "\\0";
        } else {
          s << character;
        }
        break;
      }

      case token_type::FUNCTION: {
        s << func2str(function);
        break;
      }

      default: {
        GUM_ERROR(OperationNotAllowed, "unknown type");
      }
    }
    return s.str();
  }

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 94 of file formula.h.

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 95 of file formula.h.

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 93 of file formula.h.

type

token_type gum::FormulaPart::type

The token_type stored by this gum::FormulaPart.

Definition at line 84 of file formula.h.

---

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

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