Geant4  10.03.p03
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
c2_plugin_function_p< float_type > Class Template Reference

#include <c2_function.hh>

Inheritance diagram for c2_plugin_function_p< float_type >:
Collaboration diagram for c2_plugin_function_p< float_type >:

Public Member Functions

 c2_plugin_function_p ()
 construct the container with no function More...
 
 c2_plugin_function_p (c2_function< float_type > &f)
 construct the container with a pre-defined function More...
 
void set_function (c2_function< float_type > *f)
 
virtual float_type value_with_derivatives (float_type x, float_type *yprime, float_type *yprime2) const
 get the value and derivatives. More...
 
virtual ~c2_plugin_function_p ()
 destructor More...
 
void unset_function ()
 clear our function More...
 
virtual void get_sampling_grid (float_type amin, float_type amax, std::vector< float_type > &grid) const
 
- Public Member Functions inherited from c2_function< float_type >
const std::string cvs_header_vers () const
 get versioning information for the header file More...
 
const std::string cvs_file_vers () const
 get versioning information for the source file More...
 
virtual ~c2_function ()
 destructor More...
 
float_type operator() (float_type x) const
 evaluate the function in the classic way, ignoring derivatives. More...
 
float_type operator() (float_type x, float_type *yprime, float_type *yprime2) const
 get the value and derivatives. More...
 
float_type find_root (float_type lower_bracket, float_type upper_bracket, float_type start, float_type value, int *error=0, float_type *final_yprime=0, float_type *final_yprime2=0) const
 solve f(x)==value very efficiently, with explicit knowledge of derivatives of the function More...
 
float_type partial_integrals (std::vector< float_type > xgrid, std::vector< float_type > *partials=0, float_type abs_tol=1e-12, float_type rel_tol=1e-12, int derivs=2, bool adapt=true, bool extrapolate=true) const
 
float_type integral (float_type amin, float_type amax, std::vector< float_type > *partials=0, float_type abs_tol=1e-12, float_type rel_tol=1e-12, int derivs=2, bool adapt=true, bool extrapolate=true) const
 a fully-automated integrator which uses the information provided by the get_sampling_grid() function to figure out what to do. More...
 
c2_piecewise_function_p
< float_type > * 
adaptively_sample (float_type amin, float_type amax, float_type abs_tol=1e-12, float_type rel_tol=1e-12, int derivs=2, std::vector< float_type > *xvals=0, std::vector< float_type > *yvals=0) const
 create a c2_piecewise_function_p from c2_connector_function_p segments which is a representation of the parent function to the specified accuracy, but maybe much cheaper to evaluate More...
 
float_type xmin () const
 
float_type xmax () const
 
void set_domain (float_type amin, float_type amax)
 
size_t get_evaluations () const
 
void reset_evaluations () const
 reset the counter More...
 
void increment_evaluations () const
 count evaluations More...
 
bool check_monotonicity (const std::vector< float_type > &data, const char message[]) const
 check that a vector is monotonic, throw an exception if not, and return a flag if it is reversed More...
 
virtual void set_sampling_grid (const std::vector< float_type > &grid)
 establish a grid of 'interesting' points on the function. More...
 
std::vector< float_type > * get_sampling_grid_pointer () const
 get the sampling grid, which may be a null pointer More...
 
void preen_sampling_grid (std::vector< float_type > *result) const
 The grid is modified in place. More...
 
void refine_sampling_grid (std::vector< float_type > &grid, size_t refinement) const
 
c2_function< float_type > & normalized_function (float_type amin, float_type amax, float_type norm=1.0) const
 create a new c2_function from this one which is normalized on the interval More...
 
c2_function< float_type > & square_normalized_function (float_type amin, float_type amax, float_type norm=1.0) const
 
c2_function< float_type > & square_normalized_function (float_type amin, float_type amax, const c2_function< float_type > &weight, float_type norm=1.0) const
 create a new c2_function from this one which is square-normalized with the provided weight on the interval More...
 
c2_sum_p< float_type > & operator+ (const c2_function< float_type > &rhs) const
 factory function to create a c2_sum_p from a regular algebraic expression. More...
 
c2_diff_p< float_type > & operator- (const c2_function< float_type > &rhs) const
 factory function to create a c2_diff_p from a regular algebraic expression. More...
 
c2_product_p< float_type > & operator* (const c2_function< float_type > &rhs) const
 factory function to create a c2_product_p from a regular algebraic expression. More...
 
c2_ratio_p< float_type > & operator/ (const c2_function< float_type > &rhs) const
 
c2_composed_function_p
< float_type > & 
operator() (const c2_function< float_type > &inner) const
 compose this function outside another. More...
 
float_type get_trouble_point () const
 Find out where a calculation ran into trouble, if it got a nan. If the most recent computation did not return a nan, this is undefined. More...
 
void claim_ownership () const
 increment our reference count. Destruction is only legal if the count is zero. More...
 
size_t release_ownership_for_return () const
 decrement our reference count. Do not destroy at zero. More...
 
