CppAD::checkpoint< Base > Class Template Reference

Inheritance diagram for CppAD::checkpoint< Base >:

Public Member Functions
const std::string &	afun_name (void) const
	Name corresponding to a base_atomic object. More...
void	allocate_work (size_t thread)
	allocates work_ for a specified thread More...
template<class Algo , class ADVector >
	checkpoint (const char *name, Algo &algo, const ADVector &ax, ADVector &ay, option_enum sparsity=atomic_base< Base >::pack_sparsity_enum, bool optimize=true)
	Constructor of a checkpoint object. More...
virtual bool	for_sparse_hes (const vector< bool > &vx, const vector< bool > &r, const vector< bool > &s, vector< std::set< size_t > > &h, const vector< Base > &x)
	Link, after case split, from for_hes_sweep to atomic_base. More...
virtual bool	for_sparse_hes (const vector< bool > &vx, const vector< bool > &r, const vector< bool > &s, vector< bool > &h, const vector< Base > &x)
virtual bool	for_sparse_hes (const vector< bool > &vx, const vector< bool > &r, const vector< bool > &s, vectorBool &h, const vector< Base > &x)
virtual bool	for_sparse_hes (const vector< bool > &vx, const vector< bool > &r, const vector< bool > &s, vector< std::set< size_t > > &h)
virtual bool	for_sparse_hes (const vector< bool > &vx, const vector< bool > &r, const vector< bool > &s, vector< bool > &h)
virtual bool	for_sparse_hes (const vector< bool > &vx, const vector< bool > &r, const vector< bool > &s, vectorBool &h)
template<class InternalSparsity >
void	for_sparse_hes (const vector< Base > &x, const vector< size_t > &x_index, const vector< size_t > &y_index, const InternalSparsity &for_jac_sparsity, const InternalSparsity &rev_jac_sparsity, InternalSparsity &for_hes_sparsity)
	Link, before case split, from for_hes_sweep to atomic_base. More...
virtual bool	for_sparse_jac (size_t q, const vectorBool &r, vectorBool &s, const vector< Base > &x)
	Link from user_atomic to forward sparse Jacobian pack. More...
virtual bool	for_sparse_jac (size_t q, const vector< bool > &r, vector< bool > &s, const vector< Base > &x)
	Link from user_atomic to forward sparse Jacobian bool. More...
virtual bool	for_sparse_jac (size_t q, const vector< std::set< size_t > > &r, vector< std::set< size_t > > &s, const vector< Base > &x)
	Link from user_atomic to forward sparse Jacobian sets. More...
virtual bool	for_sparse_jac (size_t q, const vector< std::set< size_t > > &r, vector< std::set< size_t > > &s)
virtual bool	for_sparse_jac (size_t q, const vector< bool > &r, vector< bool > &s)
virtual bool	for_sparse_jac (size_t q, const vectorBool &r, vectorBool &s)
template<class InternalSparsity >
void	for_sparse_jac (const vector< Base > &x, const vector< size_t > &x_index, const vector< size_t > &y_index, InternalSparsity &var_sparsity)
	Link, before case split, from for_jac_sweep to atomic_base. More...
virtual bool	forward (size_t p, size_t q, const vector< bool > &vx, vector< bool > &vy, const vector< Base > &tx, vector< Base > &ty)
	Link from user_atomic to forward mode. More...
void	free_work (size_t thread)
	frees work_ for a specified thread More...
template<class ADVector >
void	operator() (const ADVector &ax, ADVector &ay, size_t id=0)
	Implement the user call to atom_fun(ax, ay). More...
void	option (enum option_enum option_value)
virtual bool	rev_sparse_hes (const vector< bool > &vx, const vector< bool > &s, vector< bool > &t, size_t q, const vectorBool &r, const vectorBool &u, vectorBool &v, const vector< Base > &x)
	Link from user_atomic to reverse sparse Hessian pack. More...
virtual bool	rev_sparse_hes (const vector< bool > &vx, const vector< bool > &s, vector< bool > &t, size_t q, const vector< bool > &r, const vector< bool > &u, vector< bool > &v, const vector< Base > &x)
	Link from user_atomic to reverse sparse Hessian bool. More...
virtual bool	rev_sparse_hes (const vector< bool > &vx, const vector< bool > &s, vector< bool > &t, size_t q, const vector< std::set< size_t > > &r, const vector< std::set< size_t > > &u, vector< std::set< size_t > > &v, const vector< Base > &x)
	Link from user_atomic to reverse sparse Hessian sets. More...
