xref: /freebsd-src/contrib/llvm-project/libcxx/include/__random/uniform_real_distribution.h (revision cb14a3fe5122c879eae1fb480ed7ce82a699ddb6)
14824e7fdSDimitry Andric //===----------------------------------------------------------------------===//
24824e7fdSDimitry Andric //
34824e7fdSDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
44824e7fdSDimitry Andric // See https://llvm.org/LICENSE.txt for license information.
54824e7fdSDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
64824e7fdSDimitry Andric //
74824e7fdSDimitry Andric //===----------------------------------------------------------------------===//
84824e7fdSDimitry Andric 
94824e7fdSDimitry Andric #ifndef _LIBCPP___RANDOM_UNIFORM_REAL_DISTRIBUTION_H
104824e7fdSDimitry Andric #define _LIBCPP___RANDOM_UNIFORM_REAL_DISTRIBUTION_H
114824e7fdSDimitry Andric 
124824e7fdSDimitry Andric #include <__config>
134824e7fdSDimitry Andric #include <__random/generate_canonical.h>
1481ad6265SDimitry Andric #include <__random/is_valid.h>
154824e7fdSDimitry Andric #include <iosfwd>
164824e7fdSDimitry Andric #include <limits>
174824e7fdSDimitry Andric 
184824e7fdSDimitry Andric #if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
194824e7fdSDimitry Andric #  pragma GCC system_header
204824e7fdSDimitry Andric #endif
214824e7fdSDimitry Andric 
224824e7fdSDimitry Andric _LIBCPP_PUSH_MACROS
234824e7fdSDimitry Andric #include <__undef_macros>
244824e7fdSDimitry Andric 
254824e7fdSDimitry Andric _LIBCPP_BEGIN_NAMESPACE_STD
264824e7fdSDimitry Andric 
274824e7fdSDimitry Andric template <class _RealType = double>
28*cb14a3feSDimitry Andric class _LIBCPP_TEMPLATE_VIS uniform_real_distribution {
295f757f3fSDimitry Andric   static_assert(__libcpp_random_is_valid_realtype<_RealType>::value,
305f757f3fSDimitry Andric                 "RealType must be a supported floating-point type");
315f757f3fSDimitry Andric 
324824e7fdSDimitry Andric public:
334824e7fdSDimitry Andric   // types
344824e7fdSDimitry Andric   typedef _RealType result_type;
354824e7fdSDimitry Andric 
36*cb14a3feSDimitry Andric   class _LIBCPP_TEMPLATE_VIS param_type {
374824e7fdSDimitry Andric     result_type __a_;
384824e7fdSDimitry Andric     result_type __b_;
39*cb14a3feSDimitry Andric 
404824e7fdSDimitry Andric   public:
414824e7fdSDimitry Andric     typedef uniform_real_distribution distribution_type;
424824e7fdSDimitry Andric 
__a_(__a)43*cb14a3feSDimitry Andric     _LIBCPP_HIDE_FROM_ABI explicit param_type(result_type __a = 0, result_type __b = 1) : __a_(__a), __b_(__b) {}
444824e7fdSDimitry Andric 
a()45*cb14a3feSDimitry Andric     _LIBCPP_HIDE_FROM_ABI result_type a() const { return __a_; }
b()46*cb14a3feSDimitry Andric     _LIBCPP_HIDE_FROM_ABI result_type b() const { return __b_; }
474824e7fdSDimitry Andric 
48*cb14a3feSDimitry Andric     friend _LIBCPP_HIDE_FROM_ABI bool operator==(const param_type& __x, const param_type& __y) {
49*cb14a3feSDimitry Andric       return __x.__a_ == __y.__a_ && __x.__b_ == __y.__b_;
50*cb14a3feSDimitry Andric     }
51*cb14a3feSDimitry Andric     friend _LIBCPP_HIDE_FROM_ABI bool operator!=(const param_type& __x, const param_type& __y) { return !(__x == __y); }
524824e7fdSDimitry Andric   };
534824e7fdSDimitry Andric 
544824e7fdSDimitry Andric private:
554824e7fdSDimitry Andric   param_type __p_;
564824e7fdSDimitry Andric 
574824e7fdSDimitry Andric public:
584824e7fdSDimitry Andric   // constructors and reset functions
594824e7fdSDimitry Andric #ifndef _LIBCPP_CXX03_LANG
uniform_real_distribution()60*cb14a3feSDimitry Andric   _LIBCPP_HIDE_FROM_ABI uniform_real_distribution() : uniform_real_distribution(0) {}
6106c3fb27SDimitry Andric   _LIBCPP_HIDE_FROM_ABI explicit uniform_real_distribution(result_type __a, result_type __b = 1)
__p_(param_type (__a,__b))624824e7fdSDimitry Andric       : __p_(param_type(__a, __b)) {}
634824e7fdSDimitry Andric #else
64*cb14a3feSDimitry Andric   _LIBCPP_HIDE_FROM_ABI explicit uniform_real_distribution(result_type __a = 0, result_type __b = 1)
654824e7fdSDimitry Andric       : __p_(param_type(__a, __b)) {}
664824e7fdSDimitry Andric #endif
uniform_real_distribution(const param_type & __p)67*cb14a3feSDimitry Andric   _LIBCPP_HIDE_FROM_ABI explicit uniform_real_distribution(const param_type& __p) : __p_(__p) {}
reset()68*cb14a3feSDimitry Andric   _LIBCPP_HIDE_FROM_ABI void reset() {}
694824e7fdSDimitry Andric 
704824e7fdSDimitry Andric   // generating functions
714824e7fdSDimitry Andric   template <class _URNG>
operator()72*cb14a3feSDimitry Andric   _LIBCPP_HIDE_FROM_ABI result_type operator()(_URNG& __g) {
73*cb14a3feSDimitry Andric     return (*this)(__g, __p_);
74*cb14a3feSDimitry Andric   }
75*cb14a3feSDimitry Andric   template <class _URNG>
76*cb14a3feSDimitry Andric   _LIBCPP_HIDE_FROM_ABI result_type operator()(_URNG& __g, const param_type& __p);
774824e7fdSDimitry Andric 
784824e7fdSDimitry Andric   // property functions
a()79*cb14a3feSDimitry Andric   _LIBCPP_HIDE_FROM_ABI result_type a() const { return __p_.a(); }
b()80*cb14a3feSDimitry Andric   _LIBCPP_HIDE_FROM_ABI result_type b() const { return __p_.b(); }
814824e7fdSDimitry Andric 
param()82*cb14a3feSDimitry Andric   _LIBCPP_HIDE_FROM_ABI param_type param() const { return __p_; }
param(const param_type & __p)83*cb14a3feSDimitry Andric   _LIBCPP_HIDE_FROM_ABI void param(const param_type& __p) { __p_ = __p; }
844824e7fdSDimitry Andric 
min()85*cb14a3feSDimitry Andric   _LIBCPP_HIDE_FROM_ABI result_type min() const { return a(); }
max()86*cb14a3feSDimitry Andric   _LIBCPP_HIDE_FROM_ABI result_type max() const { return b(); }
874824e7fdSDimitry Andric 
88*cb14a3feSDimitry Andric   friend _LIBCPP_HIDE_FROM_ABI bool
89*cb14a3feSDimitry Andric   operator==(const uniform_real_distribution& __x, const uniform_real_distribution& __y) {
90*cb14a3feSDimitry Andric     return __x.__p_ == __y.__p_;
91*cb14a3feSDimitry Andric   }
92*cb14a3feSDimitry Andric   friend _LIBCPP_HIDE_FROM_ABI bool
93*cb14a3feSDimitry Andric   operator!=(const uniform_real_distribution& __x, const uniform_real_distribution& __y) {
94*cb14a3feSDimitry Andric     return !(__x == __y);
95*cb14a3feSDimitry Andric   }
964824e7fdSDimitry Andric };
974824e7fdSDimitry Andric 
984824e7fdSDimitry Andric template <class _RealType>
994824e7fdSDimitry Andric template <class _URNG>
100*cb14a3feSDimitry Andric inline typename uniform_real_distribution<_RealType>::result_type
operator()101*cb14a3feSDimitry Andric uniform_real_distribution<_RealType>::operator()(_URNG& __g, const param_type& __p) {
10281ad6265SDimitry Andric   static_assert(__libcpp_random_is_valid_urng<_URNG>::value, "");
103*cb14a3feSDimitry Andric   return (__p.b() - __p.a()) * std::generate_canonical<_RealType, numeric_limits<_RealType>::digits>(__g) + __p.a();
1044824e7fdSDimitry Andric }
1054824e7fdSDimitry Andric 
1064824e7fdSDimitry Andric template <class _CharT, class _Traits, class _RT>
107bdd1243dSDimitry Andric _LIBCPP_HIDE_FROM_ABI basic_ostream<_CharT, _Traits>&
108*cb14a3feSDimitry Andric operator<<(basic_ostream<_CharT, _Traits>& __os, const uniform_real_distribution<_RT>& __x) {
1094824e7fdSDimitry Andric   __save_flags<_CharT, _Traits> __lx(__os);
1104824e7fdSDimitry Andric   typedef basic_ostream<_CharT, _Traits> _OStream;
111*cb14a3feSDimitry Andric   __os.flags(_OStream::dec | _OStream::left | _OStream::fixed | _OStream::scientific);
1124824e7fdSDimitry Andric   _CharT __sp = __os.widen(' ');
1134824e7fdSDimitry Andric   __os.fill(__sp);
1144824e7fdSDimitry Andric   return __os << __x.a() << __sp << __x.b();
1154824e7fdSDimitry Andric }
1164824e7fdSDimitry Andric 
1174824e7fdSDimitry Andric template <class _CharT, class _Traits, class _RT>
118bdd1243dSDimitry Andric _LIBCPP_HIDE_FROM_ABI basic_istream<_CharT, _Traits>&
119*cb14a3feSDimitry Andric operator>>(basic_istream<_CharT, _Traits>& __is, uniform_real_distribution<_RT>& __x) {
1204824e7fdSDimitry Andric   typedef uniform_real_distribution<_RT> _Eng;
1214824e7fdSDimitry Andric   typedef typename _Eng::result_type result_type;
1224824e7fdSDimitry Andric   typedef typename _Eng::param_type param_type;
1234824e7fdSDimitry Andric   __save_flags<_CharT, _Traits> __lx(__is);
1244824e7fdSDimitry Andric   typedef basic_istream<_CharT, _Traits> _Istream;
1254824e7fdSDimitry Andric   __is.flags(_Istream::dec | _Istream::skipws);
1264824e7fdSDimitry Andric   result_type __a;
1274824e7fdSDimitry Andric   result_type __b;
1284824e7fdSDimitry Andric   __is >> __a >> __b;
1294824e7fdSDimitry Andric   if (!__is.fail())
1304824e7fdSDimitry Andric     __x.param(param_type(__a, __b));
1314824e7fdSDimitry Andric   return __is;
1324824e7fdSDimitry Andric }
1334824e7fdSDimitry Andric 
1344824e7fdSDimitry Andric _LIBCPP_END_NAMESPACE_STD
1354824e7fdSDimitry Andric 
1364824e7fdSDimitry Andric _LIBCPP_POP_MACROS
1374824e7fdSDimitry Andric 
1384824e7fdSDimitry Andric #endif // _LIBCPP___RANDOM_UNIFORM_REAL_DISTRIBUTION_H
139