concepts::RCP< const Formula< F > > Class Template Reference

#include <elementFormulaRCP_boost.hh>

Inheritance diagram for concepts::RCP< const Formula< F > >:

Public Member Functions

RCP< const Formula< F > > & operator= (const RCP< const Formula< F > > &x)
 
RCP< const Formula< F > > & operator= (const RCP< const Formula< F > > &x)
 
template<class H >
RCP< const Formula< F > > & operator= (const RCP< H > &x)
 
template<class H >
RCP< const Formula< F > > & operator= (const RCP< H > &x)
 
 RCP ()
 Default constructor. More...
 
 RCP ()
 Default constructor. More...
 
 RCP (boost::shared_ptr< const Formula< F > > &x)
 
template<class H >
 RCP (const boost::shared_ptr< H > &x)
 
 RCP (const F x)
 Special constructor for a constant. More...
 
 RCP (const F x)
 Special constructor for a constant. More...
 
 RCP (const Formula< F > &x)
 Constructor with a given reference, ElementFormula will be cloned. More...
 
 RCP (const Formula< F > &x)
 Constructor with a given reference, ElementFormula will be cloned. More...
 
 RCP (const Formula< F > *x)
 Constructor for a simple pointer to ElementFormula, which will be deleted by the RCP. More...
 
 RCP (const Formula< F > *x)
 Constructor for a simple pointer to ElementFormula, which will be deleted by the RCP. More...
 
template<class H >
 RCP (const std::shared_ptr< H > &x)
 
template<class H , class I >
 RCP (H x, I y)
 Constructor with any two parameters. More...
 
template<class H , class I >
 RCP (H x, I y)
 Constructor with any two parameters. More...
 
 RCP (std::shared_ptr< const Formula< F > > &x)
 

Detailed Description

template<class F>
class concepts::RCP< const Formula< F > >

Definition at line 132 of file elementFormulaRCP_boost.hh.

Constructor & Destructor Documentation

◆ RCP() [1/14]

template<class F >
concepts::RCP< const Formula< F > >::RCP ( const F  x)
inlineexplicit

Special constructor for a constant.

So, a constant can simply given to functions where a RCP<ElementFormula<F> > is expected.

See also
testsuite/testFormula.cc

Definition at line 142 of file elementFormulaRCP_boost.hh.

◆ RCP() [2/14]

template<class F >
concepts::RCP< const Formula< F > >::RCP ( )
inline

Default constructor.

Definition at line 146 of file elementFormulaRCP_boost.hh.

◆ RCP() [3/14]

template<class F >
concepts::RCP< const Formula< F > >::RCP ( const Formula< F > *  x)
inlineexplicit

Constructor for a simple pointer to ElementFormula, which will be deleted by the RCP.

It should be only called with pointer to dynamic variables, e.g.

RCP<const ElementFormula<Real> > p(new ConstFormula<Real>(4));

Do NOT use it with pointers to variables in the stack. Do not

ConstFormula<Real> i = 4; 
RCP<const ElementFormula<Real> > p(&i); // <-- DO NOT -- 

Instead use the constructor for references (below) which makes a clone.

Definition at line 160 of file elementFormulaRCP_boost.hh.

◆ RCP() [4/14]

template<class F >
concepts::RCP< const Formula< F > >::RCP ( boost::shared_ptr< const Formula< F > > &  x)
inline

Definition at line 163 of file elementFormulaRCP_boost.hh.

◆ RCP() [5/14]

template<class F >
template<class H >
concepts::RCP< const Formula< F > >::RCP ( const boost::shared_ptr< H > &  x)
inline

Definition at line 167 of file elementFormulaRCP_boost.hh.

◆ RCP() [6/14]

template<class F >
template<class H , class I >
concepts::RCP< const Formula< F > >::RCP ( x,
y 
)
inline

Constructor with any two parameters.

Definition at line 172 of file elementFormulaRCP_boost.hh.

◆ RCP() [7/14]

