#include <sleipnir/autodiff/expression.hpp>

Inheritance diagram for slp::detail::Expression:

Public Member Functions
constexpr	Expression ()=default

constexpr	Expression (double value)

constexpr	Expression (ExpressionPtr lhs)

constexpr	Expression (ExpressionPtr lhs, ExpressionPtr rhs)

constexpr bool	is_constant (double constant) const

virtual double	value (double lhs, double rhs) const =0

virtual ExpressionType	type () const =0

virtual double	grad_l (double lhs, double rhs, double parent_adjoint) const

virtual double	grad_r (double lhs, double rhs, double parent_adjoint) const

virtual ExpressionPtr	grad_expr_l (const ExpressionPtr &lhs, const ExpressionPtr &rhs, const ExpressionPtr &parent_adjoint) const

virtual ExpressionPtr	grad_expr_r (const ExpressionPtr &lhs, const ExpressionPtr &rhs, const ExpressionPtr &parent_adjoint) const

Public Attributes
double	val = 0.0
	The value of the expression node.

double	adjoint = 0.0
	The adjoint of the expression node used during autodiff.

uint32_t	incoming_edges = 0
	Counts incoming edges for this node.

int32_t	col = -1
	This expression's column in a Jacobian, or -1 otherwise.

ExpressionPtr	adjoint_expr

uint32_t	ref_count = 0
	Reference count for intrusive shared pointer.

std::array< ExpressionPtr, 2 >	args {nullptr, nullptr}
	Expression arguments.

Friends
ExpressionPtr	operator* (const ExpressionPtr &lhs, const ExpressionPtr &rhs)

ExpressionPtr	operator/ (const ExpressionPtr &lhs, const ExpressionPtr &rhs)

ExpressionPtr	operator+ (const ExpressionPtr &lhs, const ExpressionPtr &rhs)

ExpressionPtr	operator+= (ExpressionPtr &lhs, const ExpressionPtr &rhs)

ExpressionPtr	operator- (const ExpressionPtr &lhs, const ExpressionPtr &rhs)

ExpressionPtr	operator- (const ExpressionPtr &lhs)

ExpressionPtr	operator+ (const ExpressionPtr &lhs)

Detailed Description

An autodiff expression node.

Constructor & Destructor Documentation

◆ Expression() [1/4]

constexpr slp::detail::Expression::Expression ( )

constexprdefault

Constructs a constant expression with a value of zero.

◆ Expression() [2/4]

constexpr slp::detail::Expression::Expression ( double value )

inlineexplicitconstexpr

Constructs a nullary expression (an operator with no arguments).

Parameters

value The expression value.

◆ Expression() [3/4]

constexpr slp::detail::Expression::Expression ( ExpressionPtr lhs )

inlineexplicitconstexpr

Constructs an unary expression (an operator with one argument).

Parameters

lhs	Unary operator's operand.

◆ Expression() [4/4]

constexpr slp::detail::Expression::Expression	(	ExpressionPtr	lhs,
		ExpressionPtr	rhs
	)

inlineconstexpr

Constructs a binary expression (an operator with two arguments).

Parameters

lhs	Binary operator's left operand.
rhs	Binary operator's right operand.

Member Function Documentation

◆ grad_expr_l()

virtual ExpressionPtr slp::detail::Expression::grad_expr_l	(	const ExpressionPtr &	lhs,
		const ExpressionPtr &	rhs,
		const ExpressionPtr &	parent_adjoint
	)		const

inlinevirtual

Returns Expression adjoint of the left child expression.

Parameters

lhs	Left argument to binary operator.
rhs	Right argument to binary operator.
parent_adjoint	Adjoint of parent expression.

Returns: The Expression adjoint of the left child expression.

Reimplemented in slp::detail::SignExpression, slp::detail::BinaryMinusExpression< T >, slp::detail::BinaryPlusExpression< T >, slp::detail::UnaryMinusExpression< T >, slp::detail::DivExpression< T >, slp::detail::PowExpression< T >, slp::detail::MultExpression< T >, slp::detail::AbsExpression, slp::detail::AcosExpression, slp::detail::AsinExpression, slp::detail::AtanExpression, slp::detail::CosExpression, slp::detail::CoshExpression, slp::detail::ErfExpression, slp::detail::ExpExpression, slp::detail::LogExpression, slp::detail::Log10Expression, slp::detail::SinExpression, slp::detail::SinhExpression, slp::detail::SqrtExpression, slp::detail::TanExpression, slp::detail::TanhExpression, slp::detail::HypotExpression, and slp::detail::Atan2Expression.

◆ grad_expr_r()

virtual ExpressionPtr slp::detail::Expression::grad_expr_r	(	const ExpressionPtr &	lhs,
		const ExpressionPtr &	rhs,
		const ExpressionPtr &	parent_adjoint
	)		const

inlinevirtual

Returns Expression adjoint of the right child expression.

Parameters

