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

MADNESS 0.10.1

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

#include <funcimpl.h>

Collaboration diagram for madness::CoeffTracker< T, NDIM >:

Collaboration graph

[legend]

Public Member Functions
	CoeffTracker ()
	default ctor

	CoeffTracker (const CoeffTracker &other)
	copy ctor

	CoeffTracker (const CoeffTracker &other, const datumT &datum)
	ctor with a pair<keyT,nodeT>

	CoeffTracker (const implT *impl)
	the initial ctor making the root key

Future< CoeffTracker >	activate () const
	find the coefficients

const coeffT &	coeff () const
	const reference to the coeffs

coeffT	coeff (const keyT &key) const
	return the coefficients belonging to the passed-in key

double	dnorm (const keyT &key) const
	return the s and dnorm belonging to the passed-in key

const implT *	get_impl () const
	const reference to impl

const LeafStatus &	is_leaf () const
	const reference to is_leaf flag

const keyT &	key () const
	const reference to the key

CoeffTracker	make_child (const keyT &child) const
	make a child of this, ignoring the coeffs

template<typename Archive >
void	serialize (const Archive &ar)
	serialization

Private Types
typedef GenTensor< T >	coeffT

typedef std::pair< Key< NDIM >, ShallowNode< T, NDIM > >	datumT

typedef FunctionImpl< T, NDIM >	implT

typedef Key< NDIM >	keyT

enum	LeafStatus { no , yes , unknown }

Private Member Functions
CoeffTracker	forward_ctor (const CoeffTracker &other, const datumT &datum) const
	taskq-compatible forwarding to the ctor

Private Attributes
coeffT	coeff_
	the coefficients belonging to key

double	dnorm_ =-1.0
	norm of d coefficients corresponding to key

const implT *	impl
	the funcimpl that has the coeffs

LeafStatus	is_leaf_
	flag if key is a leaf node

keyT	key_
	the current key, which must exists in impl

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.

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. )

Member Typedef Documentation

◆ coeffT

template<typename T , size_t NDIM>

typedef GenTensor<T> madness::CoeffTracker< T, NDIM >::coeffT

private

◆ datumT

template<typename T , size_t NDIM>

typedef std::pair<Key<NDIM>,ShallowNode<T,NDIM> > madness::CoeffTracker< T, NDIM >::datumT

private

◆ implT

template<typename T , size_t NDIM>

typedef FunctionImpl<T,NDIM> madness::CoeffTracker< T, NDIM >::implT

private

◆ keyT

template<typename T , size_t NDIM>

typedef Key<NDIM> madness::CoeffTracker< T, NDIM >::keyT

private

Member Enumeration Documentation

◆ LeafStatus

template<typename T , size_t NDIM>

enum madness::CoeffTracker::LeafStatus

private

Enumerator
no
yes
unknown

Constructor & Destructor Documentation

◆ CoeffTracker() [1/4]

template<typename T , size_t NDIM>

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

inline

default ctor

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

◆ CoeffTracker() [2/4]

template<typename T , size_t NDIM>

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

inline

the initial ctor making the root key

References madness::FunctionImpl< T, NDIM >::get_cdata(), madness::CoeffTracker< T, NDIM >::impl, and madness::CoeffTracker< T, NDIM >::key_.

◆ CoeffTracker() [3/4]

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>

References madness::CoeffTracker< T, NDIM >::is_leaf_, madness::CoeffTracker< T, NDIM >::no, and madness::CoeffTracker< T, NDIM >::yes.

◆ CoeffTracker() [4/4]

template<typename T , size_t NDIM>

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

inline

copy ctor

Member Function Documentation

◆ activate()

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

References madness::CoeffTracker< T, NDIM >::CoeffTracker(), madness::WorldTaskQueue::add(), madness::FunctionImpl< T, NDIM >::find_datum(), madness::CoeffTracker< T, NDIM >::forward_ctor(), madness::FunctionImpl< T, NDIM >::get_coeffs(), madness::TaskAttributes::hipri(), madness::CoeffTracker< T, NDIM >::impl, madness::FunctionImpl< T, NDIM >::is_on_demand(), madness::CoeffTracker< T, NDIM >::key(), madness::CoeffTracker< T, NDIM >::key_, madness::nonlinear_vector_solver(), madness::WorldContainer< keyT, valueT, hashfunT >::owner(), p(), madness::WorldObject< Derived >::task(), madness::World::taskq, and madness::FunctionImpl< T, NDIM >::world.

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().

◆ coeff() [1/2]

template<typename T , size_t NDIM>

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

inline

const reference to the coeffs

References madness::CoeffTracker< T, NDIM >::coeff_.

Referenced by madness::FunctionImpl< T, NDIM >::Vphi_op_NS< opT, LDIM >::compute_error_from_inaccurate_refinement(), madness::FunctionImpl< T, NDIM >::Vphi_op_NS< opT, LDIM >::make_sum_coeffs(), madness::FunctionImpl< T, NDIM >::multiply_op< LDIM >::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()(), madness::FunctionImpl< T, NDIM >::project_out_op< LDIM >::operator()(), and madness::FunctionImpl< T, NDIM >::add_op::operator()().

◆ coeff() [2/2]

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

References madness::CoeffTracker< T, NDIM >::coeff_, madness::CoeffTracker< T, NDIM >::impl, madness::FunctionImpl< T, NDIM >::is_compressed(), madness::FunctionImpl< T, NDIM >::is_nonstandard(), madness::FunctionImpl< T, NDIM >::is_nonstandard_with_leaves(), madness::CoeffTracker< T, NDIM >::key(), madness::CoeffTracker< T, NDIM >::key_, MADNESS_ASSERT, madness::nonlinear_vector_solver(), madness::FunctionImpl< T, NDIM >::parent_to_child(), and madness::FunctionImpl< T, NDIM >::parent_to_child_NS().

