madness::CoeffTracker< T, NDIM > Class Template Reference

a class to track where relevant (parent) coeffs are More...

#include <funcimpl.h>

Public Member Functions
	CoeffTracker ()
	default ctor More...
	CoeffTracker (const implT *impl)
	the initial ctor making the root key More...
	CoeffTracker (const CoeffTracker &other, const datumT &datum)
	ctor with a pair<keyT,nodeT> More...
	CoeffTracker (const CoeffTracker &other)
	copy ctor More...
const implT *	get_impl () const
	const reference to impl More...
const coeffT &	coeff () const
	const reference to the coeffs More...
const keyT &	key () const
	const reference to the key More...
coeffT	coeff (const keyT &key) const
	return the coefficients belonging to the passed-in key More...
const LeafStatus &	is_leaf () const
	const reference to is_leaf flag More...
CoeffTracker	make_child (const keyT &child) const
	make a child of this, ignoring the coeffs More...
Future< CoeffTracker >	activate () const
	find the coefficients More...
template<typename Archive >
void	serialize (const Archive &ar)
	serialization More...

Detailed Description

template<typename T, size_t NDIM>
class madness::CoeffTracker< T, NDIM >

a class to track where relevant (parent) coeffs are

E.g. if a 6D function is composed of two 3D functions their coefficients must be tracked. We might need coeffs from a box that does not exist, and to avoid searching for parents we track which are their required respective boxes.

• CoeffTracker will refer either to a requested key, if it exists, or to its outermost parent.
• Children must be made in sequential order to be able to track correctly.

Usage: 1. make the child of a given CoeffTracker. If the parent CoeffTracker refers to a leaf node (flag is_leaf) the child will refer to the same node. Otherwise it will refer to the child node.

1. retrieve its coefficients (possible communication/ returns a Future). Member variable key always refers to an existing node, so we can fetch it. Once we have the node we can determine if it has children which allows us to make a child (see 1. )

Constructor & Destructor Documentation

template<typename T, size_t NDIM>

madness::CoeffTracker< T, NDIM >::CoeffTracker ( )

inline

default ctor

Referenced by madness::CoeffTracker< T, LDIM >::activate(), and madness::CoeffTracker< T, LDIM >::make_child().

template<typename T, size_t NDIM>

madness::CoeffTracker< T, NDIM >::CoeffTracker ( const implT *  impl )

inline

the initial ctor making the root key

template<typename T, size_t NDIM>

madness::CoeffTracker< T, NDIM >::CoeffTracker ( const CoeffTracker< T, NDIM > &  other, const datumT &  datum  )

inlineexplicit

ctor with a pair<keyT,nodeT>

template<typename T, size_t NDIM>

madness::CoeffTracker< T, NDIM >::CoeffTracker ( const CoeffTracker< T, NDIM > &  other )

inline

copy ctor

Member Function Documentation

template<typename T, size_t NDIM>

Future<CoeffTracker> madness::CoeffTracker< T, NDIM >::activate ( ) const

inline

find the coefficients

this involves communication to a remote node

Returns

a Future<CoeffTracker> with the coefficients that key refers to

Referenced by madness::FunctionImpl< T, NDIM >::multiply_op< LDIM >::activate(), madness::FunctionImpl< T, NDIM >::add_op::activate(), madness::FunctionImpl< T, NDIM >::hartree_op< LDIM, leaf_opT >::activate(), madness::FunctionImpl< T, NDIM >::Vphi_op_NS< opT, LDIM >::activate(), madness::FunctionImpl< T, NDIM >::recursive_apply_op< opT, LDIM >::activate(), madness::FunctionImpl< T, NDIM >::recursive_apply_op2< opT >::activate(), and madness::FunctionImpl< T, NDIM >::project_out_op< LDIM >::activate().

template<typename T, size_t NDIM>

const coeffT& madness::CoeffTracker< T, NDIM >::coeff ( ) const

inline

const reference to the coeffs

