Geant4  10.02.p02

create a container for a c2_function which handles the reference counting. More...

#include <c2_function.hh>

+ Inheritance diagram for c2_ptr< float_type >:
+ Collaboration diagram for c2_ptr< float_type >:

Public Member Functions

 c2_ptr ()
 construct the container with no function More...
 
 c2_ptr (c2_function< float_type > &f)
 construct the container with a pre-defined function More...
 
 c2_ptr (const c2_ptr< float_type > &src)
 copy constructor More...
 
c2_function< float_type > & get () const throw (c2_exception)
 get a checked pointer to our owned function More...
 
c2_function< float_type > * get_ptr () const
 get an unchecked pointer to our owned function More...
 
c2_function< float_type > * operator-> () const
 get a checked pointer to our owned function More...
 
const c2_ptr< float_type > & operator= (const c2_ptr< float_type > &f)
 fill the container from another container More...
 
c2_function< float_type > & operator= (c2_function< float_type > &f)
 fill the container with a function More...
 
- Public Member Functions inherited from c2_const_ptr< float_type >
 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)
 fill the container with a new function, or clear it with a null pointer More...
 
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 () throw (c2_exception)
 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 throw (c2_exception)
 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 throw (c2_exception)
 convenience operator to make us look like a function More...
 
float_type operator() (float_type x, float_type *yprime, float_type *yprime2) const throw (c2_exception)
 convenience operator to make us look like a function More...
 
c2_sum_p< float_type > & operator+ (const c2_function< float_type > &rhs) const throw (c2_exception)
 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 throw (c2_exception)
 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 throw (c2_exception)
 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 throw (c2_exception)
 factory function to create a c2_ratio_p from a regular algebraic expression. More...
 
c2_composed_function_p
< float_type > & 
operator() (const c2_function< float_type > &inner) const throw (c2_exception)
 compose this function outside another. More...
 

Private Member Functions

void operator= (const c2_const_ptr< float_type > &)
 hidden non-const-safe version of operator= More...
 
void operator= (const c2_function< float_type > &)
 hidden non-const-safe version of operator= More...
 

Additional Inherited Members

- Protected Attributes inherited from c2_const_ptr< float_type >
const c2_function< float_type > * func
 

Detailed Description

template<typename float_type>
class c2_ptr< float_type >

create a container for a c2_function which handles the reference counting.

See also
c2_const_ptr and Use of c2_ptr for memory management

Definition at line 86 of file c2_function.hh.

Constructor & Destructor Documentation

template<typename float_type>
c2_ptr< float_type >::c2_ptr ( )
inline

construct the container with no function

Definition at line 685 of file c2_function.hh.

template<typename float_type>
c2_ptr< float_type >::c2_ptr ( c2_function< float_type > &  f)
inline

construct the container with a pre-defined function

Parameters
fthe function to store

Definition at line 688 of file c2_function.hh.

template<typename float_type>
c2_ptr< float_type >::c2_ptr ( const c2_ptr< float_type > &  src)
inline

copy constructor

Parameters
srcthe container to copy

Definition at line 692 of file c2_function.hh.

Member Function Documentation

template<typename float_type>
c2_function<float_type>& c2_ptr< float_type >::get ( ) const
throw (c2_exception
)
inline

get a checked pointer to our owned function

Definition at line 695 of file c2_function.hh.

template<typename float_type>
c2_function<float_type>* c2_ptr< float_type >::get_ptr ( ) const
inline

get an unchecked pointer to our owned function

Definition at line 698 of file c2_function.hh.

Referenced by c2_ptr< G4double >::c2_ptr(), and c2_ptr< G4double >::operator=().

+ Here is the caller graph for this function:

template<typename float_type>
c2_function<float_type>* c2_ptr< float_type >::operator-> ( ) const
inline

get a checked pointer to our owned function

Definition at line 701 of file c2_function.hh.

template<typename float_type>
const c2_ptr<float_type>& c2_ptr< float_type >::operator= ( const c2_ptr< float_type > &  f)
inline

fill the container from another container

Parameters
fthe container to copy

Definition at line 705 of file c2_function.hh.

template<typename float_type>
c2_function<float_type>& c2_ptr< float_type >::operator= ( c2_function< float_type > &  f)
inline

fill the container with a function

Parameters
fthe function

Definition at line 709 of file c2_function.hh.

template<typename float_type>
void c2_ptr< float_type >::operator= ( const c2_const_ptr< float_type > &  )
inlineprivate

hidden non-const-safe version of operator=

Definition at line 713 of file c2_function.hh.

template<typename float_type>
void c2_ptr< float_type >::operator= ( const c2_function< float_type > &  )
inlineprivate

hidden non-const-safe version of operator=

Definition at line 715 of file c2_function.hh.


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