template<class F >
concepts::RCP< const Formula< F > >::RCP ( const Formula< F > &  x)
inlineexplicit

Constructor with a given reference, ElementFormula will be cloned.

@BEWARE: this function is slightly inefficient (a copy is created), @obsolete: try to write code which does NOT depend on this function,

Definition at line 186 of file elementFormulaRCP_boost.hh.

◆ RCP() [8/14]

template<class F >
concepts::RCP< const Formula< F > >::RCP ( const F  x)
inlineexplicit

Special constructor for a constant.

So, a constant can simply given to functions where a RCP<ElementFormula<F> > is expected.

See also
testsuite/testFormula.cc

Definition at line 142 of file elementFormulaRCP_std.hh.

◆ RCP() [9/14]

template<class F >
concepts::RCP< const Formula< F > >::RCP ( )
inline

Default constructor.

Definition at line 146 of file elementFormulaRCP_std.hh.

◆ RCP() [10/14]

template<class F >
concepts::RCP< const Formula< F > >::RCP ( const Formula< F > *  x)
inlineexplicit

Constructor for a simple pointer to ElementFormula, which will be deleted by the RCP.

It should be only called with pointer to dynamic variables, e.g.

RCP<const ElementFormula<Real> > p(new ConstFormula<Real>(4));

Do NOT use it with pointers to variables in the stack. Do not

ConstFormula<Real> i = 4; 
RCP<const ElementFormula<Real> > p(&i); // <-- DO NOT -- 

Instead use the constructor for references (below) which makes a clone.

Definition at line 160 of file elementFormulaRCP_std.hh.

◆ RCP() [11/14]

template<class F >
concepts::RCP< const Formula< F > >::RCP ( std::shared_ptr< const Formula< F > > &  x)
inline

Definition at line 163 of file elementFormulaRCP_std.hh.

◆ RCP() [12/14]

template<class F >
template<class H >
concepts::RCP< const Formula< F > >::RCP ( const std::shared_ptr< H > &  x)
inline

Definition at line 167 of file elementFormulaRCP_std.hh.

◆ RCP() [13/14]

template<class F >
template<class H , class I >
concepts::RCP< const Formula< F > >::RCP ( x,
y 
)
inline

Constructor with any two parameters.

Definition at line 172 of file elementFormulaRCP_std.hh.

◆ RCP() [14/14]

template<class F >
concepts::RCP< const Formula< F > >::RCP ( const Formula< F > &  x)
inlineexplicit

Constructor with a given reference, ElementFormula will be cloned.

@BEWARE: this function is slightly inefficient (a copy is created), @obsolete: try to write code which does NOT depend on this function,

Definition at line 186 of file elementFormulaRCP_std.hh.

Member Function Documentation

◆ operator=() [1/4]

template<class F >
RCP<const Formula<F> >& concepts::RCP< const Formula< F > >::operator= ( const RCP< const Formula< F > > &  x)
inline

Definition at line 192 of file elementFormulaRCP_boost.hh.

◆ operator=() [2/4]

template<class F >
RCP<const Formula<F> >& concepts::RCP< const Formula< F > >::operator= ( const RCP< const Formula< F > > &  x)
inline

Definition at line 192 of file elementFormulaRCP_std.hh.

◆ operator=() [3/4]

template<class F >
template<class H >
RCP<const Formula<F> >& concepts::RCP< const Formula< F > >::operator= ( const RCP< H > &  x)
inline

Definition at line 200 of file elementFormulaRCP_boost.hh.

◆ operator=() [4/4]

template<class F >
template<class H >
RCP<const Formula<F> >& concepts::RCP< const Formula< F > >::operator= ( const RCP< H > &  x)
inline

Definition at line 200 of file elementFormulaRCP_std.hh.


The documentation for this class was generated from the following files:
Page URL: http://wiki.math.ethz.ch/bin/view/Concepts/WebHome
21 August 2020
© 2020 Eidgenössische Technische Hochschule Zürich