grad_stack Class Reference

Description not yet available. More...

#include <fvar.hpp>

Public Member Functions
	grad_stack ()
	grad_stack (const size_t size)
	grad_stack (const size_t size, const unsigned int id)
	Size constructor with filename id. More...
	grad_stack (const grad_stack &)=delete
	~grad_stack ()
	Destructor. More...
void	create_gradfile ()
	Description not yet available. More...
int	decrement_current_gradfile_ptr (void)
	If there is a previous file set the handle to point to it otherwise return a -1. More...
char *	get_gradfile_name ()
	Description not yet available. More...
int &	gradfile_handle ()
void	increment_current_gradfile_ptr (void)
	If there is another file set the handle to point to it otherwise we are out of room. More...
ostream &	operator<< (grad_stack)
void	print ()
int	read_grad_stack_buffer (OFF_T &lpos)
	Description not yet available. More...
void	set_gbuffer_pointers (void)
	Description not yet available. More...
void	set_gradient_stack (void(*func)(void), double *dep_addr, double *ind_addr1=NULL, double mult1=0, double *ind_addr2=NULL, double mult2=0)
	Description not yet available. More...
void	set_gradient_stack (void(*func)(void), double *dep_addr, double *ind_addr1, double *ind_addr2)
	Description not yet available. More...
void	set_gradient_stack (void(*func)(void), double *dep_addr, double *ind_addr1, double mult1, double *ind_addr2, double mult2, double *ind_addr3, double mult3, double *ind_addr4, double mult4)
	Description not yet available. More...
void	set_gradient_stack (void(*func)(void), double *dep_addr, double *ind_addr1, double mult1, double *ind_addr2, double mult2, double *ind_addr3, double mult3)
	Description not yet available. More...
void	set_gradient_stack (void(*ptr)(void))
	Push func to adjoint functions stack. More...
void	set_gradient_stack0 (void(*func)(void), double *dep_addr)
	Description not yet available. More...
void	set_gradient_stack1 (void(*func)(void), double *dep_addr, double *ind_addr1)
	Sets the gradient stack entry for a function or operator with a single independent variable. More...
void	set_gradient_stack2 (void(*func)(void), double *dep_addr, double *ind_addr1, double mult1)
	Description not yet available. More...
void	set_gradient_stack4 (void(*func)(void), double *dep_addr, double *ind_addr1, double *ind_addr2)
	Description not yet available. More...
size_t	total () const
void	write_grad_stack_buffer ()
void	write_grad_stack_buffer (gradient_structure *)
	Description not yet available. More...

Public Attributes
int	_GRADFILE_PTR
int	_GRADFILE_PTR1
int	_GRADFILE_PTR2
int	_VARSSAV_PTR
OFF_T	end_pos
OFF_T	end_pos1
OFF_T	end_pos2
char	gradfile_name [61]
char	gradfile_name1 [61]
char	gradfile_name2 [61]
size_t	length
grad_stack_entry *	ptr
grad_stack_entry *	ptr_first
grad_stack_entry *	ptr_last
size_t	true_length
grad_stack_entry *	true_ptr_first
char	var_store_file_name [61]

Friends
void	cleanup_temporary_files ()
	Close gradient and variable files and free gradient structure memory. More...
void	default_evaluation (void)
	Description not yet available. More...
void	default_evaluation3ind (void)
	Description not yet available. More...
void	default_evaluation4ind (void)
	Description not yet available. More...
void	funnel_gradcalc (void)
	Description not yet available. More...
void	grad_chk (void)
	Description not yet available. More...
void	gradcalc (int nvar, const dvector &g)
class	gradient_structure
void	gradloop ()
void	reset_gradient_stack (void)
	Rewind buffer. More...
void	slave_gradcalc (void)

Detailed Description

Description not yet available.

Parameters

Definition at line 920 of file fvar.hpp.

Constructor & Destructor Documentation

grad_stack::grad_stack ( )

inline

Definition at line 970 of file fvar.hpp.

grad_stack::grad_stack ( const size_t  size )

inline

Definition at line 971 of file fvar.hpp.

grad_stack::grad_stack	(	const size_t	size,
		const unsigned int	id
	)

Size constructor with filename id.

Parameters

size	array size of grad_stack_entry
id	filename id

Definition at line 107 of file gradstak.cpp.

grad_stack::grad_stack ( const grad_stack &  )

delete

grad_stack::~grad_stack

