trusty (3) std::normal_distribution.3cxx.gz

Provided by: libstdc++6-4.4-doc_4.4.7-8ubuntu1_all bug

NAME

       std::normal_distribution< _RealType > -

SYNOPSIS

   Public Types
       typedef _RealType input_type
       typedef _RealType result_type

   Public Member Functions
       _RealType mean () const
       normal_distribution (const result_type &__mean=result_type(0), const result_type &__sigma=result_type(1))
       template<class _UniformRandomNumberGenerator > normal_distribution< _RealType >
           ::result_type operator() (_UniformRandomNumberGenerator &__urng)"
       template<class _UniformRandomNumberGenerator > result_type operator() (_UniformRandomNumberGenerator
           &__urng)
       void reset ()
       _RealType sigma () const

   Friends
       template<typename _RealType1 , typename _CharT , typename _Traits > std::basic_ostream< _CharT,
           _Traits > & operator<< (std::basic_ostream< _CharT, _Traits > &__os, const normal_distribution<
           _RealType1 > &__x)"
       template<typename _RealType1 , typename _CharT , typename _Traits > std::basic_istream< _CharT,
           _Traits > & operator>> (std::basic_istream< _CharT, _Traits > &__is, normal_distribution< _RealType1
           > &__x)"

Detailed Description

   template<typename _RealType>class std::normal_distribution< _RealType >
       A normal continuous distribution for random numbers.

       The formula for the normal probability mass function is $ p(x) = ac{1}{ma t{2 i}}
       e^{- ac{{x - mean}^ {2}}{2 ma ^ {2}} } $.

       Definition at line 1854 of file tr1_impl/random.

Constructor & Destructor Documentation

   template<typename _RealType> std::normal_distribution< _RealType >::normal_distribution (const result_type
       &__mean = result_type(0), const result_type &__sigma = result_type(1)) [inline],  [explicit]
       Constructs a normal distribution with parameters $ mean $ and $ ma $.

       Definition at line 2244 of file tr1_impl/random.

Member Function Documentation

   template<typename _RealType> _RealType std::normal_distribution< _RealType >::mean () const [inline]
       Gets the mean of the distribution.

       Definition at line 2255 of file tr1_impl/random.

   template<typename _RealType> template<class _UniformRandomNumberGenerator >
       normal_distribution<_RealType>::result_type std::normal_distribution< _RealType >::operator()
       (_UniformRandomNumberGenerator &__urng)
       Polar method due to Marsaglia.

       Devroye, L. 'Non-Uniform Random Variates Generation.' Springer-Verlag, New York, 1986, Ch. V, Sect. 4.4.

       Definition at line 1390 of file random.tcc.

       References std::log(), and std::sqrt().

   template<typename _RealType> void std::normal_distribution< _RealType >::reset () [inline]
       Resets the distribution.

       Definition at line 2269 of file tr1_impl/random.

   template<typename _RealType> _RealType std::normal_distribution< _RealType >::sigma () const [inline]
       Gets the $ ma $ of the distribution.

       Definition at line 2262 of file tr1_impl/random.

   template<typename _RealType> template<typename _RealType1 , typename _CharT , typename _Traits >
       std::basic_ostream<_CharT, _Traits>& operator<< (std::basic_ostream< _CharT, _Traits > &__os, const
       normal_distribution< _RealType1 > &__x) [friend]
       Inserts a normal_distribution random number distribution __x into the output stream __os.

       Parameters:
           __os An output stream.
           __x A normal_distribution random number distribution.

       Returns:
           The output stream with the state of __x inserted or in an error state.

   template<typename _RealType> template<typename _RealType1 , typename _CharT , typename _Traits >
       std::basic_istream<_CharT, _Traits>& operator>> (std::basic_istream< _CharT, _Traits > &__is,
       normal_distribution< _RealType1 > &__x) [friend]
       Extracts a normal_distribution random number distribution __x from the input stream __is.

       Parameters:
           __is An input stream.
           __x A normal_distribution random number generator engine.

       Returns:
           The input stream with __x extracted or in an error state.

Author

       Generated automatically by Doxygen for libstdc++ from the source code.