#include <Operation.h>

Inheritance diagram for PLMD::lepton::Operation::Custom:

Public Types
enum	Id { CONSTANT , VARIABLE , CUSTOM , ADD , SUBTRACT , MULTIPLY , DIVIDE , POWER , NEGATE , SQRT , EXP , LOG , SIN , COS , SEC , CSC , TAN , COT , ASIN , ACOS , ATAN , ATAN2 , SINH , COSH , TANH , ERF , ERFC , STEP , DELTA , NANDELTA , SQUARE , CUBE , RECIPROCAL , ADD_CONSTANT , MULTIPLY_CONSTANT , POWER_CONSTANT , MIN , MAX , ABS , FLOOR , CEIL , SELECT , ACOT , ASEC , ACSC , COTH , SECH , CSCH , ASINH , ACOSH , ATANH , ACOTH , ASECH , ACSCH }
	This enumeration lists all Operation subclasses. More...

Public Member Functions
	Custom (const Custom &base, int derivIndex)

	Custom (const std::string &name, CustomFunction *function)

	Custom (const std::string &name, CustomFunction *function, const std::vector< int > &derivOrder)

	~Custom ()

Operation *	clone () const
	Create a clone of this Operation.

ExpressionTreeNode	differentiate (const std::vector< ExpressionTreeNode > &children, const std::vector< ExpressionTreeNode > &childDerivs, const std::string &variable) const
	Return an ExpressionTreeNode which represents the analytic derivative of this Operation with respect to a variable.

double	evaluate (double *args, const std::map< std::string, double > &variables) const
	Perform the computation represented by this operation.

const std::vector< int > &	getDerivOrder () const

Id	getId () const
	Get this Operation's ID.

std::string	getName () const
	Get the name of this Operation.

int	getNumArguments () const
	Get the number of arguments this operation expects.

virtual bool	isInfixOperator () const
	Get whether this operation should be displayed with infix notation.

virtual bool	isSymmetric () const
	Get whether this is a symmetric binary operation, such that exchanging its arguments does not affect the result.

bool	operator!= (const Operation &op) const

virtual bool	operator== (const Operation &op) const

Private Attributes
std::vector< int >	derivOrder

CustomFunction *	function

bool	isDerivative

std::string	name

Member Enumeration Documentation

◆ Id

enum PLMD::lepton::Operation::Id

inherited

This enumeration lists all Operation subclasses.

This is provided so that switch statements can be used when processing or analyzing parsed expressions.

Enumerator
CONSTANT
VARIABLE
CUSTOM
ADD
SUBTRACT
MULTIPLY
DIVIDE
POWER
NEGATE
SQRT
EXP
LOG
SIN
COS
SEC
CSC
TAN
COT
ASIN
ACOS
ATAN
ATAN2
SINH
COSH
TANH
ERF
ERFC
STEP
DELTA
NANDELTA
SQUARE
CUBE
RECIPROCAL
ADD_CONSTANT
MULTIPLY_CONSTANT
POWER_CONSTANT
MIN
MAX
ABS
FLOOR
CEIL
SELECT
ACOT
ASEC
ACSC
COTH
SECH
CSCH
ASINH
ACOSH
ATANH
ACOTH
ASECH
ACSCH

Constructor & Destructor Documentation

◆ Custom() [1/3]

PLMD::lepton::Operation::Custom::Custom	(	const std::string &	name,
		CustomFunction *	function )

inline

◆ Custom() [2/3]

PLMD::lepton::Operation::Custom::Custom	(	const std::string &	name,
		CustomFunction *	function,
		const std::vector< int > &	derivOrder )

inline

◆ Custom() [3/3]

PLMD::lepton::Operation::Custom::Custom	(	const Custom &	base,
		int	derivIndex )

inline

◆ ~Custom()

PLMD::lepton::Operation::Custom::~Custom ( )

inline

Member Function Documentation

◆ clone()