(

)

Destructor.

Definition at line 285 of file gradstak.cpp.

Member Function Documentation

void grad_stack::create_gradfile

(

)

Description not yet available.

Parameters

Definition at line 432 of file gradstak.cpp.

Referenced by grad_stack().

int grad_stack::decrement_current_gradfile_ptr

(

void

)

If there is a previous file set the handle to point to it otherwise return a -1.

Definition at line 519 of file gradstak.cpp.

Referenced by read_grad_stack_buffer().

char * grad_stack::get_gradfile_name

(

)

Description not yet available.

Parameters

Definition at line 543 of file gradstak.cpp.

Referenced by read_grad_stack_buffer().

int & grad_stack::gradfile_handle

(

)

Definition at line 534 of file gradstak.cpp.

Referenced by gradient_structure::funnel_gradcalc(), gradient_structure::gradcalc(), and gradient_structure::jacobcalc().

void grad_stack::increment_current_gradfile_ptr

(

void

)

If there is another file set the handle to point to it otherwise we are out of room.

Definition at line 503 of file gradstak.cpp.

Referenced by gradient_structure::jacobcalc(), and write_grad_stack_buffer().

ostream& grad_stack::operator<<

(

grad_stack

)

void grad_stack::print

(

)

int grad_stack::read_grad_stack_buffer

(

OFF_T &

lpos

)

Description not yet available.

Parameters

Definition at line 76 of file gst_read.cpp.

Referenced by default_evaluation3ind(), default_evaluation4ind(), gradient_structure::funnel_gradcalc(), gradient_structure::gradcalc(), and gradient_structure::jacobcalc().

void grad_stack::set_gbuffer_pointers

(

void

)

Description not yet available.

Parameters

Definition at line 551 of file gradstak.cpp.

Referenced by gradient_structure::jacobcalc(), and write_grad_stack_buffer().

void grad_stack::set_gradient_stack ( void(*)(void)  func, double *  dep_addr, double *  ind_addr1 = NULL, double  mult1 = 0, double *  ind_addr2 = NULL, double  mult2 = 0  )

inline

Description not yet available.

Parameters

Definition at line 1045 of file fvar.hpp.

Referenced by acos(), ad_begin_funnel(), asin(), atan(), betacf(), bounded_cumd_norm(), check_derivative_values(), check_derivative_values_break(), choleski_decomp(), choleski_decomp_positive(), cos(), cosh(), cube(), cumd_norm(), det(), elem_div(), elem_prod(), empirical_covariance(), exp(), fabs(), first_difference(), fourth(), gradient_structure::funnel_gradcalc(), gammlnguts(), dvar_vector::initialize(), dvar_matrix::initialize(), inv(), inv_cumd_beta_stable(), inv_cumd_gamma(), inv_cumd_norm_inner(), inv_cumd_normal_logistic_mixture(), inv_cumd_normal_mixture(), ldexp(), ln_det(), ln_det_choleski(), ln_det_choleski_error(), log(), log10(), mfexp(), dvar_vector::operator()(), operator*(), prevariable::operator*=(), operator+(), dvar_vector::operator+=(), operator-(), dvar_vector::operator-(), prevariable::operator-=(), dvar_vector::operator-=(), operator/(), prevariable::operator/=(), dvar_vector::operator/=(), dvariable::operator=(), dvar_vector::operator=(), outer_prod(), pow(), report_derivatives(), set_gradstack_flag(), sfabs(), sigmoid(), sin(), sinh(), solve(), sqrt(), square(), sum(), tan(), tanh(), trans(), and varchol().

void grad_stack::set_gradient_stack ( void(*)(void)  func, double *  dep_addr, double *  ind_addr1, double *  ind_addr2  )

inline

Description not yet available.

Parameters

Definition at line 1175 of file fvar.hpp.

void grad_stack::set_gradient_stack ( void(*)(void)  func, double *  dep_addr, double *  ind_addr1, double  mult1, double *  ind_addr2, double  mult2, double *  ind_addr3, double  mult3, double *  ind_addr4, double  mult4  )

inline

Description not yet available.

Parameters

Definition at line 1132 of file fvar.hpp.

void grad_stack::set_gradient_stack ( void(*)(void)  func, double *  dep_addr, double *  ind_addr1, double  mult1, double *  ind_addr2, double  mult2, double *  ind_addr3, double  mult3  )

inline

Description not yet available.

