MADNESS  version 0.9
Public Member Functions | Protected Attributes | Friends | List of all members
madness::FunctionFactory< T, NDIM > Singleton Reference

FunctionFactory implements the named-parameter idiom for Function. More...

#include <funcimpl.h>

Inheritance diagram for madness::FunctionFactory< T, NDIM >:
Inheritance graph
[legend]
Collaboration diagram for madness::FunctionFactory< T, NDIM >:
Collaboration graph
[legend]

Public Member Functions

 FunctionFactory (World &world)
 
virtual ~FunctionFactory ()
 
FunctionFactory & functor (const std::shared_ptr< FunctionFunctorInterface< T, NDIM > > &f)
 
template<typename opT >
FunctionFactory & functor2 (const opT &op)
 
FunctionFactory & no_functor ()
 
FunctionFactory & f (T(*f)(const coordT &))
 
virtual FunctionFactory & k (int k)
 
virtual FunctionFactory & thresh (double thresh)
 
FunctionFactory & initial_level (int initial_level)
 
FunctionFactory & max_refine_level (int max_refine_level)
 
FunctionFactory & truncate_mode (int truncate_mode)
 
FunctionFactory & refine (bool refine=true)
 
FunctionFactory & norefine (bool norefine=true)
 
FunctionFactory & empty ()
 
FunctionFactory & autorefine ()
 
FunctionFactory & noautorefine ()
 
FunctionFactory & truncate_on_project ()
 
FunctionFactory & notruncate_on_project ()
 
FunctionFactory & fence (bool fence=true)
 
FunctionFactory & nofence ()
 
virtual FunctionFactory & is_on_demand ()
 
FunctionFactory & pmap (const std::shared_ptr< WorldDCPmapInterface< Key< NDIM > > > &pmap)
 
int get_k () const
 
double get_thresh () const
 
World & get_world () const
 
virtual std::shared_ptr
< FunctionFunctorInterface< T,
NDIM > > 		get_functor () const
 return the functor; override this if the functor needs deferred construction More...
 
FunctionFactory & self ()
 implement this in all derived classes for correct chaining More...
 

Protected Attributes

World & _world
 
int _k
 
double _thresh
 
int _initial_level
 
int _max_refine_level
 
int _truncate_mode
 
bool _refine
 
bool _empty
 
bool _autorefine
 
bool _truncate_on_project
 
bool _fence
 
bool _is_on_demand
 
std::shared_ptr
< WorldDCPmapInterface< Key
< NDIM > > > 		_pmap
 

Friends

class FunctionImpl< T, NDIM >
 

Detailed Description

template<typename T, std::size_t NDIM>
singleton madness::FunctionFactory< T, NDIM >

FunctionFactory implements the named-parameter idiom for Function.

C++ does not provide named arguments (as does, e.g., Python). This class provides something very close. Create functions as follows

double myfunc(const double x[]);
Function<double,3> f = FunctionFactory<double,3>(world).f(myfunc).k(11).thresh(1e-9).debug()

where the methods of function factory, which specify the non-default arguments eventually passed to the Function constructor, can be used in any order.

Need to add a general functor for initial projection with a standard interface.

Constructor & Destructor Documentation

template<typename T, std::size_t NDIM>
madness::FunctionFactory< T, NDIM >::FunctionFactory ( World &  world)
inline
template<typename T, std::size_t NDIM>
virtual madness::FunctionFactory< T, NDIM >::~FunctionFactory ( )
inlinevirtual

Member Function Documentation

template<typename T, std::size_t NDIM>
FunctionFactory& madness::FunctionFactory< T, NDIM >::autorefine ( )
inline
template<typename T, std::size_t NDIM>
FunctionFactory& madness::FunctionFactory< T, NDIM >::empty ( )
inline

Referenced by madness::apply(), and madness::hartree_product().

template<typename T, std::size_t NDIM>
FunctionFactory& madness::FunctionFactory< T, NDIM >::f ( T(*)(const coordT &)  f)
inline

Referenced by madness::FunctionFactory< double, 6 >::f(), madness::FunctionFactory< double, 6 >::functor(), and main().

template<typename T, std::size_t NDIM>
FunctionFactory& madness::FunctionFactory< T, NDIM >::fence ( bool  fence = true)
inline

Referenced by madness::FunctionFactory< double, 6 >::fence(), and madness::Function< double, 6 >::project_out().

template<typename T, std::size_t NDIM>
FunctionFactory& madness::FunctionFactory< T, NDIM >::functor ( const std::shared_ptr< FunctionFunctorInterface< T, NDIM > > &  f)
inline

Referenced by madness::FunctionFactory< double, 6 >::f().

template<typename T, std::size_t NDIM>
template<typename opT >
FunctionFactory& madness::FunctionFactory< T, NDIM >::functor2 ( const opT &  op)
inline
template<typename T, std::size_t NDIM>
virtual std::shared_ptr<FunctionFunctorInterface<T, NDIM> > madness::FunctionFactory< T, NDIM >::get_functor ( ) const
inlinevirtual

return the functor; override this if the functor needs deferred construction

Reimplemented in madness::FGFactory< T, NDIM >, madness::TwoElectronFactory, and madness::CompositeFactory< T, NDIM, MDIM >.

template<typename T, std::size_t NDIM>
int madness::FunctionFactory< T, NDIM >::get_k ( ) const
inline
template<typename T, std::size_t NDIM>
double madness::FunctionFactory< T, NDIM >::get_thresh ( ) const
inline
template<typename T, std::size_t NDIM>
World& madness::FunctionFactory< T, NDIM >::get_world ( ) const
inline
template<typename T, std::size_t NDIM>
FunctionFactory& madness::FunctionFactory< T, NDIM >::initial_level ( int  initial_level)
inline

