stan::agrad::chainable Class Reference

Abstract base class for variable implementations that handles memory management and applying the chain rule. More...

#include <agrad.hpp>

Inheritance diagram for stan::agrad::chainable:

Public Member Functions
	chainable ()
	Construct a chainable object.
	~chainable ()
	Throws a logic exception.
virtual void	chain ()
	Apply the chain rule to this variable based on the variables on which it depends.
virtual void	init_dependent ()
	Initialize this chainable's adjoint value to make it the dependent variable in a gradient calculation.
virtual void	set_zero_adjoint ()
	Set the value of the adjoint for this chainable to its initial value.

Static Public Member Functions
static void *	operator new (size_t nbytes)
	Allocate memory from the underlying memory pool.

Detailed Description

Abstract base class for variable implementations that handles memory management and applying the chain rule.

Definition at line 35 of file agrad.hpp.

Constructor & Destructor Documentation

stan::agrad::chainable::chainable ( )

inline

Construct a chainable object.

The implementation in this abstract base class is a no-op.

Definition at line 43 of file agrad.hpp.

stan::agrad::chainable::~chainable ( )

inline

Throws a logic exception.

Chainables are not destructible by clients because the vari stack manages all memory for auto-dif.

Definition at line 50 of file agrad.hpp.

Member Function Documentation

virtual void stan::agrad::chainable::chain ( )

inlinevirtual

Apply the chain rule to this variable based on the variables on which it depends.

The base implementation in this class is a no-op.

Reimplemented in stan::agrad::log_determinant_vari< R, C >, stan::agrad::determinant_vari< R, C >, stan::agrad::mdivide_left_tri_vd_vari< TriView, R1, C1, R2, C2 >, stan::agrad::mdivide_left_tri_dv_vari< TriView, R1, C1, R2, C2 >, stan::agrad::mdivide_left_tri_vv_vari< TriView, R1, C1, R2, C2 >, stan::agrad::mdivide_left_vd_vari< R1, C1, R2, C2 >, stan::agrad::mdivide_left_dv_vari< R1, C1, R2, C2 >, stan::agrad::mdivide_left_vv_vari< R1, C1, R2, C2 >, stan::agrad::vari, stan::agrad::gevv_vvv_vari, and stan::agrad::partials_vari.

Definition at line 59 of file agrad.hpp.

virtual void stan::agrad::chainable::init_dependent ( )

inlinevirtual

Initialize this chainable's adjoint value to make it the dependent variable in a gradient calculation.

Reimplemented in stan::agrad::vari.

Definition at line 66 of file agrad.hpp.

static void* stan::agrad::chainable::operator new ( size_t  nbytes )

inlinestatic

Allocate memory from the underlying memory pool.

This memory is is managed by the gradient program and will be recovered as a whole. Classes should not be allocated with this operator if they have non-trivial destructors.

Parameters

nbytes

Number of bytes to allocate.

Returns

Pointer to allocated bytes.

Definition at line 85 of file agrad.hpp.

virtual void stan::agrad::chainable::set_zero_adjoint ( )

inlinevirtual

Set the value of the adjoint for this chainable to its initial value.

Reimplemented in stan::agrad::vari.

Definition at line 73 of file agrad.hpp.

---

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

• src/stan/agrad/agrad.hpp