Helper class that gives us a reference that we can assign a AutoDerivative to and write into the correct space in a ArrayAd. More...

#include <auto_derivative.h>

Inheritance diagram for FullPhysics::AutoDerivativeRef< T >:

Collaboration diagram for FullPhysics::AutoDerivativeRef< T >:

Public Member Functions
	AutoDerivativeRef (T &V, const blitz::Array< T, 1 > &G)

	AutoDerivativeRef (T &V)

const blitz::Array< T, 1 > &	gradient () const

blitz::Array< T, 1 > &	gradient_ref () const

const AutoDerivativeRef< T > &	operator= (const AutoDerivative< T > &D) const

void	print (std::ostream &Os) const

std::string	print_to_string () const
	Print to string. More...

T	value () const

T &	value_ref () const

Friends
AutoDerivative< T >	operator* (const AutoDerivativeRef< T > &X, const AutoDerivativeRef< T > &Y)

AutoDerivative< T >	operator* (const AutoDerivativeRef< T > &X, const T &Y)

AutoDerivative< T >	operator* (const T &X, const AutoDerivativeRef< T > &Y)

AutoDerivative< T >	operator+ (const AutoDerivativeRef< T > &X, const AutoDerivativeRef< T > &Y)

AutoDerivative< T >	operator+ (const AutoDerivativeRef< T > &X, const T &Y)

AutoDerivative< T >	operator+ (const T &X, const AutoDerivativeRef< T > &Y)

AutoDerivative< T >	operator- (const AutoDerivativeRef< T > &X, const AutoDerivativeRef< T > &Y)

AutoDerivative< T >	operator- (const AutoDerivativeRef< T > &X)

AutoDerivative< T >	operator- (const AutoDerivativeRef< T > &X, const T &Y)

AutoDerivative< T >	operator- (const T &X, const AutoDerivativeRef< T > &Y)

AutoDerivative< T >	operator/ (const AutoDerivativeRef< T > &X, const AutoDerivativeRef< T > &Y)

AutoDerivative< T >	operator/ (const AutoDerivativeRef< T > &X, const T &Y)

AutoDerivative< T >	operator/ (const T &X, const AutoDerivativeRef< T > &Y)

Detailed Description

template<class T>
class FullPhysics::AutoDerivativeRef< T >

Helper class that gives us a reference that we can assign a AutoDerivative to and write into the correct space in a ArrayAd.

Definition at line 51 of file auto_derivative.h.

Constructor & Destructor Documentation

◆ AutoDerivativeRef() [1/2]

template<class T>

FullPhysics::AutoDerivativeRef< T >::AutoDerivativeRef	(	T &	V,
		const blitz::Array< T, 1 > &	G
	)

inline

Definition at line 55 of file auto_derivative.h.

◆ AutoDerivativeRef() [2/2]

template<class T>

FullPhysics::AutoDerivativeRef< T >::AutoDerivativeRef ( T & V )

inline

Definition at line 58 of file auto_derivative.h.

Member Function Documentation

◆ gradient()

template<class T>

const blitz::Array<T, 1>& FullPhysics::AutoDerivativeRef< T >::gradient ( ) const

inline

Definition at line 81 of file auto_derivative.h.

◆ gradient_ref()

template<class T>

blitz::Array<T, 1>& FullPhysics::AutoDerivativeRef< T >::gradient_ref ( ) const

inline

Definition at line 79 of file auto_derivative.h.

◆ operator=()

template<class T>

const AutoDerivativeRef<T>& FullPhysics::AutoDerivativeRef< T >::operator= ( const AutoDerivative< T > & D ) const

inline

Definition at line 62 of file auto_derivative.h.

◆ print()

template<class T>

void FullPhysics::AutoDerivativeRef< T >::print ( std::ostream & Os ) const

inline

Definition at line 159 of file auto_derivative.h.

◆ print_to_string()

std::string FullPhysics::Printable< AutoDerivativeRef< T > >::print_to_string ( ) const

inlineinherited

Print to string.

This is primarily useful for SWIG wrappers to this class, e.g. a to_s method in ruby.

Definition at line 31 of file printable.h.

◆ value()

template<class T>

T FullPhysics::AutoDerivativeRef< T >::value ( ) const