Operation * PLMD::lepton::Operation::Custom::clone ( ) const

inlinevirtual

Create a clone of this Operation.

Implements PLMD::lepton::Operation.

◆ differentiate()

ExpressionTreeNode PLMD::Operation::Custom::differentiate	(	const std::vector< ExpressionTreeNode > &	children,
		const std::vector< ExpressionTreeNode > &	childDerivs,
		const std::string &	variable ) const

virtual

Return an ExpressionTreeNode which represents the analytic derivative of this Operation with respect to a variable.

Parameters

children	the child nodes
childDerivs	the derivatives of the child nodes with respect to the variable
variable	the variable with respect to which the derivate should be taken

Implements PLMD::lepton::Operation.

◆ evaluate()

double PLMD::lepton::Operation::Custom::evaluate	(	double *	args,
		const std::map< std::string, double > &	variables ) const

inlinevirtual

Perform the computation represented by this operation.

Parameters

args	the array of arguments
variables	a map containing the values of all variables

Returns: the result of performing the computation.

Implements PLMD::lepton::Operation.

◆ getDerivOrder()

const std::vector< int > & PLMD::lepton::Operation::Custom::getDerivOrder ( ) const

inline

◆ getId()

Id PLMD::lepton::Operation::Custom::getId ( ) const

inlinevirtual

Get this Operation's ID.

Implements PLMD::lepton::Operation.

◆ getName()

std::string PLMD::lepton::Operation::Custom::getName ( ) const

inlinevirtual

Get the name of this Operation.

Implements PLMD::lepton::Operation.

◆ getNumArguments()

int PLMD::lepton::Operation::Custom::getNumArguments ( ) const

inlinevirtual

Get the number of arguments this operation expects.

Implements PLMD::lepton::Operation.

◆ isInfixOperator()

virtual bool PLMD::lepton::Operation::isInfixOperator ( ) const

inlinevirtualinherited

Get whether this operation should be displayed with infix notation.

Reimplemented in PLMD::lepton::Operation::Add, PLMD::lepton::Operation::Divide, PLMD::lepton::Operation::Multiply, PLMD::lepton::Operation::Power, PLMD::lepton::Operation::PowerConstant, and PLMD::lepton::Operation::Subtract.

◆ isSymmetric()

virtual bool PLMD::lepton::Operation::isSymmetric ( ) const

inlinevirtualinherited

Get whether this is a symmetric binary operation, such that exchanging its arguments does not affect the result.

Reimplemented in PLMD::lepton::Operation::Add, and PLMD::lepton::Operation::Multiply.

◆ operator!=()

bool PLMD::lepton::Operation::Custom::operator!= ( const Operation & op ) const

inlinevirtual

Reimplemented from PLMD::lepton::Operation.

◆ operator==()

virtual bool PLMD::lepton::Operation::operator== ( const Operation & op ) const

inlinevirtualinherited

Member Data Documentation

◆ derivOrder

std::vector<int> PLMD::lepton::Operation::Custom::derivOrder

private

◆ function

CustomFunction* PLMD::lepton::Operation::Custom::function

private

◆ isDerivative

bool PLMD::lepton::Operation::Custom::isDerivative

private

◆ name

std::string PLMD::lepton::Operation::Custom::name

private

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

lepton/Operation.h
lepton/Operation.cpp

Public Types

Public Member Functions

Private Attributes

Member Enumeration Documentation

◆ Id

Constructor & Destructor Documentation

◆ Custom() [1/3]

◆ Custom() [2/3]

◆ Custom() [3/3]

◆ ~Custom()

Member Function Documentation

◆ clone()

◆ differentiate()

◆ evaluate()

◆ getDerivOrder()

◆ getId()

◆ getName()

◆ getNumArguments()

◆ isInfixOperator()

◆ isSymmetric()

◆ operator!=()

◆ operator==()

Member Data Documentation

◆ derivOrder

◆ function

◆ isDerivative

◆ name