logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

std::discrete_distribution< _IntType > - A discrete_distribution random number distribution.

Author

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

                                                    libstdc++       std::discrete_distribution<_IntType>(3cxx)

Detailed Description

template<typename_IntType=int>
       class std::discrete_distribution< _IntType >"A discrete_distribution random number distribution.

       This distribution produces random numbers $ i, 0  i < n $, distributed according to the probability mass
       function $ p(i | p_0, ..., p_{n-1}) = p_i $.

       Since
           C++11

Member Function Documentation

template<typename_IntType=int>result_typestd::discrete_distribution<_IntType>::max()const[inline]
       Returns the least upper bound value of the distribution.

       References std::vector<_Tp,_Alloc>::empty(), and std::vector<_Tp,_Alloc>::size().

   template<typename_IntType=int>result_typestd::discrete_distribution<_IntType>::min()const[inline]
       Returns the greatest lower bound value of the distribution.

   template<typename_IntType=int>template<typename_UniformRandomNumberGenerator>result_typestd::discrete_distribution<_IntType>::operator()(_UniformRandomNumberGenerator&__urng)[inline]
       Generating functions.

       References std::discrete_distribution<_IntType>::operator()().

       Referenced by std::discrete_distribution<_IntType>::operator()().

   template<typename_IntType=int>param_typestd::discrete_distribution<_IntType>::param()const[inline]

       Returns the parameter set of the distribution.

   template<typename_IntType=int>voidstd::discrete_distribution<_IntType>::param(constparam_type&__param)[inline]
       Sets the parameter set of the distribution.

       Parameters__param The new parameter set of the distribution.

   template<typename_IntType=int>std::vector<double>std::discrete_distribution<_IntType>::probabilities()const[inline]
       Returns the probabilities of the distribution.

       References std::vector<_Tp,_Alloc>::empty().

   template<typename_IntType=int>voidstd::discrete_distribution<_IntType>::reset()[inline]
       Resets the distribution state.

Member Typedef Documentation

template<typename_IntType=int>typedef_IntTypestd::discrete_distribution<_IntType>::result_type
       The type of the range of the distribution.

Name

       std::discrete_distribution< _IntType > - A discrete_distribution random number distribution.

Synopsis

       #include <random>

   Classes
       struct param_typePublicTypestypedef _IntType result_typePublicMemberFunctions
       template<typename_InputIterator > discrete_distribution (_InputIterator__wbegin, _InputIterator__wend)
       discrete_distribution (const param_type &__p)
       discrete_distribution (initializer_list< double > __wl)
       template<typename _Func > discrete_distribution (size_t __nw, double __xmin, double __xmax, _Func __fw)
       template<typename_ForwardIterator , typename_UniformRandomNumberGenerator > void__generate
           (_ForwardIterator __f, _ForwardIterator __t, _UniformRandomNumberGenerator &__urng)
       template<typename_ForwardIterator , typename_UniformRandomNumberGenerator > void__generate
           (_ForwardIterator __f, _ForwardIterator __t, _UniformRandomNumberGenerator &__urng, const param_type
           &__p)
       template<typename_UniformRandomNumberGenerator > void__generate (result_type *__f, result_type *__t,
           _UniformRandomNumberGenerator &__urng, const param_type &__p)
       result_typemax () const
           Returns the least upper bound value of the distribution.
       result_typemin () const
           Returns the greatest lower bound value of the distribution.
       template<typename_UniformRandomNumberGenerator > result_typeoperator() (_UniformRandomNumberGenerator
           &__urng)
           Generating functions.
       template<typename_UniformRandomNumberGenerator > result_typeoperator() (_UniformRandomNumberGenerator
           &__urng, const param_type &__p)
       param_typeparam () const
           Returns the parameter set of the distribution.
       voidparam (const param_type &__param)
           Sets the parameter set of the distribution.
       std::vector< double > probabilities () const
           Returns the probabilities of the distribution.
       voidreset ()
           Resets the distribution state.

   Friends
       template<typename_IntType1 , typename _CharT , typename _Traits > std::basic_ostream< _CharT, _Traits >
           & operator<< (std::basic_ostream< _CharT, _Traits > &__os, const std::discrete_distribution<
           _IntType1 > &__x)
           Inserts a discrete_distribution random number distribution __x into the output stream __os.
       bool operator== (const discrete_distribution &__d1, const discrete_distribution &__d2)
           Return true if two discrete distributions have the same parameters.
       template<typename_IntType1 , typename _CharT , typename _Traits > std::basic_istream< _CharT, _Traits >
           & operator>> (std::basic_istream< _CharT, _Traits > &__is, std::discrete_distribution< _IntType1 >
           &__x)
           Extracts a discrete_distribution random number distribution __x from the input stream __is.

See Also