student_t_distribution.h 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132
  1. //===----------------------------------------------------------------------===//
  2. //
  3. // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
  4. // See https://llvm.org/LICENSE.txt for license information.
  5. // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
  6. //
  7. //===----------------------------------------------------------------------===//
  8. #ifndef _LIBCPP___RANDOM_STUDENT_T_DISTRIBUTION_H
  9. #define _LIBCPP___RANDOM_STUDENT_T_DISTRIBUTION_H
  10. #include <__config>
  11. #include <__random/gamma_distribution.h>
  12. #include <__random/is_valid.h>
  13. #include <__random/normal_distribution.h>
  14. #include <cmath>
  15. #include <iosfwd>
  16. #include <limits>
  17. #if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
  18. # pragma GCC system_header
  19. #endif
  20. _LIBCPP_PUSH_MACROS
  21. #include <__undef_macros>
  22. _LIBCPP_BEGIN_NAMESPACE_STD
  23. template <class _RealType = double>
  24. class _LIBCPP_TEMPLATE_VIS student_t_distribution {
  25. static_assert(__libcpp_random_is_valid_realtype<_RealType>::value,
  26. "RealType must be a supported floating-point type");
  27. public:
  28. // types
  29. typedef _RealType result_type;
  30. class _LIBCPP_TEMPLATE_VIS param_type {
  31. result_type __n_;
  32. public:
  33. typedef student_t_distribution distribution_type;
  34. _LIBCPP_HIDE_FROM_ABI explicit param_type(result_type __n = 1) : __n_(__n) {}
  35. _LIBCPP_HIDE_FROM_ABI result_type n() const { return __n_; }
  36. friend _LIBCPP_HIDE_FROM_ABI bool operator==(const param_type& __x, const param_type& __y) {
  37. return __x.__n_ == __y.__n_;
  38. }
  39. friend _LIBCPP_HIDE_FROM_ABI bool operator!=(const param_type& __x, const param_type& __y) { return !(__x == __y); }
  40. };
  41. private:
  42. param_type __p_;
  43. normal_distribution<result_type> __nd_;
  44. public:
  45. // constructor and reset functions
  46. #ifndef _LIBCPP_CXX03_LANG
  47. _LIBCPP_HIDE_FROM_ABI student_t_distribution() : student_t_distribution(1) {}
  48. _LIBCPP_HIDE_FROM_ABI explicit student_t_distribution(result_type __n) : __p_(param_type(__n)) {}
  49. #else
  50. _LIBCPP_HIDE_FROM_ABI explicit student_t_distribution(result_type __n = 1) : __p_(param_type(__n)) {}
  51. #endif
  52. _LIBCPP_HIDE_FROM_ABI explicit student_t_distribution(const param_type& __p) : __p_(__p) {}
  53. _LIBCPP_HIDE_FROM_ABI void reset() { __nd_.reset(); }
  54. // generating functions
  55. template <class _URNG>
  56. _LIBCPP_HIDE_FROM_ABI result_type operator()(_URNG& __g) {
  57. return (*this)(__g, __p_);
  58. }
  59. template <class _URNG>
  60. _LIBCPP_HIDE_FROM_ABI result_type operator()(_URNG& __g, const param_type& __p);
  61. // property functions
  62. _LIBCPP_HIDE_FROM_ABI result_type n() const { return __p_.n(); }
  63. _LIBCPP_HIDE_FROM_ABI param_type param() const { return __p_; }
  64. _LIBCPP_HIDE_FROM_ABI void param(const param_type& __p) { __p_ = __p; }
  65. _LIBCPP_HIDE_FROM_ABI result_type min() const { return -numeric_limits<result_type>::infinity(); }
  66. _LIBCPP_HIDE_FROM_ABI result_type max() const { return numeric_limits<result_type>::infinity(); }
  67. friend _LIBCPP_HIDE_FROM_ABI bool operator==(const student_t_distribution& __x, const student_t_distribution& __y) {
  68. return __x.__p_ == __y.__p_;
  69. }
  70. friend _LIBCPP_HIDE_FROM_ABI bool operator!=(const student_t_distribution& __x, const student_t_distribution& __y) {
  71. return !(__x == __y);
  72. }
  73. };
  74. template <class _RealType>
  75. template <class _URNG>
  76. _RealType student_t_distribution<_RealType>::operator()(_URNG& __g, const param_type& __p) {
  77. static_assert(__libcpp_random_is_valid_urng<_URNG>::value, "");
  78. gamma_distribution<result_type> __gd(__p.n() * .5, 2);
  79. return __nd_(__g) * std::sqrt(__p.n() / __gd(__g));
  80. }
  81. template <class _CharT, class _Traits, class _RT>
  82. _LIBCPP_HIDE_FROM_ABI basic_ostream<_CharT, _Traits>&
  83. operator<<(basic_ostream<_CharT, _Traits>& __os, const student_t_distribution<_RT>& __x) {
  84. __save_flags<_CharT, _Traits> __lx(__os);
  85. typedef basic_ostream<_CharT, _Traits> _OStream;
  86. __os.flags(_OStream::dec | _OStream::left | _OStream::fixed | _OStream::scientific);
  87. __os << __x.n();
  88. return __os;
  89. }
  90. template <class _CharT, class _Traits, class _RT>
  91. _LIBCPP_HIDE_FROM_ABI basic_istream<_CharT, _Traits>&
  92. operator>>(basic_istream<_CharT, _Traits>& __is, student_t_distribution<_RT>& __x) {
  93. typedef student_t_distribution<_RT> _Eng;
  94. typedef typename _Eng::result_type result_type;
  95. typedef typename _Eng::param_type param_type;
  96. __save_flags<_CharT, _Traits> __lx(__is);
  97. typedef basic_istream<_CharT, _Traits> _Istream;
  98. __is.flags(_Istream::dec | _Istream::skipws);
  99. result_type __n;
  100. __is >> __n;
  101. if (!__is.fail())
  102. __x.param(param_type(__n));
  103. return __is;
  104. }
  105. _LIBCPP_END_NAMESPACE_STD
  106. _LIBCPP_POP_MACROS
  107. #endif // _LIBCPP___RANDOM_STUDENT_T_DISTRIBUTION_H