Feel++  0.92.0
Classes | Public Types | Friends
Feel::ParameterSpace< P > Class Template Reference

Parameter space class. More...

#include <parameterspace.hpp>

List of all members.

Classes

class  Element
 element of a parameter space More...
class  Sampling
 Parameter space sampling class. More...

Public Types

typedef Element element_type
typedef boost::shared_ptr
< Element
element_ptrtype
typedef Sampling sampling_type
typedef boost::shared_ptr
< sampling_type
sampling_ptrtype
Typedefs
typedef ParameterSpace< Dimensionparameterspace_type
typedef boost::shared_ptr
< parameterspace_type
parameterspace_ptrtype

Public Member Functions

Constructors, destructor
 ParameterSpace ()
 default constructor
 ParameterSpace (ParameterSpace const &o)
 copy constructor
 ~ParameterSpace ()
 destructor
Operator overloads
ParameterSpaceoperator= (ParameterSpace const &o)
 copy operator
Accessors
int dimension () const
element_type const & min () const
element_type const & max () const
element_type logMiddle () const
 the log-middle point of the parameter space
element_type middle () const
 the middle point of the parameter space
Mutators
void setMin (element_type const &min)
void setMax (element_type const &max)

Static Public Member Functions

Methods
static element_type logRandom (parameterspace_ptrtype space)
 Returns a log random element of the parameter space.
static element_type random (parameterspace_ptrtype space)
 Returns a log random element of the parameter space.
static element_type logEquidistributed (double factor, parameterspace_ptrtype space)
 Returns a log equidistributed element of the parameter space.
static element_type equidistributed (double factor, parameterspace_ptrtype space)
 Returns a equidistributed element of the parameter space.

Static Public Attributes

Constants
static const uint16_type Dimension = P
 dimension of the parameter space

Friends

class boost::serialization::access

Detailed Description

template<int P>
class Feel::ParameterSpace< P >

Parameter space class.

Author:
Christophe Prud'homme
See also:

Member Function Documentation

template<int P>
int Feel::ParameterSpace< P >::dimension ( ) const [inline]
Returns:
the parameter space dimension

References Feel::ParameterSpace< P >::Dimension.

template<int P>
static element_type Feel::ParameterSpace< P >::equidistributed ( double  factor,
parameterspace_ptrtype  space 
) [inline, static]

Returns a equidistributed element of the parameter space.

Parameters:
factoris a factor in [0,1]

Referenced by Feel::ParameterSpace< P >::Sampling::equidistribute().

template<int P>
static element_type Feel::ParameterSpace< P >::logEquidistributed ( double  factor,
parameterspace_ptrtype  space 
) [inline, static]

Returns a log equidistributed element of the parameter space.

Parameters:
factoris a factor in [0,1]

Referenced by Feel::ParameterSpace< P >::Sampling::logEquidistribute().

template<int P>
element_type const& Feel::ParameterSpace< P >::max ( ) const [inline]

return the maximum element

Referenced by Feel::ParameterSpace< P >::setMax().

template<int P>
element_type const& Feel::ParameterSpace< P >::min ( ) const [inline]

return the minimum element

Referenced by Feel::ParameterSpace< P >::setMin().

template<int P>
void Feel::ParameterSpace< P >::setMax ( element_type const &  max) [inline]

set the maximum element

References Feel::ParameterSpace< P >::max().

template<int P>
void Feel::ParameterSpace< P >::setMin ( element_type const &  min) [inline]

set the minimum element

References Feel::ParameterSpace< P >::min().