olb::Expr Class Reference

Basic value-substitute enabling extraction of expression trees for code generation. More...

#include <expr.h>

Inheritance diagram for olb::Expr:

Collaboration diagram for olb::Expr:

Public Types
enum struct	Op : std::size_t {   Add , Mul , Sub , Div ,   Sqrt , Abs , Pow , Exp ,   End }

Public Member Functions
	Expr ()
	Expr (Expr &&rhs)
	Expr (const Expr &rhs)
	Expr (double v)
	Expr (std::string name)
	Expr (Expr lhs, Op op, Expr rhs)
	Expr (Op op, Expr rhs)
Expr &	operator= (const Expr &rhs)
Expr &	operator+= (Expr rhs)
Expr &	operator-= (Expr rhs)
Expr &	operator*= (Expr rhs)
Expr &	operator/= (Expr rhs)
void	describe (std::stringstream &out) const
	Writes the serialized expression tree to out.
std::string	describe () const
	Returns the serialized expression tree.
bool	isSymbol (std::string name) const
	Helper function to quickly check if Expr is a specific symbol.
std::size_t	size () const
	Returns expanded size of tree.

Static Public Member Functions
static void	reset ()
	Resets FLOP counter.
static void	increment (Op op)
	Increment FLOP counter.
static std::size_t	count ()
	Return accumulated FLOPs.
static std::size_t	count (Op op)
	Return accumulated FLOPs of type.

Detailed Description

Basic value-substitute enabling extraction of expression trees for code generation.

Definition at line 39 of file expr.h.

Member Enumeration Documentation

Op

enum struct olb::Expr::Op : std::size_t

strong

Enumerator
Add
Mul
Sub
Div
Sqrt
Abs
Pow
Exp
End

Definition at line 41 of file expr.h.

                 : std::size_t {
    Add, Mul, Sub, Div, Sqrt, Abs, Pow, Exp,
    End // keep last
  };

Constructor & Destructor Documentation

Expr() [1/7]

olb::Expr::Expr

(

)

Definition at line 94 of file expr.cpp.

          :
  _payload(Constant{}) { }

Expr() [2/7]

olb::Expr::Expr

(

Expr &&

rhs

)

Definition at line 97 of file expr.cpp.

                    :
  _payload(rhs._payload) { }

Expr() [3/7]

olb::Expr::Expr

(

const Expr &

rhs

)

Definition at line 100 of file expr.cpp.

                         :
  _payload(rhs._payload) { }

Expr() [4/7]

olb::Expr::Expr

(

double

v

)

Definition at line 103 of file expr.cpp.

                  :
  _payload(Constant{v}) { }

Expr() [5/7]

olb::Expr::Expr

(

std::string

name

)

Definition at line 106 of file expr.cpp.

                        :
  _payload(Symbol{name}) { }

Expr() [6/7]

olb::Expr::Expr	(	Expr	lhs,
		Op	op,
		Expr	rhs )

Definition at line 109 of file expr.cpp.

                                   :
  _payload(Binary(lhs, op, rhs)) { }

Expr() [7/7]

olb::Expr::Expr	(	Op	op,
		Expr	rhs )

Definition at line 112 of file expr.cpp.

                         :
  _payload(Unary(op, rhs)) { }

Member Function Documentation

count() [1/2]

static std::size_t olb::Expr::count ( )

inlinestatic

Return accumulated FLOPs.

Definition at line 133 of file expr.h.

                           {
    return std::accumulate(_stats.cbegin(), _stats.cend(), 0);
  }

Here is the caller graph for this function:

count() [2/2]

static std::size_t olb::Expr::count ( Op op )

inlinestatic

Return accumulated FLOPs of type.

Definition at line 138 of file expr.h.

                                {
    return _stats[static_cast<std::size_t>(op)];
  }

describe() [1/2]

std::string olb::Expr::describe

(

)

const

Returns the serialized expression tree.

Definition at line 150 of file expr.cpp.

                               {
  std::stringstream out;
  describe(out);
  return out.str();
};

References describe().

Here is the call graph for this function:

Here is the caller graph for this function:

describe() [2/2]

void olb::Expr::describe

(

std::stringstream &

out

)

const

Writes the serialized expression tree to out.

Definition at line 144 of file expr.cpp.

                                              {
  std::visit([&out](auto& x) {
    x.describe(out);
  }, _payload);
};

increment()

static void olb::Expr::increment ( Op op )

inlinestatic

Increment FLOP counter.

Definition at line 128 of file expr.h.

                               {
    ++_stats[static_cast<std::size_t>(op)];
  }

Here is the caller graph for this function:

isSymbol()

bool olb::Expr::isSymbol

(

std::string

name

)

const

Helper function to quickly check if Expr is a specific symbol.

Definition at line 156 of file expr.cpp.

                                        {
  if (auto symbol = std::get_if<Symbol>(&_payload)) {
    return (*symbol).name == name;
  }
  return false;
}

operator*=()

Expr & olb::Expr::operator*=

(

Expr

rhs

)

Definition at line 132 of file expr.cpp.

                               {
  increment(Expr::Op::Mul);
  _payload = Binary(*this, Op::Mul, rhs);
  return *this;
}

References increment(), and Mul.

Here is the call graph for this function:

operator+=()

Expr & olb::Expr::operator+=

(

Expr

rhs

)

Definition at line 120 of file expr.cpp.

                               {
  increment(Expr::Op::Add);
  _payload = Binary(*this, Op::Add, rhs);
  return *this;
}

References Add, and increment().

Here is the call graph for this function:

operator-=()

Expr & olb::Expr::operator-=

(

Expr

rhs

)

Definition at line 126 of file expr.cpp.

                               {
  increment(Expr::Op::Sub);
  _payload = Binary(*this, Op::Sub, rhs);
  return *this;
}

References increment(), and Sub.

Here is the call graph for this function:

operator/=()

Expr & olb::Expr::operator/=

(

Expr

rhs

)

Definition at line 138 of file expr.cpp.

                               {
  increment(Expr::Op::Div);
  _payload = Binary(*this, Op::Div, rhs);
  return *this;
}

References Div, and increment().

Here is the call graph for this function:

operator=()

Expr & olb::Expr::operator=

(

const Expr &

rhs

)

Definition at line 115 of file expr.cpp.

                                     {
  _payload = rhs._payload;
  return *this;
}

reset()

static void olb::Expr::reset ( )

inlinestatic

Resets FLOP counter.

Definition at line 123 of file expr.h.

                      {
    _stats.fill(0);
  }

Here is the caller graph for this function:

size()

std::size_t olb::Expr::size

(

)

const

Returns expanded size of tree.

Definition at line 163 of file expr.cpp.

                           {
  std::size_t size{};
  std::visit([&size](auto& x) {
    size = x.size();
  }, _payload);
  return size;
}

References size().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• src/core/expr.h
• src/core/expr.cpp