◆ dnorm()

template<typename T , size_t NDIM>

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

inline

return the s and dnorm belonging to the passed-in key

References madness::CoeffTracker< T, NDIM >::dnorm_, madness::Key< NDIM >::is_child_of(), madness::CoeffTracker< T, NDIM >::key(), madness::CoeffTracker< T, NDIM >::key_, and MADNESS_ASSERT.

Referenced by madness::FunctionImpl< T, NDIM >::Vphi_op_NS< opT, LDIM >::compute_error_from_inaccurate_refinement().

◆ forward_ctor()

template<typename T , size_t NDIM>

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

inlineprivate

taskq-compatible forwarding to the ctor

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

Referenced by madness::CoeffTracker< T, NDIM >::activate().

◆ get_impl()

template<typename T , size_t NDIM>

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

inline

const reference to impl

References madness::CoeffTracker< T, NDIM >::impl.

Referenced by madness::FunctionImpl< T, NDIM >::add_op::activate(), madness::FunctionImpl< T, NDIM >::Vphi_op_NS< opT, LDIM >::have_ket(), madness::FunctionImpl< T, NDIM >::Vphi_op_NS< opT, LDIM >::have_v1(), madness::FunctionImpl< T, NDIM >::Vphi_op_NS< opT, LDIM >::have_v2(), madness::FunctionImpl< T, NDIM >::Vphi_op_NS< opT, LDIM >::make_sum_coeffs(), madness::FunctionImpl< T, NDIM >::multiply_op< LDIM >::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()(), madness::FunctionImpl< T, NDIM >::add_op::operator()(), and madness::FunctionImpl< T, NDIM >::multiply_op< LDIM >::screen().

◆ is_leaf()

template<typename T , size_t NDIM>

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

inline

const reference to is_leaf flag

References madness::CoeffTracker< T, NDIM >::is_leaf_.

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

◆ key()

template<typename T , size_t NDIM>

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

inline

const reference to the key

References madness::CoeffTracker< T, NDIM >::key_.

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

◆ make_child()

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

References madness::CoeffTracker< T, NDIM >::CoeffTracker(), madness::CoeffTracker< T, NDIM >::impl, madness::CoeffTracker< T, NDIM >::is_leaf_, madness::FunctionImpl< T, NDIM >::is_on_demand(), madness::CoeffTracker< T, NDIM >::key(), madness::CoeffTracker< T, NDIM >::key_, madness::Key< NDIM >::level(), MADNESS_ASSERT, madness::CoeffTracker< T, NDIM >::no, madness::nonlinear_vector_solver(), madness::CoeffTracker< T, NDIM >::unknown, and madness::CoeffTracker< T, NDIM >::yes.

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().

◆ serialize()

template<typename T , size_t NDIM>

template<typename Archive >

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

inline

serialization

References madness::CoeffTracker< T, NDIM >::coeff_, madness::CoeffTracker< T, NDIM >::dnorm_, madness::CoeffTracker< T, NDIM >::impl, madness::CoeffTracker< T, NDIM >::is_leaf_, madness::CoeffTracker< T, NDIM >::key_, and madness::nonlinear_vector_solver().

Member Data Documentation

◆ coeff_

template<typename T , size_t NDIM>

coeffT madness::CoeffTracker< T, NDIM >::coeff_

private

the coefficients belonging to key

Referenced by madness::CoeffTracker< T, NDIM >::coeff(), madness::CoeffTracker< T, NDIM >::coeff(), and madness::CoeffTracker< T, NDIM >::serialize().

◆ dnorm_

template<typename T , size_t NDIM>

double madness::CoeffTracker< T, NDIM >::dnorm_ =-1.0

private

norm of d coefficients corresponding to key

Referenced by madness::CoeffTracker< T, NDIM >::dnorm(), and madness::CoeffTracker< T, NDIM >::serialize().

◆ impl

template<typename T , size_t NDIM>

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

private

the funcimpl that has the coeffs

Referenced by madness::CoeffTracker< T, NDIM >::CoeffTracker(), madness::CoeffTracker< T, NDIM >::activate(), madness::CoeffTracker< T, NDIM >::coeff(), madness::CoeffTracker< T, NDIM >::get_impl(), madness::CoeffTracker< T, NDIM >::make_child(), and madness::CoeffTracker< T, NDIM >::serialize().

◆ is_leaf_

template<typename T , size_t NDIM>

LeafStatus madness::CoeffTracker< T, NDIM >::is_leaf_

private

flag if key is a leaf node

Referenced by madness::CoeffTracker< T, NDIM >::CoeffTracker(), madness::CoeffTracker< T, NDIM >::is_leaf(), madness::CoeffTracker< T, NDIM >::make_child(), and madness::CoeffTracker< T, NDIM >::serialize().

◆ key_

template<typename T , size_t NDIM>

keyT madness::CoeffTracker< T, NDIM >::key_

private

the current key, which must exists in impl

Referenced by madness::CoeffTracker< T, NDIM >::CoeffTracker(), madness::CoeffTracker< T, NDIM >::activate(), madness::CoeffTracker< T, NDIM >::coeff(), madness::CoeffTracker< T, NDIM >::dnorm(), madness::CoeffTracker< T, NDIM >::key(), madness::CoeffTracker< T, NDIM >::make_child(), and madness::CoeffTracker< T, NDIM >::serialize().

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

funcimpl.h