void release_ownership () const
 
size_t count_owners () const
 get the reference count, mostly for debugging More...
 
void fill_fblock (c2_fblock< float_type > &fb) const
 fill in a c2_fblock<float_type>... a shortcut for the integrator & sampler More...
 

Protected Attributes

c2_ptr< float_type > func
 
- Protected Attributes inherited from c2_function< float_type >
std::vector< float_type > * sampling_grid
 
bool no_overwrite_grid
 
float_type fXMin
 
float_type fXMax
 
size_t evaluations
 
float_type bad_x_point
 this point may be used to record where a calculation ran into trouble More...
 

Additional Inherited Members

- Protected Member Functions inherited from c2_function< float_type >
 c2_function (const c2_function< float_type > &src)
 
 c2_function ()
 
virtual void set_sampling_grid_pointer (std::vector< float_type > &grid)
 

Detailed Description

template<typename float_type = double>
class c2_plugin_function_p< float_type >

Definition at line 879 of file c2_function.hh.

Constructor & Destructor Documentation

template<typename float_type = double>
c2_plugin_function_p< float_type >::c2_plugin_function_p ( )
inline

construct the container with no function

Definition at line 883 of file c2_function.hh.

the parent class for all c2_functions.c2_functions know their value, first, and second derivative at ...
Definition: c2_function.hh:147
c2_ptr< float_type > func
Definition: c2_function.hh:919
template<typename float_type = double>
c2_plugin_function_p< float_type >::c2_plugin_function_p ( c2_function< float_type > &  f)
inline

construct the container with a pre-defined function

Definition at line 885 of file c2_function.hh.

885  :
the parent class for all c2_functions.c2_functions know their value, first, and second derivative at ...
Definition: c2_function.hh:147
c2_ptr< float_type > func
Definition: c2_function.hh:919
template<typename float_type = double>
virtual c2_plugin_function_p< float_type >::~c2_plugin_function_p ( )
inlinevirtual

destructor

Definition at line 904 of file c2_function.hh.

904 { }

Member Function Documentation

template<typename float_type = double>
virtual void c2_plugin_function_p< float_type >::get_sampling_grid ( float_type  amin,
float_type  amax,
std::vector< float_type > &  grid 
) const
inlinevirtual

Reimplemented from c2_function< float_type >.

Definition at line 909 of file c2_function.hh.

911  {
912  if(!func.valid())
913  throw c2_exception("c2_plugin_function_p called uninitialized");
914  if(this->sampling_grid)
916  else func->get_sampling_grid(amin, amax, grid);
917  }
virtual void get_sampling_grid(float_type amin, float_type amax, std::vector< float_type > &grid) const
the exception class for c2_function operations.
Definition: c2_function.hh:65
c2_ptr< float_type > func
Definition: c2_function.hh:919
std::vector< float_type > * sampling_grid
Definition: c2_function.hh:544
template<typename float_type = double>
void c2_plugin_function_p< float_type >::set_function ( c2_function< float_type > *  f)
inline

Definition at line 888 of file c2_function.hh.

889  {
890  func.set_function(f);
891  if(f) this->set_domain(f->xmin(), f->xmax());
892  }
void set_domain(float_type amin, float_type amax)
Definition: c2_function.hh:391
c2_ptr< float_type > func
Definition: c2_function.hh:919
float_type xmax() const
Definition: c2_function.hh:390
float_type xmin() const
Definition: c2_function.hh:389

Here is the caller graph for this function:

template<typename float_type = double>
void c2_plugin_function_p< float_type >::unset_function ( )
inline

clear our function

Definition at line 907 of file c2_function.hh.

907 { func.unset_function(); }
c2_ptr< float_type > func
Definition: c2_function.hh:919

Here is the caller graph for this function:

template<typename float_type = double>
virtual float_type c2_plugin_function_p< float_type >::value_with_derivatives ( float_type  x,
float_type *  yprime,
float_type *  yprime2 
) const
inlinevirtual

get the value and derivatives.

There is required checking for null pointers on the derivatives, and most implementations should operate faster if derivatives are not

Parameters
[in]xthe point at which to evaluate the function
[out]yprimethe first derivative (if pointer is non-null)
[out]yprime2the second derivative (if pointer is non-null)
Returns
the value of the function Uses the internal function pointer set by set_function().

Implements c2_function< float_type >.

Definition at line 895 of file c2_function.hh.

898  {
899  if(!func.valid())
900  throw c2_exception("c2_plugin_function_p called uninitialized");
901  return func->value_with_derivatives(x, yprime, yprime2);
902  }
tuple x
Definition: test.py:50
the exception class for c2_function operations.
Definition: c2_function.hh:65
c2_ptr< float_type > func
Definition: c2_function.hh:919

Member Data Documentation

template<typename float_type = double>
c2_ptr<float_type> c2_plugin_function_p< float_type >::func
protected

Definition at line 919 of file c2_function.hh.


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