Referenced by madness::FunctionFactory< double, 6 >::initial_level(), and plocalize_boys().

template<typename T, std::size_t NDIM>
virtual FunctionFactory& madness::FunctionFactory< T, NDIM >::is_on_demand ( )
inlinevirtual
template<typename T, std::size_t NDIM>
virtual FunctionFactory& madness::FunctionFactory< T, NDIM >::k ( int  k)
inlinevirtual

Referenced by madness::FunctionFactory< double, 6 >::k().

template<typename T, std::size_t NDIM>
FunctionFactory& madness::FunctionFactory< T, NDIM >::max_refine_level ( int  max_refine_level)
inline

Referenced by madness::FunctionFactory< double, 6 >::max_refine_level().

template<typename T, std::size_t NDIM>
FunctionFactory& madness::FunctionFactory< T, NDIM >::no_functor ( )
inline
template<typename T, std::size_t NDIM>
FunctionFactory& madness::FunctionFactory< T, NDIM >::noautorefine ( )
inline
template<typename T, std::size_t NDIM>
FunctionFactory& madness::FunctionFactory< T, NDIM >::nofence ( )
inline
template<typename T, std::size_t NDIM>
FunctionFactory& madness::FunctionFactory< T, NDIM >::norefine ( bool  norefine = true)
inline

Referenced by madness::FunctionFactory< double, 6 >::norefine().

template<typename T, std::size_t NDIM>
FunctionFactory& madness::FunctionFactory< T, NDIM >::notruncate_on_project ( )
inline
template<typename T, std::size_t NDIM>
FunctionFactory& madness::FunctionFactory< T, NDIM >::pmap ( const std::shared_ptr< WorldDCPmapInterface< Key< NDIM > > > &  pmap)
inline

Referenced by madness::FunctionFactory< double, 6 >::pmap().

template<typename T, std::size_t NDIM>
FunctionFactory& madness::FunctionFactory< T, NDIM >::refine ( bool  refine = true)
inline

Referenced by madness::FunctionFactory< double, 6 >::refine().

template<typename T, std::size_t NDIM>
FunctionFactory& madness::FunctionFactory< T, NDIM >::self ( )
inline

implement this in all derived classes for correct chaining

template<typename T, std::size_t NDIM>
virtual FunctionFactory& madness::FunctionFactory< T, NDIM >::thresh ( double  thresh)
inlinevirtual

Reimplemented in madness::FGFactory< T, NDIM >, and madness::TwoElectronFactory.

Referenced by madness::FunctionFactory< double, 6 >::thresh().

template<typename T, std::size_t NDIM>
FunctionFactory& madness::FunctionFactory< T, NDIM >::truncate_mode ( int  truncate_mode)
inline

Referenced by madness::FunctionFactory< double, 6 >::truncate_mode().

template<typename T, std::size_t NDIM>
FunctionFactory& madness::FunctionFactory< T, NDIM >::truncate_on_project ( )
inline

Friends And Related Function Documentation

template<typename T, std::size_t NDIM>
friend class FunctionImpl< T, NDIM >
friend

Member Data Documentation

template<typename T, std::size_t NDIM>
bool madness::FunctionFactory< T, NDIM >::_autorefine
protected
template<typename T, std::size_t NDIM>
bool madness::FunctionFactory< T, NDIM >::_empty
protected

Referenced by madness::FunctionImpl< Q, NDIM >::FunctionImpl().

template<typename T, std::size_t NDIM>
bool madness::FunctionFactory< T, NDIM >::_fence
protected

Referenced by madness::FunctionImpl< Q, NDIM >::FunctionImpl().

template<typename T, std::size_t NDIM>
int madness::FunctionFactory< T, NDIM >::_initial_level
protected
template<typename T, std::size_t NDIM>
bool madness::FunctionFactory< T, NDIM >::_is_on_demand
protected
template<typename T, std::size_t NDIM>
int madness::FunctionFactory< T, NDIM >::_k
protected

Referenced by madness::FunctionFactory< double, 6 >::get_k().

template<typename T, std::size_t NDIM>
int madness::FunctionFactory< T, NDIM >::_max_refine_level
protected
template<typename T, std::size_t NDIM>
std::shared_ptr<WorldDCPmapInterface<Key<NDIM> > > madness::FunctionFactory< T, NDIM >::_pmap
protected
template<typename T, std::size_t NDIM>
bool madness::FunctionFactory< T, NDIM >::_refine
protected

Referenced by madness::FunctionImpl< Q, NDIM >::FunctionImpl().

template<typename T, std::size_t NDIM>
double madness::FunctionFactory< T, NDIM >::_thresh
protected

Referenced by madness::FunctionFactory< double, 6 >::get_thresh().

template<typename T, std::size_t NDIM>
int madness::FunctionFactory< T, NDIM >::_truncate_mode
protected
template<typename T, std::size_t NDIM>
bool madness::FunctionFactory< T, NDIM >::_truncate_on_project
protected
template<typename T, std::size_t NDIM>
World& madness::FunctionFactory< T, NDIM >::_world
protected

Referenced by madness::FunctionFactory< double, 6 >::get_world().

The documentation for this singleton was generated from the following files:
Generated on Fri Sep 26 2014 10:39:40 for MADNESS by   doxygen 1.8.8