lhs	Left argument to binary operator.
rhs	Right argument to binary operator.
parent_adjoint	Adjoint of parent expression.

Returns: The Expression adjoint of the right child expression.

Reimplemented in slp::detail::BinaryMinusExpression< T >, slp::detail::BinaryPlusExpression< T >, slp::detail::PowExpression< T >, slp::detail::DivExpression< T >, slp::detail::MultExpression< T >, slp::detail::HypotExpression, and slp::detail::Atan2Expression.

◆ grad_l()

virtual double slp::detail::Expression::grad_l	(	double	lhs,
		double	rhs,
		double	parent_adjoint
	)		const

inlinevirtual

Returns double adjoint of the left child expression.

Parameters

lhs	Left argument to binary operator.
rhs	Right argument to binary operator.
parent_adjoint	Adjoint of parent expression.

Returns: The double adjoint of the left child expression.

◆ grad_r()

virtual double slp::detail::Expression::grad_r	(	double	lhs,
		double	rhs,
		double	parent_adjoint
	)		const

inlinevirtual

Returns double adjoint of the right child expression.

Parameters

lhs	Left argument to binary operator.
rhs	Right argument to binary operator.
parent_adjoint	Adjoint of parent expression.

Returns: The double adjoint of the right child expression.

Reimplemented in slp::detail::PowExpression< T >, slp::detail::DivExpression< T >, slp::detail::MultExpression< T >, slp::detail::HypotExpression, slp::detail::Atan2Expression, slp::detail::BinaryMinusExpression< T >, and slp::detail::BinaryPlusExpression< T >.

◆ is_constant()

constexpr bool slp::detail::Expression::is_constant ( double constant ) const

inlineconstexpr

Returns true if the expression is the given constant.

Parameters

constant The constant.

Returns: True if the expression is the given constant.

◆ type()

virtual ExpressionType slp::detail::Expression::type ( ) const

pure virtual

Returns the type of this expression (constant, linear, quadratic, or nonlinear).

Returns: The type of this expression.

◆ value()

virtual double slp::detail::Expression::value	(	double	lhs,
		double	rhs
	)		const

pure virtual

Either nullary operator with no arguments, unary operator with one argument, or binary operator with two arguments. This operator is used to update the node's value.

Parameters

lhs	Left argument to binary operator.
rhs	Right argument to binary operator.

Returns: The node's value.

Friends And Related Symbol Documentation

◆ operator*

ExpressionPtr operator*	(	const ExpressionPtr &	lhs,
		const ExpressionPtr &	rhs
	)

friend

Expression-Expression multiplication operator.

Parameters

lhs	Operator left-hand side.
rhs	Operator right-hand side.

◆ operator+ [1/2]

ExpressionPtr operator+ ( const ExpressionPtr & lhs )

friend

Unary plus operator.

Parameters

lhs	Operand of unary plus.

◆ operator+ [2/2]

ExpressionPtr operator+	(	const ExpressionPtr &	lhs,
		const ExpressionPtr &	rhs
	)

friend

Expression-Expression addition operator.

Parameters

lhs	Operator left-hand side.
rhs	Operator right-hand side.

◆ operator+=

ExpressionPtr operator+=	(	ExpressionPtr &	lhs,
		const ExpressionPtr &	rhs
	)

friend

Expression-Expression compound addition operator.

Parameters

lhs	Operator left-hand side.
rhs	Operator right-hand side.

◆ operator- [1/2]

ExpressionPtr operator- ( const ExpressionPtr & lhs )

friend

Unary minus operator.

Parameters

lhs	Operand of unary minus.

◆ operator- [2/2]

ExpressionPtr operator-	(	const ExpressionPtr &	lhs,
		const ExpressionPtr &	rhs
	)

friend

Expression-Expression subtraction operator.

Parameters

lhs	Operator left-hand side.
rhs	Operator right-hand side.

◆ operator/

ExpressionPtr operator/	(	const ExpressionPtr &	lhs,
		const ExpressionPtr &	rhs
	)

friend

Expression-Expression division operator.

Parameters

lhs	Operator left-hand side.
rhs	Operator right-hand side.

Member Data Documentation

◆ adjoint_expr

ExpressionPtr slp::detail::Expression::adjoint_expr

The adjoint of the expression node used during gradient expression tree generation.

The documentation for this struct was generated from the following file:

include/sleipnir/autodiff/expression.hpp

Public Member Functions

Public Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Expression() [1/4]

◆ Expression() [2/4]

◆ Expression() [3/4]

◆ Expression() [4/4]

Member Function Documentation

◆ grad_expr_l()

◆ grad_expr_r()

◆ grad_l()

◆ grad_r()

◆ is_constant()

◆ type()

◆ value()

Friends And Related Symbol Documentation

◆ operator*

◆ operator+ [1/2]

◆ operator+ [2/2]

◆ operator+=

◆ operator- [1/2]

◆ operator- [2/2]

◆ operator/

Member Data Documentation

◆ adjoint_expr