Parameters

Definition at line 1092 of file fvar.hpp.

void grad_stack::set_gradient_stack ( void(*)(void)  func )

inline

Push func to adjoint functions stack.

Parameters

func	pointer to adjoint function

Definition at line 1256 of file fvar.hpp.

void grad_stack::set_gradient_stack0	(	void(*)(void)	func,
		double *	dep_addr
	)

Description not yet available.

Parameters

Definition at line 565 of file gradstak.cpp.

Referenced by dvariable::dvariable().

void grad_stack::set_gradient_stack1	(	void(*)(void)	func,
		double *	dep_addr,
		double *	ind_addr1
	)

Sets the gradient stack entry for a function or operator with a single independent variable.

Parameters

func	Pointer to function to compute the derivative of the dependent variable with respect to the independent variable. Function prototype: void func(void);
dep_addr	Address of dependent variable; pointer to double.
ind_addr1	Address of independent variable; pointer to double

Definition at line 385 of file sgradclc.cpp.

Referenced by prevariable::operator+=().

void grad_stack::set_gradient_stack2 ( void(*)(void)  func, double *  dep_addr, double *  ind_addr1, double  mult1  )

inline

Description not yet available.

Parameters

Definition at line 1202 of file fvar.hpp.

void grad_stack::set_gradient_stack4 ( void(*)(void)  func, double *  dep_addr, double *  ind_addr1, double *  ind_addr2  )

inline

Description not yet available.

Parameters

Definition at line 1229 of file fvar.hpp.

Referenced by operator+().

size_t grad_stack::total ( ) const

inline

Definition at line 1026 of file fvar.hpp.

void grad_stack::write_grad_stack_buffer ( )

inline

Definition at line 976 of file fvar.hpp.

Referenced by gradient_structure::jacobcalc(), set_gradient_stack(), set_gradient_stack0(), set_gradient_stack1(), set_gradient_stack2(), and set_gradient_stack4().

void grad_stack::write_grad_stack_buffer

(

gradient_structure *

gs

)

Description not yet available.

Parameters

Definition at line 339 of file gradstak.cpp.

Friends And Related Function Documentation

void cleanup_temporary_files ( )

friend

Close gradient and variable files and free gradient structure memory.

Definition at line 192 of file gradstrc.cpp.

void default_evaluation ( void  )

friend

Description not yet available.

Parameters

Definition at line 61 of file def_eval.cpp.

void default_evaluation3ind ( void  )

friend

Description not yet available.

Parameters

Definition at line 174 of file def_eval.cpp.

void default_evaluation4ind ( void  )

friend

Description not yet available.

Parameters

Definition at line 205 of file def_eval.cpp.

void funnel_gradcalc ( void  )

friend

Description not yet available.

Parameters

Definition at line 76 of file xgradclc.cpp.

void grad_chk ( void  )

friend

Description not yet available.

Parameters

Definition at line 18 of file gradchk.cpp.

void gradcalc ( int  nvar, const dvector &  g  )

friend

Definition at line 77 of file sgradclc.cpp.

friend class gradient_structure

friend

Definition at line 1035 of file fvar.hpp.

void gradloop ( )

friend

void reset_gradient_stack ( void  )

friend

Rewind buffer.

Definition at line 367 of file sgradclc.cpp.

void slave_gradcalc ( void  )

friend

Member Data Documentation

int grad_stack::_GRADFILE_PTR

Definition at line 942 of file fvar.hpp.

Referenced by decrement_current_gradfile_ptr(), default_evaluation3ind(), default_evaluation4ind(), gradient_structure::funnel_gradcalc(), grad_stack(), gradient_structure::gradcalc(), increment_current_gradfile_ptr(), gradient_structure::jacobcalc(), read_grad_stack_buffer(), reset_gradient_stack(), gradient_structure::save_dependent_variable_position(), and write_grad_stack_buffer().

int grad_stack::_GRADFILE_PTR1

Definition at line 943 of file fvar.hpp.

Referenced by create_gradfile(), decrement_current_gradfile_ptr(), grad_stack(), gradient_structure::jacobcalc(), and ~grad_stack().

int grad_stack::_GRADFILE_PTR2

Definition at line 944 of file fvar.hpp.

Referenced by create_gradfile(), increment_current_gradfile_ptr(), and ~grad_stack().

int grad_stack::_VARSSAV_PTR

Definition at line 945 of file fvar.hpp.