Referenced by madness::FunctionImpl< T, NDIM >::Vphi_op_NS< opT, LDIM >::make_childrens_sum_coeffs(), madness::FunctionImpl< T, NDIM >::Vphi_op_NS< opT, LDIM >::make_sum_coeffs(), madness::FunctionImpl< T, NDIM >::multiply_op< LDIM >::operator()(), madness::FunctionImpl< T, NDIM >::add_op::operator()(), madness::FunctionImpl< T, NDIM >::hartree_op< LDIM, leaf_opT >::operator()(), madness::FunctionImpl< T, NDIM >::recursive_apply_op< opT, LDIM >::operator()(), madness::FunctionImpl< T, NDIM >::recursive_apply_op2< opT >::operator()(), and madness::FunctionImpl< T, NDIM >::project_out_op< LDIM >::operator()().

template<typename T, size_t NDIM>

coeffT madness::CoeffTracker< T, NDIM >::coeff ( const keyT &  key ) const

inline

return the coefficients belonging to the passed-in key

if key equals tracked key just return the coeffs, otherwise make the child coefficients.

Parameters

[in]

key

return coeffs corresponding to this key

Returns

coefficients belonging to key

template<typename T, size_t NDIM>

const implT* madness::CoeffTracker< T, NDIM >::get_impl ( ) const

inline

const reference to impl

Referenced by madness::FunctionImpl< T, NDIM >::add_op::activate(), madness::FunctionImpl< T, NDIM >::Vphi_op_NS< opT, LDIM >::make_childrens_sum_coeffs(), madness::FunctionImpl< T, NDIM >::Vphi_op_NS< opT, LDIM >::make_sum_coeffs(), madness::FunctionImpl< T, NDIM >::multiply_op< LDIM >::operator()(), madness::FunctionImpl< T, NDIM >::add_op::operator()(), madness::FunctionImpl< T, NDIM >::hartree_op< LDIM, leaf_opT >::operator()(), madness::FunctionImpl< T, NDIM >::recursive_apply_op< opT, LDIM >::operator()(), madness::FunctionImpl< T, NDIM >::project_out_op< LDIM >::operator()(), and madness::FunctionImpl< T, NDIM >::multiply_op< LDIM >::screen().

template<typename T, size_t NDIM>

const LeafStatus& madness::CoeffTracker< T, NDIM >::is_leaf ( ) const

inline

const reference to is_leaf flag

Referenced by madness::FunctionImpl< T, NDIM >::add_op::operator()(), and madness::FunctionImpl< T, NDIM >::recursive_apply_op2< opT >::operator()().

template<typename T, size_t NDIM>

const keyT& madness::CoeffTracker< T, NDIM >::key ( ) const

inline

const reference to the key

Referenced by madness::CoeffTracker< T, LDIM >::activate(), madness::CoeffTracker< T, LDIM >::make_child(), madness::FunctionImpl< T, NDIM >::multiply_op< LDIM >::operator()(), madness::FunctionImpl< T, NDIM >::add_op::operator()(), and madness::FunctionImpl< T, NDIM >::project_out_op< LDIM >::operator()().

template<typename T, size_t NDIM>

CoeffTracker madness::CoeffTracker< T, NDIM >::make_child ( const keyT &  child ) const

inline

make a child of this, ignoring the coeffs

Referenced by madness::FunctionImpl< T, NDIM >::multiply_op< LDIM >::make_child(), madness::FunctionImpl< T, NDIM >::add_op::make_child(), madness::FunctionImpl< T, NDIM >::hartree_op< LDIM, leaf_opT >::make_child(), madness::FunctionImpl< T, NDIM >::Vphi_op_NS< opT, LDIM >::make_child(), madness::FunctionImpl< T, NDIM >::recursive_apply_op< opT, LDIM >::make_child(), madness::FunctionImpl< T, NDIM >::recursive_apply_op2< opT >::make_child(), and madness::FunctionImpl< T, NDIM >::project_out_op< LDIM >::make_child().

template<typename T, size_t NDIM>

template<typename Archive >

void madness::CoeffTracker< T, NDIM >::serialize ( const Archive &  ar )

inline

serialization

---

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

• funcimpl.h