virtual bool	rev_sparse_hes (const vector< bool > &vx, const vector< bool > &s, vector< bool > &t, size_t q, const vector< std::set< size_t > > &r, const vector< std::set< size_t > > &u, vector< std::set< size_t > > &v)
virtual bool	rev_sparse_hes (const vector< bool > &vx, const vector< bool > &s, vector< bool > &t, size_t q, const vector< bool > &r, const vector< bool > &u, vector< bool > &v)
virtual bool	rev_sparse_hes (const vector< bool > &vx, const vector< bool > &s, vector< bool > &t, size_t q, const vectorBool &r, const vectorBool &u, vectorBool &v)
template<class InternalSparsity >
void	rev_sparse_hes (const vector< Base > &x, const vector< size_t > &x_index, const vector< size_t > &y_index, const InternalSparsity &for_jac_sparsity, bool *rev_jac_flag, InternalSparsity &rev_hes_sparsity)
	Link, before case split, from rev_hes_sweep to atomic_base. More...
virtual bool	rev_sparse_jac (size_t q, const vectorBool &rt, vectorBool &st, const vector< Base > &x)
	Link from user_atomic to reverse sparse Jacobian pack. More...
virtual bool	rev_sparse_jac (size_t q, const vector< bool > &rt, vector< bool > &st, const vector< Base > &x)
	Link from user_atomic to reverse sparse Jacobian bool. More...
virtual bool	rev_sparse_jac (size_t q, const vector< std::set< size_t > > &rt, vector< std::set< size_t > > &st, const vector< Base > &x)
	Link from user_atomic to reverse Jacobian sets. More...
virtual bool	rev_sparse_jac (size_t q, const vector< std::set< size_t > > &rt, vector< std::set< size_t > > &st)
virtual bool	rev_sparse_jac (size_t q, const vector< bool > &rt, vector< bool > &st)
virtual bool	rev_sparse_jac (size_t q, const vectorBool &rt, vectorBool &st)
template<class InternalSparsity >
void	rev_sparse_jac (const vector< Base > &x, const vector< size_t > &x_index, const vector< size_t > &y_index, InternalSparsity &var_sparsity)
	Link, before case split, from rev_jac_sweep to atomic_base. More...
virtual bool	reverse (size_t q, const vector< Base > &tx, const vector< Base > &ty, vector< Base > &px, const vector< Base > &py)
	Link from user_atomic to reverse mode. More...
virtual void	set_old (size_t id)
	Set value of id (used by deprecated old_atomic class) More...
size_t	size_var (void)
	Implement the user call to atom_fun.size_var(). More...
option_enum	sparsity (void) const
	current sparsity setting More...

Static Public Member Functions
static const std::string &	class_name (size_t index)
	atomic_base function name corresponding to a certain index More...
static atomic_base *	class_object (size_t index)
	atomic_base function object corresponding to a certain index More...
static void	clear (void)
	Free all thread_alloc static memory held by atomic_base (avoids reallocations). More...

Private Types
typedef atomic_base< Base > ::option_enum	option_enum
	same as option_enum in base class More...

Private Member Functions
template<class sparsity_type >
bool	for_sparse_jac (size_t q, const sparsity_type &r, sparsity_type &s, const vector< Base > &x)
	Link from user_atomic to forward sparse Jacobian pack and bool. More...
template<class sparsity_type >
bool	rev_sparse_hes (const vector< bool > &vx, const vector< bool > &s, vector< bool > &t, size_t q, const sparsity_type &r, const sparsity_type &u, sparsity_type &v, const vector< Base > &x)
	Link from user_atomic to reverse sparse Hessian bools. More...
template<class sparsity_type >
bool	rev_sparse_jac (size_t q, const sparsity_type &rt, sparsity_type &st, const vector< Base > &x)
	Link from user_atomic to reverse sparse Jacobian pack and bool. More...
void	set_hes_sparse_bool (void)
	set hes_sparse_bool_ More...
void	set_hes_sparse_set (void)
	set hes_sparse_set_ More...
void	set_jac_sparse_bool (void)
	set jac_sparse_bool_ More...
void	set_jac_sparse_set (void)
	set jac_sparse_set_ More...
option_enum	sparsity (void)

Private Attributes
ADFun< Base >	f_
	AD function corresponding to this checkpoint object. More...
vectorBool	hes_sparse_bool_
local::sparse_list	hes_sparse_set_
	sparsity for sum_i f_i(x)^{(2)} does not change so can cache it More...
vectorBool	jac_sparse_bool_
local::sparse_list	jac_sparse_set_
	sparsity for entire Jacobian f(x)^{(1)} does not change so can cache it More...

Detailed Description

template<class Base>
class CppAD::checkpoint< Base >

Definition at line 259 of file checkpoint.hpp.

---

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

• checkpoint.hpp