c2_const_ptr< float_type > Class Template Reference

create a container for a c2_function which handles the reference counting. It is useful as a smart container to hold a c2_function and keep the reference count correct. The recommended way for a class to store a c2_function which is handed in from the outside is for it to have a c2_ptr member into which the passed-in function is stored. This way, when the class instance is deleted, it will automatically dereference any function which it was handed. More...

#include <c2_function.hh>

Inheritance diagram for c2_const_ptr< float_type >:

Public Member Functions
	c2_const_ptr ()
	construct the container with no function More...
	c2_const_ptr (const c2_function< float_type > &f)
	construct the container with a pre-defined function More...
	c2_const_ptr (const c2_const_ptr< float_type > &src)
	copy constructor More...
void	set_function (const c2_function< float_type > *f)
const c2_const_ptr< float_type > &	operator= (const c2_const_ptr< float_type > &f)
	fill the container from another container More...
const c2_function< float_type > &	operator= (const c2_function< float_type > &f)
	fill the container with a function More...
void	release_for_return ()
	release the function without destroying it, so it can be returned from a function More...
void	unset_function (void)
	clear the function More...
	~c2_const_ptr ()
	destructor More...
const c2_function< float_type > &	get () const
	get a reference to our owned function More...
const c2_function< float_type > *	get_ptr () const
	get an unchecked pointer to our owned function More...
const c2_function< float_type > *	operator-> () const
	get a checked pointer to our owned function More...
bool	valid () const
	check if we have a valid function More...
	operator const c2_function< float_type > & () const
	type coercion operator which lets us use a pointer as if it were a const c2_function More...
float_type	operator() (float_type x) const
	convenience operator to make us look like a function More...
float_type	operator() (float_type x, float_type *yprime, float_type *yprime2) const
	convenience operator to make us look like a function 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
c2_product_p< float_type > &	operator* (const c2_function< float_type > &rhs) const
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...

Protected Attributes
const c2_function< float_type > *	func

Detailed Description

template<typename float_type>
class c2_const_ptr< float_type >

create a container for a c2_function which handles the reference counting. It is useful as a smart container to hold a c2_function and keep the reference count correct. The recommended way for a class to store a c2_function which is handed in from the outside is for it to have a c2_ptr member into which the passed-in function is stored. This way, when the class instance is deleted, it will automatically dereference any function which it was handed.

This class contains a copy constructor and operator=, to make it fairly easy to make a std::vector of these objects, and have it work as expected.

Definition at line 681 of file c2_function.hh.

Constructor & Destructor Documentation

template<typename float_type>

c2_const_ptr< float_type >::c2_const_ptr ( )

inline

construct the container with no function

Definition at line 684 of file c2_function.hh.

: func(0)  {}

template<typename float_type>

c2_const_ptr< float_type >::c2_const_ptr ( const c2_function< float_type > &  f )

inline

construct the container with a pre-defined function

Parameters

f	the function to store

Definition at line 687 of file c2_function.hh.

                                                 : func(0) 
  { this->set_function(&f); }

template<typename float_type>

c2_const_ptr< float_type >::c2_const_ptr ( const c2_const_ptr< float_type > &  src )

inline

copy constructor

Parameters

src	the container to copy

Definition at line 691 of file c2_function.hh.

                                                    : func(0)
  { this->set_function(src.get_ptr()); }

template<typename float_type>

c2_const_ptr< float_type >::~c2_const_ptr ( )

inline

destructor

Definition at line 732 of file c2_function.hh.

{ this->set_function(0); }

Member Function Documentation

template<typename float_type>

const c2_function<float_type>& c2_const_ptr< float_type >::get ( ) const

inline

get a reference to our owned function

Definition at line 735 of file c2_function.hh.

  { 
    if(!func) throw c2_exception("c2_ptr accessed uninitialized");
    return *func;
  }

Here is the caller graph for this function:

template<typename float_type>

const c2_function<float_type>* c2_const_ptr< float_type >::get_ptr ( ) const

inline

get an unchecked pointer to our owned function

Definition at line 741 of file c2_function.hh.

{ return func; }

Here is the caller graph for this function:

template<typename float_type>

c2_const_ptr< float_type >::operator const c2_function< float_type > & ( ) const

inline

type coercion operator which lets us use a pointer as if it were a const c2_function

Definition at line 750 of file c2_function.hh.

{ return this->get(); }

template<typename float_type>

float_type c2_const_ptr< float_type >::operator() ( float_type  x ) const

inline

convenience operator to make us look like a function

Parameters

x	the value at which to evaluate the contained function

Returns

the evaluated function