Referenced by create_gradfile(), gradient_structure::restore_arrays(), gradient_structure::save_arrays(), and ~grad_stack().

OFF_T grad_stack::end_pos

Definition at line 952 of file fvar.hpp.

Referenced by grad_stack(), read_grad_stack_buffer(), and write_grad_stack_buffer().

OFF_T grad_stack::end_pos1

Definition at line 953 of file fvar.hpp.

Referenced by grad_stack(), gradient_structure::jacobcalc(), read_grad_stack_buffer(), and write_grad_stack_buffer().

OFF_T grad_stack::end_pos2

Definition at line 954 of file fvar.hpp.

Referenced by grad_stack().

char grad_stack::gradfile_name[61]

Definition at line 935 of file fvar.hpp.

Referenced by decrement_current_gradfile_ptr(), get_gradfile_name(), grad_stack(), increment_current_gradfile_ptr(), and write_grad_stack_buffer().

char grad_stack::gradfile_name1[61]

Definition at line 936 of file fvar.hpp.

Referenced by create_gradfile(), decrement_current_gradfile_ptr(), grad_stack(), and ~grad_stack().

char grad_stack::gradfile_name2[61]

Definition at line 937 of file fvar.hpp.

Referenced by create_gradfile(), grad_stack(), increment_current_gradfile_ptr(), and ~grad_stack().

size_t grad_stack::length

Definition at line 930 of file fvar.hpp.

Referenced by default_evaluation3ind(), default_evaluation4ind(), gradient_structure::funnel_gradcalc(), grad_stack(), gradient_structure::gradcalc(), gradient_structure::jacobcalc(), read_grad_stack_buffer(), set_gbuffer_pointers(), and write_grad_stack_buffer().

grad_stack_entry* grad_stack::ptr

Definition at line 934 of file fvar.hpp.

Referenced by default_evaluation(), default_evaluation0(), default_evaluation1(), default_evaluation1m(), default_evaluation2(), default_evaluation3(), default_evaluation3ind(), default_evaluation4(), default_evaluation4ind(), default_evaluation4m(), df_minus_eq_pvpv(), df_plus_eq_pvpv(), gradient_structure::funnel_gradcalc(), grad_stack(), gradient_structure::gradcalc(), gradient_structure::jacobcalc(), read_grad_stack_buffer(), reset_gradient_stack(), gradient_structure::save_dependent_variable_position(), set_gradient_stack(), set_gradient_stack0(), set_gradient_stack1(), set_gradient_stack2(), set_gradient_stack4(), total(), and write_grad_stack_buffer().

grad_stack_entry* grad_stack::ptr_first

Definition at line 924 of file fvar.hpp.

Referenced by default_evaluation3ind(), default_evaluation4ind(), gradient_structure::funnel_gradcalc(), grad_stack(), gradient_structure::gradcalc(), gradient_structure::jacobcalc(), read_grad_stack_buffer(), reset_gradient_stack(), set_gbuffer_pointers(), total(), and write_grad_stack_buffer().

grad_stack_entry* grad_stack::ptr_last

Definition at line 925 of file fvar.hpp.

Referenced by grad_stack(), set_gradient_stack(), set_gradient_stack0(), set_gradient_stack1(), set_gradient_stack2(), and set_gradient_stack4().

size_t grad_stack::true_length

Definition at line 931 of file fvar.hpp.

Referenced by grad_stack(), and read_grad_stack_buffer().

grad_stack_entry* grad_stack::true_ptr_first

Definition at line 923 of file fvar.hpp.

Referenced by grad_stack(), gradient_structure::gradient_structure(), read_grad_stack_buffer(), and ~grad_stack().

char grad_stack::var_store_file_name[61]

Definition at line 938 of file fvar.hpp.

Referenced by create_gradfile(), grad_stack(), and ~grad_stack().

---

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

• fvar.hpp (Last Changed on August 07, 2022 for git-revision 0a920593f1602d0b526036677a330e80065904b7.)
• gradstak.cpp (Last Changed on February 17, 2022 for git-revision e9b921f3a6f970f4a53398d141831583cf8746df.)
• gst_read.cpp (Last Changed on August 23, 2021 for git-revision 5517a826a1b05e12be827530a7bb22eca0167c93.)
• sgradclc.cpp (Last Changed on August 06, 2022 for git-revision 808780089317c67198079de06b64df009a4a6543.)