Boost  v1.57.0
doxygen for www.boost.org
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
boost::random::uniform_on_sphere< RealType, Cont >::param_type Class Reference

#include <uniform_on_sphere.hpp>

Public Types

typedef uniform_on_sphere distribution_type
 

Public Member Functions

 param_type (int dim_arg=2)
 Constructs the parameters of a uniform_on_sphere distribution, given the dimension of the sphere. More...
 
int dim () const
 Returns the dimension of the sphere. More...
 
 BOOST_RANDOM_DETAIL_OSTREAM_OPERATOR (os, param_type, parm)
 Writes the parameters to a std::ostream. More...
 
 BOOST_RANDOM_DETAIL_ISTREAM_OPERATOR (is, param_type, parm)
 Reads the parameters from a std::istream. More...
 
 BOOST_RANDOM_DETAIL_EQUALITY_OPERATOR (param_type, lhs, rhs)
 Returns true if the two sets of parameters are equal. More...
 

Member Typedef Documentation

template<class RealType = double, class Cont = std::vector<RealType>>
typedef uniform_on_sphere boost::random::uniform_on_sphere< RealType, Cont >::param_type::distribution_type

Constructor & Destructor Documentation

template<class RealType = double, class Cont = std::vector<RealType>>
boost::random::uniform_on_sphere< RealType, Cont >::param_type::param_type ( int  dim_arg = 2)
inlineexplicit

Constructs the parameters of a uniform_on_sphere distribution, given the dimension of the sphere.

References BOOST_ASSERT.

Referenced by boost::random::uniform_on_sphere< RealType, Cont >::param().

Member Function Documentation

template<class RealType = double, class Cont = std::vector<RealType>>
boost::random::uniform_on_sphere< RealType, Cont >::param_type::BOOST_RANDOM_DETAIL_EQUALITY_OPERATOR ( param_type  ,
lhs  ,
rhs   
)
inline

Returns true if the two sets of parameters are equal.

template<class RealType = double, class Cont = std::vector<RealType>>
boost::random::uniform_on_sphere< RealType, Cont >::param_type::BOOST_RANDOM_DETAIL_ISTREAM_OPERATOR ( is  ,
param_type  ,
parm   
)
inline

Reads the parameters from a std::istream.

template<class RealType = double, class Cont = std::vector<RealType>>
boost::random::uniform_on_sphere< RealType, Cont >::param_type::BOOST_RANDOM_DETAIL_OSTREAM_OPERATOR ( os  ,
param_type  ,
parm   
)
inline

Writes the parameters to a std::ostream.

template<class RealType = double, class Cont = std::vector<RealType>>
int boost::random::uniform_on_sphere< RealType, Cont >::param_type::dim ( ) const
inline

Returns the dimension of the sphere.

Referenced by boost::random::uniform_on_sphere< RealType, Cont >::param().


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