slp::detail::AtanExpression< Scalar > Struct Template Reference

#include </home/runner/work/Sleipnir/Sleipnir/include/sleipnir/autodiff/expression.hpp>

Inheritance diagram for slp::detail::AtanExpression< Scalar >:

Public Member Functions
constexpr	AtanExpression (ExpressionPtr< Scalar > lhs)
Scalar	value (Scalar x, Scalar) const override
ExpressionType	type () const override
std::string_view	name () const override
Scalar	grad_l (Scalar x, Scalar) const override
ExpressionPtr< Scalar >	grad_expr_l (const ExpressionPtr< Scalar > &x, const ExpressionPtr< Scalar > &) const override
Public Member Functions inherited from slp::detail::Expression< Scalar >
constexpr	Expression ()=default
	Constructs a constant expression with a value of zero.
constexpr	Expression (Scalar value)
constexpr	Expression (ExpressionPtr< Scalar > lhs)
constexpr	Expression (ExpressionPtr< Scalar > lhs, ExpressionPtr< Scalar > rhs)
constexpr bool	is_constant (Scalar constant) const
virtual Scalar	grad_r (Scalar lhs, Scalar rhs) const
virtual ExpressionPtr< Scalar >	grad_expr_r (const ExpressionPtr< Scalar > &lhs, const ExpressionPtr< Scalar > &rhs) const

Additional Inherited Members
Public Types inherited from slp::detail::Expression< Scalar >
using	Scalar = Scalar
	Scalar type alias.
Public Attributes inherited from slp::detail::Expression< Scalar >
Scalar	val
	The value of the expression node.
Scalar	adjoint
	The adjoint of the expression node, used during autodiff.
ExpressionPtr< Scalar >	adjoint_expr
std::array< ExpressionPtr< Scalar >, 2 >	args
	Expression arguments.
int32_t	scratch
uint32_t	ref_count
	Reference count for intrusive shared pointer.

Detailed Description

template<typename Scalar>
struct slp::detail::AtanExpression< Scalar >

Derived expression type for atan().

Template Parameters

Scalar

Scalar type.

Constructor & Destructor Documentation

AtanExpression()

template<typename Scalar >

constexpr slp::detail::AtanExpression< Scalar >::AtanExpression ( ExpressionPtr< Scalar >  lhs )

inlineexplicitconstexpr

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

Parameters

lhs	Unary operator's operand.

Member Function Documentation

grad_expr_l()

template<typename Scalar >

ExpressionPtr< Scalar > slp::detail::AtanExpression< Scalar >::grad_expr_l ( const ExpressionPtr< Scalar > &  lhs, const ExpressionPtr< Scalar > &  rhs  ) const

inlineoverridevirtual

Returns ∂/∂l as an Expression.

Parameters

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

Returns

∂/∂l as an Expression.

Reimplemented from slp::detail::Expression< Scalar >.

grad_l()

template<typename Scalar >

Scalar slp::detail::AtanExpression< Scalar >::grad_l ( Scalar  lhs, Scalar  rhs  ) const

inlineoverridevirtual

Returns ∂/∂l as a Scalar.

Parameters

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

Returns

∂/∂l as a Scalar.

Reimplemented from slp::detail::Expression< Scalar >.

name()

template<typename Scalar >

std::string_view slp::detail::AtanExpression< Scalar >::name ( ) const

inlineoverridevirtual

Returns the name of this expression.

Returns

The name of this expression.

Implements slp::detail::Expression< Scalar >.

type()

template<typename Scalar >

ExpressionType slp::detail::AtanExpression< Scalar >::type ( ) const

inlineoverridevirtual

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

Returns

The type of this expression.

Implements slp::detail::Expression< Scalar >.

value()

template<typename Scalar >

Scalar slp::detail::AtanExpression< Scalar >::value ( Scalar  lhs, Scalar  rhs  ) const

inlineoverridevirtual

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.

Implements slp::detail::Expression< Scalar >.

---

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

• /home/runner/work/Sleipnir/Sleipnir/include/sleipnir/autodiff/expression.hpp