inline

Definition at line 80 of file auto_derivative.h.

◆ value_ref()

template<class T>

T& FullPhysics::AutoDerivativeRef< T >::value_ref ( ) const

inline

Definition at line 78 of file auto_derivative.h.

Friends And Related Function Documentation

◆ operator* [1/3]

template<class T>

AutoDerivative<T> operator*	(	const AutoDerivativeRef< T > &	X,
		const AutoDerivativeRef< T > &	Y
	)

friend

Definition at line 99 of file auto_derivative.h.

◆ operator* [2/3]

template<class T>

AutoDerivative<T> operator*	(	const AutoDerivativeRef< T > &	X,
		const T &	Y
	)

friend

Definition at line 123 of file auto_derivative.h.

◆ operator* [3/3]

template<class T>

AutoDerivative<T> operator*	(	const T &	X,
		const AutoDerivativeRef< T > &	Y
	)

friend

Definition at line 147 of file auto_derivative.h.

◆ operator+ [1/3]

template<class T>

AutoDerivative<T> operator+	(	const AutoDerivativeRef< T > &	X,
		const AutoDerivativeRef< T > &	Y
	)

friend

Definition at line 82 of file auto_derivative.h.

◆ operator+ [2/3]

template<class T>

AutoDerivative<T> operator+	(	const AutoDerivativeRef< T > &	X,
		const T &	Y
	)

friend

Definition at line 111 of file auto_derivative.h.

◆ operator+ [3/3]

template<class T>

AutoDerivative<T> operator+	(	const T &	X,
		const AutoDerivativeRef< T > &	Y
	)

friend

Definition at line 135 of file auto_derivative.h.

◆ operator- [1/4]

template<class T>

AutoDerivative<T> operator-	(	const AutoDerivativeRef< T > &	X,
		const AutoDerivativeRef< T > &	Y
	)

friend

Definition at line 88 of file auto_derivative.h.

◆ operator- [2/4]

template<class T>

AutoDerivative<T> operator- ( const AutoDerivativeRef< T > & X )

friend

Definition at line 94 of file auto_derivative.h.

◆ operator- [3/4]

template<class T>

AutoDerivative<T> operator-	(	const AutoDerivativeRef< T > &	X,
		const T &	Y
	)

friend

Definition at line 117 of file auto_derivative.h.

◆ operator- [4/4]

template<class T>

AutoDerivative<T> operator-	(	const T &	X,
		const AutoDerivativeRef< T > &	Y
	)

friend

Definition at line 141 of file auto_derivative.h.

◆ operator/ [1/3]

template<class T>

AutoDerivative<T> operator/	(	const AutoDerivativeRef< T > &	X,
		const AutoDerivativeRef< T > &	Y
	)

friend

Definition at line 105 of file auto_derivative.h.

◆ operator/ [2/3]

template<class T>

AutoDerivative<T> operator/	(	const AutoDerivativeRef< T > &	X,
		const T &	Y
	)

friend

Definition at line 129 of file auto_derivative.h.

◆ operator/ [3/3]

template<class T>

AutoDerivative<T> operator/	(	const T &	X,
		const AutoDerivativeRef< T > &	Y
	)

friend

Definition at line 153 of file auto_derivative.h.

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

Support/auto_derivative.h

Public Member Functions

Friends

Detailed Description

template<class T> class FullPhysics::AutoDerivativeRef< T >

Constructor & Destructor Documentation

◆ AutoDerivativeRef() [1/2]

◆ AutoDerivativeRef() [2/2]

Member Function Documentation

◆ gradient()

◆ gradient_ref()

◆ operator=()

◆ print()

◆ print_to_string()

◆ value()

◆ value_ref()

Friends And Related Function Documentation

◆ operator* [1/3]

◆ operator* [2/3]

◆ operator* [3/3]

◆ operator+ [1/3]

◆ operator+ [2/3]

◆ operator+ [3/3]

◆ operator- [1/4]

◆ operator- [2/4]

◆ operator- [3/4]

◆ operator- [4/4]

◆ operator/ [1/3]

◆ operator/ [2/3]

◆ operator/ [3/3]

template<class T>
class FullPhysics::AutoDerivativeRef< T >