Definition at line 756 of file c2_function.hh.

  { return get()(x); }

template<typename float_type>

float_type c2_const_ptr< float_type >::operator() ( float_type  x, float_type *  yprime, float_type *  yprime2  ) const

inline

convenience operator to make us look like a function

Parameters

x	the value at which to evaluate the contained function
yprime	the derivative
yprime2	the second derivative

Returns

the evaluated function

Note

If you using this repeatedly, do const c2_function<float_type> &func=ptr; and use func(x). Calling this operator wastes some time, since it checks the alidity of the pointer every time.

Definition at line 767 of file c2_function.hh.

  { return get().value_with_derivatives(x, yprime, yprime2); }

template<typename float_type>

c2_composed_function_p<float_type>& c2_const_ptr< float_type >::operator() ( const c2_function< float_type > &  inner ) const

inline

compose this function outside another.

Parameters

inner

the inner function

Returns

the composed function

Definition at line 790 of file c2_function.hh.

  { return *new c2_composed_function_p<float_type>(get(), inner); }

template<typename float_type>

c2_product_p<float_type>& c2_const_ptr< float_type >::operator* ( const c2_function< float_type > &  rhs ) const

inline

Definition at line 780 of file c2_function.hh.

  { return *new c2_product_p<float_type>(get(), rhs); }

template<typename float_type>

c2_sum_p<float_type>& c2_const_ptr< float_type >::operator+ ( const c2_function< float_type > &  rhs ) const

inline

factory function to create a c2_sum_p from a regular algebraic expression.

Parameters

rhs	the right-hand term of the sum

Returns

a new c2_function

Definition at line 774 of file c2_function.hh.

  { return *new c2_sum_p<float_type>(get(), rhs); }

template<typename float_type>

c2_diff_p<float_type>& c2_const_ptr< float_type >::operator- ( const c2_function< float_type > &  rhs ) const

inline

Definition at line 777 of file c2_function.hh.

  { return *new c2_diff_p<float_type>(get(), rhs); }

template<typename float_type>

const c2_function<float_type>* c2_const_ptr< float_type >::operator-> ( ) const

inline

get a checked pointer to our owned function

Definition at line 743 of file c2_function.hh.

  { return &get(); }

template<typename float_type>

c2_ratio_p<float_type>& c2_const_ptr< float_type >::operator/ ( const c2_function< float_type > &  rhs ) const

inline

Definition at line 783 of file c2_function.hh.

  { return *new c2_ratio_p<float_type>(get(), rhs); }

template<typename float_type>

const c2_const_ptr<float_type>& c2_const_ptr< float_type >::operator= ( const c2_const_ptr< float_type > &  f )

inline

fill the container from another container

Parameters

f	the container to copy

Definition at line 703 of file c2_function.hh.

  { this->set_function(f.get_ptr()); return f; }

template<typename float_type>

const c2_function<float_type>& c2_const_ptr< float_type >::operator= ( const c2_function< float_type > &  f )

inline

fill the container with a function

Parameters

f	the function

Definition at line 708 of file c2_function.hh.

  { this->set_function(&f); return f; }

template<typename float_type>

void c2_const_ptr< float_type >::release_for_return ( )

inline

release the function without destroying it, so it can be returned from a function

This is usually the very last line of a function before the return statement, so that any exceptions that happen during execution of the function will cause proper cleanup. Once the function has been released from its container this way, it is an orhpaned object until the caller claims it, so it could get lost if an exception happens.

Definition at line 720 of file c2_function.hh.

  {        
    if(func) func->release_ownership_for_return();
    func=0;
  }

Here is the caller graph for this function:

template<typename float_type>

void c2_const_ptr< float_type >::set_function ( const c2_function< float_type > *  f )

inline

Definition at line 693 of file c2_function.hh.

  { 
    if(func) func->release_ownership();
    func=f; 
    if(func) func->claim_ownership();
  }

Here is the caller graph for this function:

template<typename float_type>

void c2_const_ptr< float_type >::unset_function ( void  )

inline

clear the function

Any attempt to use this c2_plugin_function_p throws an exception if the saved function is cleared.

Definition at line 730 of file c2_function.hh.

{ this->set_function(0);  }

template<typename float_type>

bool c2_const_ptr< float_type >::valid ( ) const

inline

check if we have a valid function

Definition at line 746 of file c2_function.hh.

{ return func != 0; }

Member Data Documentation

template<typename float_type>

const c2_function<float_type>* c2_const_ptr< float_type >::func

protected

Definition at line 795 of file c2_function.hh.

---

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

• source/geant4.10.03.p03/examples/extended/electromagnetic/TestEm7/include/c2_function.hh