sleipnir::Variable Class Reference

#include <sleipnir/autodiff/Variable.hpp>

Public Member Functions
	Variable ()=default
constexpr	Variable (std::nullptr_t)
	Variable (std::floating_point auto value)
	Variable (std::integral auto value)
	Variable (const detail::ExpressionPtr &expr)
constexpr	Variable (detail::ExpressionPtr &&expr)
Variable &	operator= (double value)
void	SetValue (double value)
Variable &	operator*= (const Variable &rhs)
Variable &	operator/= (const Variable &rhs)
Variable &	operator+= (const Variable &rhs)
Variable &	operator-= (const Variable &rhs)
double	Value ()
ExpressionType	Type () const

Friends
class	detail::ExpressionGraph
class SLEIPNIR_DLLEXPORT	Hessian
class SLEIPNIR_DLLEXPORT	Jacobian
SLEIPNIR_DLLEXPORT Variable	operator* (const Variable &lhs, const Variable &rhs)
SLEIPNIR_DLLEXPORT Variable	operator/ (const Variable &lhs, const Variable &rhs)
SLEIPNIR_DLLEXPORT Variable	operator+ (const Variable &lhs, const Variable &rhs)
SLEIPNIR_DLLEXPORT Variable	operator- (const Variable &lhs, const Variable &rhs)
SLEIPNIR_DLLEXPORT Variable	operator- (const Variable &lhs)
SLEIPNIR_DLLEXPORT Variable	operator+ (const Variable &lhs)
SLEIPNIR_DLLEXPORT Variable	abs (const Variable &x)
SLEIPNIR_DLLEXPORT Variable	acos (const Variable &x)
SLEIPNIR_DLLEXPORT Variable	asin (const Variable &x)
SLEIPNIR_DLLEXPORT Variable	atan (const Variable &x)
SLEIPNIR_DLLEXPORT Variable	atan2 (const Variable &y, const Variable &x)
SLEIPNIR_DLLEXPORT Variable	cos (const Variable &x)
SLEIPNIR_DLLEXPORT Variable	cosh (const Variable &x)
SLEIPNIR_DLLEXPORT Variable	erf (const Variable &x)
SLEIPNIR_DLLEXPORT Variable	exp (const Variable &x)
SLEIPNIR_DLLEXPORT Variable	hypot (const Variable &x, const Variable &y)
SLEIPNIR_DLLEXPORT Variable	log (const Variable &x)
SLEIPNIR_DLLEXPORT Variable	log10 (const Variable &x)
SLEIPNIR_DLLEXPORT Variable	pow (const Variable &base, const Variable &power)
SLEIPNIR_DLLEXPORT Variable	sign (const Variable &x)
SLEIPNIR_DLLEXPORT Variable	sin (const Variable &x)
SLEIPNIR_DLLEXPORT Variable	sinh (const Variable &x)
SLEIPNIR_DLLEXPORT Variable	sqrt (const Variable &x)
SLEIPNIR_DLLEXPORT Variable	tan (const Variable &x)
SLEIPNIR_DLLEXPORT Variable	tanh (const Variable &x)
SLEIPNIR_DLLEXPORT Variable	hypot (const Variable &x, const Variable &y, const Variable &z)

Detailed Description

An autodiff variable pointing to an expression node.

Constructor & Destructor Documentation

Variable() [1/6]

sleipnir::Variable::Variable ( )

default

Constructs a linear Variable with a value of zero.

Variable() [2/6]

constexpr sleipnir::Variable::Variable ( std::nullptr_t  )

inlineexplicitconstexpr

Constructs an empty Variable.

Variable() [3/6]

sleipnir::Variable::Variable ( std::floating_point auto  value )

inline

Constructs a Variable from a floating point type.

Parameters

value

The value of the Variable.

Variable() [4/6]

sleipnir::Variable::Variable ( std::integral auto  value )

inline

Constructs a Variable from an integral type.

Parameters

value

The value of the Variable.

Variable() [5/6]

sleipnir::Variable::Variable ( const detail::ExpressionPtr &  expr )

inlineexplicit

Constructs a Variable pointing to the specified expression.

Parameters

expr	The autodiff variable.

Variable() [6/6]

constexpr sleipnir::Variable::Variable ( detail::ExpressionPtr &&  expr )

inlineexplicitconstexpr

Constructs a Variable pointing to the specified expression.

Parameters

expr	The autodiff variable.

Member Function Documentation

operator*=()

Variable & sleipnir::Variable::operator*= ( const Variable &  rhs )

inline

Variable-Variable compound multiplication operator.

Parameters

rhs	Operator right-hand side.

operator+=()

Variable & sleipnir::Variable::operator+= ( const Variable &  rhs )

inline

Variable-Variable compound addition operator.

Parameters

rhs	Operator right-hand side.

operator-=()

Variable & sleipnir::Variable::operator-= ( const Variable &  rhs )

inline

Variable-Variable compound subtraction operator.

Parameters

rhs	Operator right-hand side.

operator/=()

Variable & sleipnir::Variable::operator/= ( const Variable &  rhs )

inline

Variable-Variable compound division operator.

Parameters

rhs	Operator right-hand side.

operator=()

Variable & sleipnir::Variable::operator= ( double  value )

inline

Assignment operator for double.

Parameters

value

The value of the Variable.

SetValue()

void sleipnir::Variable::SetValue ( double  value )

inline

Sets Variable's internal value.

Parameters

value

The value of the Variable.

Type()

ExpressionType sleipnir::Variable::Type ( ) const

inline

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

Value()

double sleipnir::Variable::Value

(

)

Returns the value of this variable.

Friends And Related Symbol Documentation

abs

SLEIPNIR_DLLEXPORT Variable abs ( const Variable &  x )

friend

std::abs() for Variables.

Parameters

x	The argument.

acos

SLEIPNIR_DLLEXPORT Variable acos ( const Variable &  x )

friend

std::acos() for Variables.

Parameters

x	The argument.

asin

SLEIPNIR_DLLEXPORT Variable asin ( const Variable &  x )

friend

std::asin() for Variables.

Parameters

x	The argument.

atan

SLEIPNIR_DLLEXPORT Variable atan ( const Variable &  x )

friend

std::atan() for Variables.

Parameters

x	The argument.

atan2

SLEIPNIR_DLLEXPORT Variable atan2 ( const Variable &  y, const Variable &  x  )

friend

std::atan2() for Variables.

Parameters

y	The y argument.
x	The x argument.

cos

SLEIPNIR_DLLEXPORT Variable cos ( const Variable &  x )

friend

std::cos() for Variables.

Parameters

x	The argument.

cosh

SLEIPNIR_DLLEXPORT Variable cosh ( const Variable &  x )

friend

std::cosh() for Variables.

Parameters

x	The argument.

detail::ExpressionGraph

friend class detail::ExpressionGraph

friend

erf

SLEIPNIR_DLLEXPORT Variable erf ( const Variable &  x )

friend

std::erf() for Variables.

Parameters

x	The argument.

exp

SLEIPNIR_DLLEXPORT Variable exp ( const Variable &  x )

friend

std::exp() for Variables.

Parameters

x	The argument.

Hessian

friend class SLEIPNIR_DLLEXPORT Hessian

friend

hypot [1/2]

SLEIPNIR_DLLEXPORT Variable hypot ( const Variable &  x, const Variable &  y  )

friend

std::hypot() for Variables.

Parameters

x	The x argument.
y	The y argument.

hypot [2/2]

SLEIPNIR_DLLEXPORT Variable hypot ( const Variable &  x, const Variable &  y, const Variable &  z  )

friend

std::hypot() for Variables.

Parameters

x	The x argument.
y	The y argument.
z	The z argument.

Jacobian

friend class SLEIPNIR_DLLEXPORT Jacobian

friend

log

SLEIPNIR_DLLEXPORT Variable log ( const Variable &  x )

friend

std::log() for Variables.

Parameters

x	The argument.

log10

SLEIPNIR_DLLEXPORT Variable log10 ( const Variable &  x )

friend

std::log10() for Variables.

Parameters

x	The argument.

operator*

SLEIPNIR_DLLEXPORT Variable operator* ( const Variable &  lhs, const Variable &  rhs  )

friend

Variable-Variable multiplication operator.

Parameters

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

operator+ [1/2]

SLEIPNIR_DLLEXPORT Variable operator+ ( const Variable &  lhs )

friend

Unary plus operator.

Parameters

lhs	Operand for unary plus.

operator+ [2/2]

SLEIPNIR_DLLEXPORT Variable operator+ ( const Variable &  lhs, const Variable &  rhs  )

friend

Variable-Variable addition operator.

Parameters

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

operator- [1/2]

SLEIPNIR_DLLEXPORT Variable operator- ( const Variable &  lhs )

friend

Unary minus operator.

Parameters

lhs	Operand for unary minus.

operator- [2/2]

SLEIPNIR_DLLEXPORT Variable operator- ( const Variable &  lhs, const Variable &  rhs  )

friend

Variable-Variable subtraction operator.

Parameters

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

operator/

SLEIPNIR_DLLEXPORT Variable operator/ ( const Variable &  lhs, const Variable &  rhs  )

friend

Variable-Variable division operator.

Parameters

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

pow

SLEIPNIR_DLLEXPORT Variable pow ( const Variable &  base, const Variable &  power  )

friend

std::pow() for Variables.

Parameters

base	The base.
power	The power.

sign

SLEIPNIR_DLLEXPORT Variable sign ( const Variable &  x )

friend

sign() for Variables.

Parameters

x	The argument.

sin

SLEIPNIR_DLLEXPORT Variable sin ( const Variable &  x )

friend

std::sin() for Variables.

Parameters

x	The argument.

sinh

SLEIPNIR_DLLEXPORT Variable sinh ( const Variable &  x )

friend

std::sinh() for Variables.

Parameters

x	The argument.

sqrt

SLEIPNIR_DLLEXPORT Variable sqrt ( const Variable &  x )

friend

std::sqrt() for Variables.

Parameters

x	The argument.

tan

SLEIPNIR_DLLEXPORT Variable tan ( const Variable &  x )

friend

std::tan() for Variables.

Parameters

x	The argument.

tanh

SLEIPNIR_DLLEXPORT Variable tanh ( const Variable &  x )

friend

std::tanh() for Variables.

Parameters

x	The argument.

---

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

• include/sleipnir/autodiff/Variable.hpp