You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414
  1. // random number generation -*- C++ -*-
  2. // Copyright (C) 2009-2020 Free Software Foundation, Inc.
  3. //
  4. // This file is part of the GNU ISO C++ Library. This library is free
  5. // software; you can redistribute it and/or modify it under the
  6. // terms of the GNU General Public License as published by the
  7. // Free Software Foundation; either version 3, or (at your option)
  8. // any later version.
  9. // This library is distributed in the hope that it will be useful,
  10. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  12. // GNU General Public License for more details.
  13. // Under Section 7 of GPL version 3, you are granted additional
  14. // permissions described in the GCC Runtime Library Exception, version
  15. // 3.1, as published by the Free Software Foundation.
  16. // You should have received a copy of the GNU General Public License and
  17. // a copy of the GCC Runtime Library Exception along with this program;
  18. // see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
  19. // <http://www.gnu.org/licenses/>.
  20. /**
  21. * @file tr1/random.h
  22. * This is an internal header file, included by other library headers.
  23. * Do not attempt to use it directly. @headername{tr1/random}
  24. */
  25. #ifndef _GLIBCXX_TR1_RANDOM_H
  26. #define _GLIBCXX_TR1_RANDOM_H 1
  27. #pragma GCC system_header
  28. namespace std _GLIBCXX_VISIBILITY(default)
  29. {
  30. _GLIBCXX_BEGIN_NAMESPACE_VERSION
  31. namespace tr1
  32. {
  33. // [5.1] Random number generation
  34. /**
  35. * @addtogroup tr1_random Random Number Generation
  36. * A facility for generating random numbers on selected distributions.
  37. * @{
  38. */
  39. /*
  40. * Implementation-space details.
  41. */
  42. namespace __detail
  43. {
  44. template<typename _UIntType, int __w,
  45. bool = __w < std::numeric_limits<_UIntType>::digits>
  46. struct _Shift
  47. { static const _UIntType __value = 0; };
  48. template<typename _UIntType, int __w>
  49. struct _Shift<_UIntType, __w, true>
  50. { static const _UIntType __value = _UIntType(1) << __w; };
  51. template<typename _Tp, _Tp __a, _Tp __c, _Tp __m, bool>
  52. struct _Mod;
  53. // Dispatch based on modulus value to prevent divide-by-zero compile-time
  54. // errors when m == 0.
  55. template<typename _Tp, _Tp __a, _Tp __c, _Tp __m>
  56. inline _Tp
  57. __mod(_Tp __x)
  58. { return _Mod<_Tp, __a, __c, __m, __m == 0>::__calc(__x); }
  59. typedef __gnu_cxx::__conditional_type<(sizeof(unsigned) == 4),
  60. unsigned, unsigned long>::__type _UInt32Type;
  61. /*
  62. * An adaptor class for converting the output of any Generator into
  63. * the input for a specific Distribution.
  64. */
  65. template<typename _Engine, typename _Distribution>
  66. struct _Adaptor
  67. {
  68. typedef typename remove_reference<_Engine>::type _BEngine;
  69. typedef typename _BEngine::result_type _Engine_result_type;
  70. typedef typename _Distribution::input_type result_type;
  71. public:
  72. _Adaptor(const _Engine& __g)
  73. : _M_g(__g) { }
  74. result_type
  75. min() const
  76. {
  77. result_type __return_value;
  78. if (is_integral<_Engine_result_type>::value
  79. && is_integral<result_type>::value)
  80. __return_value = _M_g.min();
  81. else
  82. __return_value = result_type(0);
  83. return __return_value;
  84. }
  85. result_type
  86. max() const
  87. {
  88. result_type __return_value;
  89. if (is_integral<_Engine_result_type>::value
  90. && is_integral<result_type>::value)
  91. __return_value = _M_g.max();
  92. else if (!is_integral<result_type>::value)
  93. __return_value = result_type(1);
  94. else
  95. __return_value = std::numeric_limits<result_type>::max() - 1;
  96. return __return_value;
  97. }
  98. /*
  99. * Converts a value generated by the adapted random number generator
  100. * into a value in the input domain for the dependent random number
  101. * distribution.
  102. *
  103. * Because the type traits are compile time constants only the
  104. * appropriate clause of the if statements will actually be emitted
  105. * by the compiler.
  106. */
  107. result_type
  108. operator()()
  109. {
  110. result_type __return_value;
  111. if (is_integral<_Engine_result_type>::value
  112. && is_integral<result_type>::value)
  113. __return_value = _M_g();
  114. else if (!is_integral<_Engine_result_type>::value
  115. && !is_integral<result_type>::value)
  116. __return_value = result_type(_M_g() - _M_g.min())
  117. / result_type(_M_g.max() - _M_g.min());
  118. else if (is_integral<_Engine_result_type>::value
  119. && !is_integral<result_type>::value)
  120. __return_value = result_type(_M_g() - _M_g.min())
  121. / result_type(_M_g.max() - _M_g.min() + result_type(1));
  122. else
  123. __return_value = (((_M_g() - _M_g.min())
  124. / (_M_g.max() - _M_g.min()))
  125. * std::numeric_limits<result_type>::max());
  126. return __return_value;
  127. }
  128. private:
  129. _Engine _M_g;
  130. };
  131. // Specialization for _Engine*.
  132. template<typename _Engine, typename _Distribution>
  133. struct _Adaptor<_Engine*, _Distribution>
  134. {
  135. typedef typename _Engine::result_type _Engine_result_type;
  136. typedef typename _Distribution::input_type result_type;
  137. public:
  138. _Adaptor(_Engine* __g)
  139. : _M_g(__g) { }
  140. result_type
  141. min() const
  142. {
  143. result_type __return_value;
  144. if (is_integral<_Engine_result_type>::value
  145. && is_integral<result_type>::value)
  146. __return_value = _M_g->min();
  147. else
  148. __return_value = result_type(0);
  149. return __return_value;
  150. }
  151. result_type
  152. max() const
  153. {
  154. result_type __return_value;
  155. if (is_integral<_Engine_result_type>::value
  156. && is_integral<result_type>::value)
  157. __return_value = _M_g->max();
  158. else if (!is_integral<result_type>::value)
  159. __return_value = result_type(1);
  160. else
  161. __return_value = std::numeric_limits<result_type>::max() - 1;
  162. return __return_value;
  163. }
  164. result_type
  165. operator()()
  166. {
  167. result_type __return_value;
  168. if (is_integral<_Engine_result_type>::value
  169. && is_integral<result_type>::value)
  170. __return_value = (*_M_g)();
  171. else if (!is_integral<_Engine_result_type>::value
  172. && !is_integral<result_type>::value)
  173. __return_value = result_type((*_M_g)() - _M_g->min())
  174. / result_type(_M_g->max() - _M_g->min());
  175. else if (is_integral<_Engine_result_type>::value
  176. && !is_integral<result_type>::value)
  177. __return_value = result_type((*_M_g)() - _M_g->min())
  178. / result_type(_M_g->max() - _M_g->min() + result_type(1));
  179. else
  180. __return_value = ((((*_M_g)() - _M_g->min())
  181. / (_M_g->max() - _M_g->min()))
  182. * std::numeric_limits<result_type>::max());
  183. return __return_value;
  184. }
  185. private:
  186. _Engine* _M_g;
  187. };
  188. } // namespace __detail
  189. /**
  190. * Produces random numbers on a given distribution function using a
  191. * non-uniform random number generation engine.
  192. *
  193. * @todo the engine_value_type needs to be studied more carefully.
  194. */
  195. template<typename _Engine, typename _Dist>
  196. class variate_generator
  197. {
  198. // Concept requirements.
  199. __glibcxx_class_requires(_Engine, _CopyConstructibleConcept)
  200. // __glibcxx_class_requires(_Engine, _EngineConcept)
  201. // __glibcxx_class_requires(_Dist, _EngineConcept)
  202. public:
  203. typedef _Engine engine_type;
  204. typedef __detail::_Adaptor<_Engine, _Dist> engine_value_type;
  205. typedef _Dist distribution_type;
  206. typedef typename _Dist::result_type result_type;
  207. // tr1:5.1.1 table 5.1 requirement
  208. typedef typename __gnu_cxx::__enable_if<
  209. is_arithmetic<result_type>::value, result_type>::__type _IsValidType;
  210. /**
  211. * Constructs a variate generator with the uniform random number
  212. * generator @p __eng for the random distribution @p __dist.
  213. *
  214. * @throws Any exceptions which may thrown by the copy constructors of
  215. * the @p _Engine or @p _Dist objects.
  216. */
  217. variate_generator(engine_type __eng, distribution_type __dist)
  218. : _M_engine(__eng), _M_dist(__dist) { }
  219. /**
  220. * Gets the next generated value on the distribution.
  221. */
  222. result_type
  223. operator()()
  224. { return _M_dist(_M_engine); }
  225. /**
  226. * WTF?
  227. */
  228. template<typename _Tp>
  229. result_type
  230. operator()(_Tp __value)
  231. { return _M_dist(_M_engine, __value); }
  232. /**
  233. * Gets a reference to the underlying uniform random number generator
  234. * object.
  235. */
  236. engine_value_type&
  237. engine()
  238. { return _M_engine; }
  239. /**
  240. * Gets a const reference to the underlying uniform random number
  241. * generator object.
  242. */
  243. const engine_value_type&
  244. engine() const
  245. { return _M_engine; }
  246. /**
  247. * Gets a reference to the underlying random distribution.
  248. */
  249. distribution_type&
  250. distribution()
  251. { return _M_dist; }
  252. /**
  253. * Gets a const reference to the underlying random distribution.
  254. */
  255. const distribution_type&
  256. distribution() const
  257. { return _M_dist; }
  258. /**
  259. * Gets the closed lower bound of the distribution interval.
  260. */
  261. result_type
  262. min() const
  263. { return this->distribution().min(); }
  264. /**
  265. * Gets the closed upper bound of the distribution interval.
  266. */
  267. result_type
  268. max() const
  269. { return this->distribution().max(); }
  270. private:
  271. engine_value_type _M_engine;
  272. distribution_type _M_dist;
  273. };
  274. /**
  275. * @addtogroup tr1_random_generators Random Number Generators
  276. * @ingroup tr1_random
  277. *
  278. * These classes define objects which provide random or pseudorandom
  279. * numbers, either from a discrete or a continuous interval. The
  280. * random number generator supplied as a part of this library are
  281. * all uniform random number generators which provide a sequence of
  282. * random number uniformly distributed over their range.
  283. *
  284. * A number generator is a function object with an operator() that
  285. * takes zero arguments and returns a number.
  286. *
  287. * A compliant random number generator must satisfy the following
  288. * requirements. <table border=1 cellpadding=10 cellspacing=0>
  289. * <caption align=top>Random Number Generator Requirements</caption>
  290. * <tr><td>To be documented.</td></tr> </table>
  291. *
  292. * @{
  293. */
  294. /**
  295. * @brief A model of a linear congruential random number generator.
  296. *
  297. * A random number generator that produces pseudorandom numbers using the
  298. * linear function @f$x_{i+1}\leftarrow(ax_{i} + c) \bmod m @f$.
  299. *
  300. * The template parameter @p _UIntType must be an unsigned integral type
  301. * large enough to store values up to (__m-1). If the template parameter
  302. * @p __m is 0, the modulus @p __m used is
  303. * std::numeric_limits<_UIntType>::max() plus 1. Otherwise, the template
  304. * parameters @p __a and @p __c must be less than @p __m.
  305. *
  306. * The size of the state is @f$ 1 @f$.
  307. */
  308. template<class _UIntType, _UIntType __a, _UIntType __c, _UIntType __m>
  309. class linear_congruential
  310. {
  311. __glibcxx_class_requires(_UIntType, _UnsignedIntegerConcept)
  312. // __glibcpp_class_requires(__a < __m && __c < __m)
  313. public:
  314. /** The type of the generated random value. */
  315. typedef _UIntType result_type;
  316. /** The multiplier. */
  317. static const _UIntType multiplier = __a;
  318. /** An increment. */
  319. static const _UIntType increment = __c;
  320. /** The modulus. */
  321. static const _UIntType modulus = __m;
  322. /**
  323. * Constructs a %linear_congruential random number generator engine with
  324. * seed @p __s. The default seed value is 1.
  325. *
  326. * @param __s The initial seed value.
  327. */
  328. explicit
  329. linear_congruential(unsigned long __x0 = 1)
  330. { this->seed(__x0); }
  331. /**
  332. * Constructs a %linear_congruential random number generator engine
  333. * seeded from the generator function @p __g.
  334. *
  335. * @param __g The seed generator function.
  336. */
  337. template<class _Gen>
  338. linear_congruential(_Gen& __g)
  339. { this->seed(__g); }
  340. /**
  341. * Reseeds the %linear_congruential random number generator engine
  342. * sequence to the seed @g __s.
  343. *
  344. * @param __s The new seed.
  345. */
  346. void
  347. seed(unsigned long __s = 1);
  348. /**
  349. * Reseeds the %linear_congruential random number generator engine
  350. * sequence using values from the generator function @p __g.
  351. *
  352. * @param __g the seed generator function.
  353. */
  354. template<class _Gen>
  355. void
  356. seed(_Gen& __g)
  357. { seed(__g, typename is_fundamental<_Gen>::type()); }
  358. /**
  359. * Gets the smallest possible value in the output range.
  360. *
  361. * The minimum depends on the @p __c parameter: if it is zero, the
  362. * minimum generated must be > 0, otherwise 0 is allowed.
  363. */
  364. result_type
  365. min() const
  366. { return (__detail::__mod<_UIntType, 1, 0, __m>(__c) == 0) ? 1 : 0; }
  367. /**
  368. * Gets the largest possible value in the output range.
  369. */
  370. result_type
  371. max() const
  372. { return __m - 1; }
  373. /**
  374. * Gets the next random number in the sequence.
  375. */
  376. result_type
  377. operator()();
  378. /**
  379. * Compares two linear congruential random number generator
  380. * objects of the same type for equality.
  381. *
  382. * @param __lhs A linear congruential random number generator object.
  383. * @param __rhs Another linear congruential random number generator obj.
  384. *
  385. * @returns true if the two objects are equal, false otherwise.
  386. */
  387. friend bool
  388. operator==(const linear_congruential& __lhs,
  389. const linear_congruential& __rhs)
  390. { return __lhs._M_x == __rhs._M_x; }
  391. /**
  392. * Compares two linear congruential random number generator
  393. * objects of the same type for inequality.
  394. *
  395. * @param __lhs A linear congruential random number generator object.
  396. * @param __rhs Another linear congruential random number generator obj.
  397. *
  398. * @returns true if the two objects are not equal, false otherwise.
  399. */
  400. friend bool
  401. operator!=(const linear_congruential& __lhs,
  402. const linear_congruential& __rhs)
  403. { return !(__lhs == __rhs); }
  404. /**
  405. * Writes the textual representation of the state x(i) of x to @p __os.
  406. *
  407. * @param __os The output stream.
  408. * @param __lcr A % linear_congruential random number generator.
  409. * @returns __os.
  410. */
  411. template<class _UIntType1, _UIntType1 __a1, _UIntType1 __c1,
  412. _UIntType1 __m1,
  413. typename _CharT, typename _Traits>
  414. friend std::basic_ostream<_CharT, _Traits>&
  415. operator<<(std::basic_ostream<_CharT, _Traits>& __os,
  416. const linear_congruential<_UIntType1, __a1, __c1,
  417. __m1>& __lcr);
  418. /**
  419. * Sets the state of the engine by reading its textual
  420. * representation from @p __is.
  421. *
  422. * The textual representation must have been previously written using an
  423. * output stream whose imbued locale and whose type's template
  424. * specialization arguments _CharT and _Traits were the same as those of
  425. * @p __is.
  426. *
  427. * @param __is The input stream.
  428. * @param __lcr A % linear_congruential random number generator.
  429. * @returns __is.
  430. */
  431. template<class _UIntType1, _UIntType1 __a1, _UIntType1 __c1,
  432. _UIntType1 __m1,
  433. typename _CharT, typename _Traits>
  434. friend std::basic_istream<_CharT, _Traits>&
  435. operator>>(std::basic_istream<_CharT, _Traits>& __is,
  436. linear_congruential<_UIntType1, __a1, __c1, __m1>& __lcr);
  437. private:
  438. template<class _Gen>
  439. void
  440. seed(_Gen& __g, true_type)
  441. { return seed(static_cast<unsigned long>(__g)); }
  442. template<class _Gen>
  443. void
  444. seed(_Gen& __g, false_type);
  445. _UIntType _M_x;
  446. };
  447. /**
  448. * The classic Minimum Standard rand0 of Lewis, Goodman, and Miller.
  449. */
  450. typedef linear_congruential<unsigned long, 16807, 0, 2147483647> minstd_rand0;
  451. /**
  452. * An alternative LCR (Lehmer Generator function) .
  453. */
  454. typedef linear_congruential<unsigned long, 48271, 0, 2147483647> minstd_rand;
  455. /**
  456. * A generalized feedback shift register discrete random number generator.
  457. *
  458. * This algorithm avoids multiplication and division and is designed to be
  459. * friendly to a pipelined architecture. If the parameters are chosen
  460. * correctly, this generator will produce numbers with a very long period and
  461. * fairly good apparent entropy, although still not cryptographically strong.
  462. *
  463. * The best way to use this generator is with the predefined mt19937 class.
  464. *
  465. * This algorithm was originally invented by Makoto Matsumoto and
  466. * Takuji Nishimura.
  467. *
  468. * @var word_size The number of bits in each element of the state vector.
  469. * @var state_size The degree of recursion.
  470. * @var shift_size The period parameter.
  471. * @var mask_bits The separation point bit index.
  472. * @var parameter_a The last row of the twist matrix.
  473. * @var output_u The first right-shift tempering matrix parameter.
  474. * @var output_s The first left-shift tempering matrix parameter.
  475. * @var output_b The first left-shift tempering matrix mask.
  476. * @var output_t The second left-shift tempering matrix parameter.
  477. * @var output_c The second left-shift tempering matrix mask.
  478. * @var output_l The second right-shift tempering matrix parameter.
  479. */
  480. template<class _UIntType, int __w, int __n, int __m, int __r,
  481. _UIntType __a, int __u, int __s, _UIntType __b, int __t,
  482. _UIntType __c, int __l>
  483. class mersenne_twister
  484. {
  485. __glibcxx_class_requires(_UIntType, _UnsignedIntegerConcept)
  486. public:
  487. // types
  488. typedef _UIntType result_type;
  489. // parameter values
  490. static const int word_size = __w;
  491. static const int state_size = __n;
  492. static const int shift_size = __m;
  493. static const int mask_bits = __r;
  494. static const _UIntType parameter_a = __a;
  495. static const int output_u = __u;
  496. static const int output_s = __s;
  497. static const _UIntType output_b = __b;
  498. static const int output_t = __t;
  499. static const _UIntType output_c = __c;
  500. static const int output_l = __l;
  501. // constructors and member function
  502. mersenne_twister()
  503. { seed(); }
  504. explicit
  505. mersenne_twister(unsigned long __value)
  506. { seed(__value); }
  507. template<class _Gen>
  508. mersenne_twister(_Gen& __g)
  509. { seed(__g); }
  510. void
  511. seed()
  512. { seed(5489UL); }
  513. void
  514. seed(unsigned long __value);
  515. template<class _Gen>
  516. void
  517. seed(_Gen& __g)
  518. { seed(__g, typename is_fundamental<_Gen>::type()); }
  519. result_type
  520. min() const
  521. { return 0; }
  522. result_type
  523. max() const
  524. { return __detail::_Shift<_UIntType, __w>::__value - 1; }
  525. result_type
  526. operator()();
  527. /**
  528. * Compares two % mersenne_twister random number generator objects of
  529. * the same type for equality.
  530. *
  531. * @param __lhs A % mersenne_twister random number generator object.
  532. * @param __rhs Another % mersenne_twister random number generator
  533. * object.
  534. *
  535. * @returns true if the two objects are equal, false otherwise.
  536. */
  537. friend bool
  538. operator==(const mersenne_twister& __lhs,
  539. const mersenne_twister& __rhs)
  540. { return std::equal(__lhs._M_x, __lhs._M_x + state_size, __rhs._M_x); }
  541. /**
  542. * Compares two % mersenne_twister random number generator objects of
  543. * the same type for inequality.
  544. *
  545. * @param __lhs A % mersenne_twister random number generator object.
  546. * @param __rhs Another % mersenne_twister random number generator
  547. * object.
  548. *
  549. * @returns true if the two objects are not equal, false otherwise.
  550. */
  551. friend bool
  552. operator!=(const mersenne_twister& __lhs,
  553. const mersenne_twister& __rhs)
  554. { return !(__lhs == __rhs); }
  555. /**
  556. * Inserts the current state of a % mersenne_twister random number
  557. * generator engine @p __x into the output stream @p __os.
  558. *
  559. * @param __os An output stream.
  560. * @param __x A % mersenne_twister random number generator engine.
  561. *
  562. * @returns The output stream with the state of @p __x inserted or in
  563. * an error state.
  564. */
  565. template<class _UIntType1, int __w1, int __n1, int __m1, int __r1,
  566. _UIntType1 __a1, int __u1, int __s1, _UIntType1 __b1, int __t1,
  567. _UIntType1 __c1, int __l1,
  568. typename _CharT, typename _Traits>
  569. friend std::basic_ostream<_CharT, _Traits>&
  570. operator<<(std::basic_ostream<_CharT, _Traits>& __os,
  571. const mersenne_twister<_UIntType1, __w1, __n1, __m1, __r1,
  572. __a1, __u1, __s1, __b1, __t1, __c1, __l1>& __x);
  573. /**
  574. * Extracts the current state of a % mersenne_twister random number
  575. * generator engine @p __x from the input stream @p __is.
  576. *
  577. * @param __is An input stream.
  578. * @param __x A % mersenne_twister random number generator engine.
  579. *
  580. * @returns The input stream with the state of @p __x extracted or in
  581. * an error state.
  582. */
  583. template<class _UIntType1, int __w1, int __n1, int __m1, int __r1,
  584. _UIntType1 __a1, int __u1, int __s1, _UIntType1 __b1, int __t1,
  585. _UIntType1 __c1, int __l1,
  586. typename _CharT, typename _Traits>
  587. friend std::basic_istream<_CharT, _Traits>&
  588. operator>>(std::basic_istream<_CharT, _Traits>& __is,
  589. mersenne_twister<_UIntType1, __w1, __n1, __m1, __r1,
  590. __a1, __u1, __s1, __b1, __t1, __c1, __l1>& __x);
  591. private:
  592. template<class _Gen>
  593. void
  594. seed(_Gen& __g, true_type)
  595. { return seed(static_cast<unsigned long>(__g)); }
  596. template<class _Gen>
  597. void
  598. seed(_Gen& __g, false_type);
  599. _UIntType _M_x[state_size];
  600. int _M_p;
  601. };
  602. /**
  603. * The classic Mersenne Twister.
  604. *
  605. * Reference:
  606. * M. Matsumoto and T. Nishimura, Mersenne Twister: A 623-Dimensionally
  607. * Equidistributed Uniform Pseudo-Random Number Generator, ACM Transactions
  608. * on Modeling and Computer Simulation, Vol. 8, No. 1, January 1998, pp 3-30.
  609. */
  610. typedef mersenne_twister<
  611. unsigned long, 32, 624, 397, 31,
  612. 0x9908b0dful, 11, 7,
  613. 0x9d2c5680ul, 15,
  614. 0xefc60000ul, 18
  615. > mt19937;
  616. /**
  617. * @brief The Marsaglia-Zaman generator.
  618. *
  619. * This is a model of a Generalized Fibonacci discrete random number
  620. * generator, sometimes referred to as the SWC generator.
  621. *
  622. * A discrete random number generator that produces pseudorandom
  623. * numbers using @f$x_{i}\leftarrow(x_{i - s} - x_{i - r} -
  624. * carry_{i-1}) \bmod m @f$.
  625. *
  626. * The size of the state is @f$ r @f$
  627. * and the maximum period of the generator is @f$ m^r - m^s -1 @f$.
  628. *
  629. * N1688[4.13] says <em>the template parameter _IntType shall denote
  630. * an integral type large enough to store values up to m</em>.
  631. *
  632. * @var _M_x The state of the generator. This is a ring buffer.
  633. * @var _M_carry The carry.
  634. * @var _M_p Current index of x(i - r).
  635. */
  636. template<typename _IntType, _IntType __m, int __s, int __r>
  637. class subtract_with_carry
  638. {
  639. __glibcxx_class_requires(_IntType, _IntegerConcept)
  640. public:
  641. /** The type of the generated random value. */
  642. typedef _IntType result_type;
  643. // parameter values
  644. static const _IntType modulus = __m;
  645. static const int long_lag = __r;
  646. static const int short_lag = __s;
  647. /**
  648. * Constructs a default-initialized % subtract_with_carry random number
  649. * generator.
  650. */
  651. subtract_with_carry()
  652. { this->seed(); }
  653. /**
  654. * Constructs an explicitly seeded % subtract_with_carry random number
  655. * generator.
  656. */
  657. explicit
  658. subtract_with_carry(unsigned long __value)
  659. { this->seed(__value); }
  660. /**
  661. * Constructs a %subtract_with_carry random number generator engine
  662. * seeded from the generator function @p __g.
  663. *
  664. * @param __g The seed generator function.
  665. */
  666. template<class _Gen>
  667. subtract_with_carry(_Gen& __g)
  668. { this->seed(__g); }
  669. /**
  670. * Seeds the initial state @f$ x_0 @f$ of the random number generator.
  671. *
  672. * N1688[4.19] modifies this as follows. If @p __value == 0,
  673. * sets value to 19780503. In any case, with a linear
  674. * congruential generator lcg(i) having parameters @f$ m_{lcg} =
  675. * 2147483563, a_{lcg} = 40014, c_{lcg} = 0, and lcg(0) = value
  676. * @f$, sets @f$ x_{-r} \dots x_{-1} @f$ to @f$ lcg(1) \bmod m
  677. * \dots lcg(r) \bmod m @f$ respectively. If @f$ x_{-1} = 0 @f$
  678. * set carry to 1, otherwise sets carry to 0.
  679. */
  680. void
  681. seed(unsigned long __value = 19780503);
  682. /**
  683. * Seeds the initial state @f$ x_0 @f$ of the % subtract_with_carry
  684. * random number generator.
  685. */
  686. template<class _Gen>
  687. void
  688. seed(_Gen& __g)
  689. { seed(__g, typename is_fundamental<_Gen>::type()); }
  690. /**
  691. * Gets the inclusive minimum value of the range of random integers
  692. * returned by this generator.
  693. */
  694. result_type
  695. min() const
  696. { return 0; }
  697. /**
  698. * Gets the inclusive maximum value of the range of random integers
  699. * returned by this generator.
  700. */
  701. result_type
  702. max() const
  703. { return this->modulus - 1; }
  704. /**
  705. * Gets the next random number in the sequence.
  706. */
  707. result_type
  708. operator()();
  709. /**
  710. * Compares two % subtract_with_carry random number generator objects of
  711. * the same type for equality.
  712. *
  713. * @param __lhs A % subtract_with_carry random number generator object.
  714. * @param __rhs Another % subtract_with_carry random number generator
  715. * object.
  716. *
  717. * @returns true if the two objects are equal, false otherwise.
  718. */
  719. friend bool
  720. operator==(const subtract_with_carry& __lhs,
  721. const subtract_with_carry& __rhs)
  722. { return std::equal(__lhs._M_x, __lhs._M_x + long_lag, __rhs._M_x); }
  723. /**
  724. * Compares two % subtract_with_carry random number generator objects of
  725. * the same type for inequality.
  726. *
  727. * @param __lhs A % subtract_with_carry random number generator object.
  728. * @param __rhs Another % subtract_with_carry random number generator
  729. * object.
  730. *
  731. * @returns true if the two objects are not equal, false otherwise.
  732. */
  733. friend bool
  734. operator!=(const subtract_with_carry& __lhs,
  735. const subtract_with_carry& __rhs)
  736. { return !(__lhs == __rhs); }
  737. /**
  738. * Inserts the current state of a % subtract_with_carry random number
  739. * generator engine @p __x into the output stream @p __os.
  740. *
  741. * @param __os An output stream.
  742. * @param __x A % subtract_with_carry random number generator engine.
  743. *
  744. * @returns The output stream with the state of @p __x inserted or in
  745. * an error state.
  746. */
  747. template<typename _IntType1, _IntType1 __m1, int __s1, int __r1,
  748. typename _CharT, typename _Traits>
  749. friend std::basic_ostream<_CharT, _Traits>&
  750. operator<<(std::basic_ostream<_CharT, _Traits>& __os,
  751. const subtract_with_carry<_IntType1, __m1, __s1,
  752. __r1>& __x);
  753. /**
  754. * Extracts the current state of a % subtract_with_carry random number
  755. * generator engine @p __x from the input stream @p __is.
  756. *
  757. * @param __is An input stream.
  758. * @param __x A % subtract_with_carry random number generator engine.
  759. *
  760. * @returns The input stream with the state of @p __x extracted or in
  761. * an error state.
  762. */
  763. template<typename _IntType1, _IntType1 __m1, int __s1, int __r1,
  764. typename _CharT, typename _Traits>
  765. friend std::basic_istream<_CharT, _Traits>&
  766. operator>>(std::basic_istream<_CharT, _Traits>& __is,
  767. subtract_with_carry<_IntType1, __m1, __s1, __r1>& __x);
  768. private:
  769. template<class _Gen>
  770. void
  771. seed(_Gen& __g, true_type)
  772. { return seed(static_cast<unsigned long>(__g)); }
  773. template<class _Gen>
  774. void
  775. seed(_Gen& __g, false_type);
  776. typedef typename __gnu_cxx::__add_unsigned<_IntType>::__type _UIntType;
  777. _UIntType _M_x[long_lag];
  778. _UIntType _M_carry;
  779. int _M_p;
  780. };
  781. /**
  782. * @brief The Marsaglia-Zaman generator (floats version).
  783. *
  784. * @var _M_x The state of the generator. This is a ring buffer.
  785. * @var _M_carry The carry.
  786. * @var _M_p Current index of x(i - r).
  787. * @var _M_npows Precomputed negative powers of 2.
  788. */
  789. template<typename _RealType, int __w, int __s, int __r>
  790. class subtract_with_carry_01
  791. {
  792. public:
  793. /** The type of the generated random value. */
  794. typedef _RealType result_type;
  795. // parameter values
  796. static const int word_size = __w;
  797. static const int long_lag = __r;
  798. static const int short_lag = __s;
  799. /**
  800. * Constructs a default-initialized % subtract_with_carry_01 random
  801. * number generator.
  802. */
  803. subtract_with_carry_01()
  804. {
  805. this->seed();
  806. _M_initialize_npows();
  807. }
  808. /**
  809. * Constructs an explicitly seeded % subtract_with_carry_01 random number
  810. * generator.
  811. */
  812. explicit
  813. subtract_with_carry_01(unsigned long __value)
  814. {
  815. this->seed(__value);
  816. _M_initialize_npows();
  817. }
  818. /**
  819. * Constructs a % subtract_with_carry_01 random number generator engine
  820. * seeded from the generator function @p __g.
  821. *
  822. * @param __g The seed generator function.
  823. */
  824. template<class _Gen>
  825. subtract_with_carry_01(_Gen& __g)
  826. {
  827. this->seed(__g);
  828. _M_initialize_npows();
  829. }
  830. /**
  831. * Seeds the initial state @f$ x_0 @f$ of the random number generator.
  832. */
  833. void
  834. seed(unsigned long __value = 19780503);
  835. /**
  836. * Seeds the initial state @f$ x_0 @f$ of the % subtract_with_carry_01
  837. * random number generator.
  838. */
  839. template<class _Gen>
  840. void
  841. seed(_Gen& __g)
  842. { seed(__g, typename is_fundamental<_Gen>::type()); }
  843. /**
  844. * Gets the minimum value of the range of random floats
  845. * returned by this generator.
  846. */
  847. result_type
  848. min() const
  849. { return 0.0; }
  850. /**
  851. * Gets the maximum value of the range of random floats
  852. * returned by this generator.
  853. */
  854. result_type
  855. max() const
  856. { return 1.0; }
  857. /**
  858. * Gets the next random number in the sequence.
  859. */
  860. result_type
  861. operator()();
  862. /**
  863. * Compares two % subtract_with_carry_01 random number generator objects
  864. * of the same type for equality.
  865. *
  866. * @param __lhs A % subtract_with_carry_01 random number
  867. * generator object.
  868. * @param __rhs Another % subtract_with_carry_01 random number generator
  869. * object.
  870. *
  871. * @returns true if the two objects are equal, false otherwise.
  872. */
  873. friend bool
  874. operator==(const subtract_with_carry_01& __lhs,
  875. const subtract_with_carry_01& __rhs)
  876. {
  877. for (int __i = 0; __i < long_lag; ++__i)
  878. if (!std::equal(__lhs._M_x[__i], __lhs._M_x[__i] + __n,
  879. __rhs._M_x[__i]))
  880. return false;
  881. return true;
  882. }
  883. /**
  884. * Compares two % subtract_with_carry_01 random number generator objects
  885. * of the same type for inequality.
  886. *
  887. * @param __lhs A % subtract_with_carry_01 random number
  888. * generator object.
  889. *
  890. * @param __rhs Another % subtract_with_carry_01 random number generator
  891. * object.
  892. *
  893. * @returns true if the two objects are not equal, false otherwise.
  894. */
  895. friend bool
  896. operator!=(const subtract_with_carry_01& __lhs,
  897. const subtract_with_carry_01& __rhs)
  898. { return !(__lhs == __rhs); }
  899. /**
  900. * Inserts the current state of a % subtract_with_carry_01 random number
  901. * generator engine @p __x into the output stream @p __os.
  902. *
  903. * @param __os An output stream.
  904. * @param __x A % subtract_with_carry_01 random number generator engine.
  905. *
  906. * @returns The output stream with the state of @p __x inserted or in
  907. * an error state.
  908. */
  909. template<typename _RealType1, int __w1, int __s1, int __r1,
  910. typename _CharT, typename _Traits>
  911. friend std::basic_ostream<_CharT, _Traits>&
  912. operator<<(std::basic_ostream<_CharT, _Traits>& __os,
  913. const subtract_with_carry_01<_RealType1, __w1, __s1,
  914. __r1>& __x);
  915. /**
  916. * Extracts the current state of a % subtract_with_carry_01 random number
  917. * generator engine @p __x from the input stream @p __is.
  918. *
  919. * @param __is An input stream.
  920. * @param __x A % subtract_with_carry_01 random number generator engine.
  921. *
  922. * @returns The input stream with the state of @p __x extracted or in
  923. * an error state.
  924. */
  925. template<typename _RealType1, int __w1, int __s1, int __r1,
  926. typename _CharT, typename _Traits>
  927. friend std::basic_istream<_CharT, _Traits>&
  928. operator>>(std::basic_istream<_CharT, _Traits>& __is,
  929. subtract_with_carry_01<_RealType1, __w1, __s1, __r1>& __x);
  930. private:
  931. template<class _Gen>
  932. void
  933. seed(_Gen& __g, true_type)
  934. { return seed(static_cast<unsigned long>(__g)); }
  935. template<class _Gen>
  936. void
  937. seed(_Gen& __g, false_type);
  938. void
  939. _M_initialize_npows();
  940. static const int __n = (__w + 31) / 32;
  941. typedef __detail::_UInt32Type _UInt32Type;
  942. _UInt32Type _M_x[long_lag][__n];
  943. _RealType _M_npows[__n];
  944. _UInt32Type _M_carry;
  945. int _M_p;
  946. };
  947. typedef subtract_with_carry_01<float, 24, 10, 24> ranlux_base_01;
  948. // _GLIBCXX_RESOLVE_LIB_DEFECTS
  949. // 508. Bad parameters for ranlux64_base_01.
  950. typedef subtract_with_carry_01<double, 48, 5, 12> ranlux64_base_01;
  951. /**
  952. * Produces random numbers from some base engine by discarding blocks of
  953. * data.
  954. *
  955. * 0 <= @p __r <= @p __p
  956. */
  957. template<class _UniformRandomNumberGenerator, int __p, int __r>
  958. class discard_block
  959. {
  960. // __glibcxx_class_requires(typename base_type::result_type,
  961. // ArithmeticTypeConcept)
  962. public:
  963. /** The type of the underlying generator engine. */
  964. typedef _UniformRandomNumberGenerator base_type;
  965. /** The type of the generated random value. */
  966. typedef typename base_type::result_type result_type;
  967. // parameter values
  968. static const int block_size = __p;
  969. static const int used_block = __r;
  970. /**
  971. * Constructs a default %discard_block engine.
  972. *
  973. * The underlying engine is default constructed as well.
  974. */
  975. discard_block()
  976. : _M_n(0) { }
  977. /**
  978. * Copy constructs a %discard_block engine.
  979. *
  980. * Copies an existing base class random number generator.
  981. * @param rng An existing (base class) engine object.
  982. */
  983. explicit
  984. discard_block(const base_type& __rng)
  985. : _M_b(__rng), _M_n(0) { }
  986. /**
  987. * Seed constructs a %discard_block engine.
  988. *
  989. * Constructs the underlying generator engine seeded with @p __s.
  990. * @param __s A seed value for the base class engine.
  991. */
  992. explicit
  993. discard_block(unsigned long __s)
  994. : _M_b(__s), _M_n(0) { }
  995. /**
  996. * Generator construct a %discard_block engine.
  997. *
  998. * @param __g A seed generator function.
  999. */
  1000. template<class _Gen>
  1001. discard_block(_Gen& __g)
  1002. : _M_b(__g), _M_n(0) { }
  1003. /**
  1004. * Reseeds the %discard_block object with the default seed for the
  1005. * underlying base class generator engine.
  1006. */
  1007. void seed()
  1008. {
  1009. _M_b.seed();
  1010. _M_n = 0;
  1011. }
  1012. /**
  1013. * Reseeds the %discard_block object with the given seed generator
  1014. * function.
  1015. * @param __g A seed generator function.
  1016. */
  1017. template<class _Gen>
  1018. void seed(_Gen& __g)
  1019. {
  1020. _M_b.seed(__g);
  1021. _M_n = 0;
  1022. }
  1023. /**
  1024. * Gets a const reference to the underlying generator engine object.
  1025. */
  1026. const base_type&
  1027. base() const
  1028. { return _M_b; }
  1029. /**
  1030. * Gets the minimum value in the generated random number range.
  1031. */
  1032. result_type
  1033. min() const
  1034. { return _M_b.min(); }
  1035. /**
  1036. * Gets the maximum value in the generated random number range.
  1037. */
  1038. result_type
  1039. max() const
  1040. { return _M_b.max(); }
  1041. /**
  1042. * Gets the next value in the generated random number sequence.
  1043. */
  1044. result_type
  1045. operator()();
  1046. /**
  1047. * Compares two %discard_block random number generator objects of
  1048. * the same type for equality.
  1049. *
  1050. * @param __lhs A %discard_block random number generator object.
  1051. * @param __rhs Another %discard_block random number generator
  1052. * object.
  1053. *
  1054. * @returns true if the two objects are equal, false otherwise.
  1055. */
  1056. friend bool
  1057. operator==(const discard_block& __lhs, const discard_block& __rhs)
  1058. { return (__lhs._M_b == __rhs._M_b) && (__lhs._M_n == __rhs._M_n); }
  1059. /**
  1060. * Compares two %discard_block random number generator objects of
  1061. * the same type for inequality.
  1062. *
  1063. * @param __lhs A %discard_block random number generator object.
  1064. * @param __rhs Another %discard_block random number generator
  1065. * object.
  1066. *
  1067. * @returns true if the two objects are not equal, false otherwise.
  1068. */
  1069. friend bool
  1070. operator!=(const discard_block& __lhs, const discard_block& __rhs)
  1071. { return !(__lhs == __rhs); }
  1072. /**
  1073. * Inserts the current state of a %discard_block random number
  1074. * generator engine @p __x into the output stream @p __os.
  1075. *
  1076. * @param __os An output stream.
  1077. * @param __x A %discard_block random number generator engine.
  1078. *
  1079. * @returns The output stream with the state of @p __x inserted or in
  1080. * an error state.
  1081. */
  1082. template<class _UniformRandomNumberGenerator1, int __p1, int __r1,
  1083. typename _CharT, typename _Traits>
  1084. friend std::basic_ostream<_CharT, _Traits>&
  1085. operator<<(std::basic_ostream<_CharT, _Traits>& __os,
  1086. const discard_block<_UniformRandomNumberGenerator1,
  1087. __p1, __r1>& __x);
  1088. /**
  1089. * Extracts the current state of a % subtract_with_carry random number
  1090. * generator engine @p __x from the input stream @p __is.
  1091. *
  1092. * @param __is An input stream.
  1093. * @param __x A %discard_block random number generator engine.
  1094. *
  1095. * @returns The input stream with the state of @p __x extracted or in
  1096. * an error state.
  1097. */
  1098. template<class _UniformRandomNumberGenerator1, int __p1, int __r1,
  1099. typename _CharT, typename _Traits>
  1100. friend std::basic_istream<_CharT, _Traits>&
  1101. operator>>(std::basic_istream<_CharT, _Traits>& __is,
  1102. discard_block<_UniformRandomNumberGenerator1,
  1103. __p1, __r1>& __x);
  1104. private:
  1105. base_type _M_b;
  1106. int _M_n;
  1107. };
  1108. /**
  1109. * James's luxury-level-3 integer adaptation of Luescher's generator.
  1110. */
  1111. typedef discard_block<
  1112. subtract_with_carry<unsigned long, (1UL << 24), 10, 24>,
  1113. 223,
  1114. 24
  1115. > ranlux3;
  1116. /**
  1117. * James's luxury-level-4 integer adaptation of Luescher's generator.
  1118. */
  1119. typedef discard_block<
  1120. subtract_with_carry<unsigned long, (1UL << 24), 10, 24>,
  1121. 389,
  1122. 24
  1123. > ranlux4;
  1124. typedef discard_block<
  1125. subtract_with_carry_01<float, 24, 10, 24>,
  1126. 223,
  1127. 24
  1128. > ranlux3_01;
  1129. typedef discard_block<
  1130. subtract_with_carry_01<float, 24, 10, 24>,
  1131. 389,
  1132. 24
  1133. > ranlux4_01;
  1134. /**
  1135. * A random number generator adaptor class that combines two random number
  1136. * generator engines into a single output sequence.
  1137. */
  1138. template<class _UniformRandomNumberGenerator1, int __s1,
  1139. class _UniformRandomNumberGenerator2, int __s2>
  1140. class xor_combine
  1141. {
  1142. // __glibcxx_class_requires(typename _UniformRandomNumberGenerator1::
  1143. // result_type, ArithmeticTypeConcept)
  1144. // __glibcxx_class_requires(typename _UniformRandomNumberGenerator2::
  1145. // result_type, ArithmeticTypeConcept)
  1146. public:
  1147. /** The type of the first underlying generator engine. */
  1148. typedef _UniformRandomNumberGenerator1 base1_type;
  1149. /** The type of the second underlying generator engine. */
  1150. typedef _UniformRandomNumberGenerator2 base2_type;
  1151. private:
  1152. typedef typename base1_type::result_type _Result_type1;
  1153. typedef typename base2_type::result_type _Result_type2;
  1154. public:
  1155. /** The type of the generated random value. */
  1156. typedef typename __gnu_cxx::__conditional_type<(sizeof(_Result_type1)
  1157. > sizeof(_Result_type2)),
  1158. _Result_type1, _Result_type2>::__type result_type;
  1159. // parameter values
  1160. static const int shift1 = __s1;
  1161. static const int shift2 = __s2;
  1162. // constructors and member function
  1163. xor_combine()
  1164. : _M_b1(), _M_b2()
  1165. { _M_initialize_max(); }
  1166. xor_combine(const base1_type& __rng1, const base2_type& __rng2)
  1167. : _M_b1(__rng1), _M_b2(__rng2)
  1168. { _M_initialize_max(); }
  1169. xor_combine(unsigned long __s)
  1170. : _M_b1(__s), _M_b2(__s + 1)
  1171. { _M_initialize_max(); }
  1172. template<class _Gen>
  1173. xor_combine(_Gen& __g)
  1174. : _M_b1(__g), _M_b2(__g)
  1175. { _M_initialize_max(); }
  1176. void
  1177. seed()
  1178. {
  1179. _M_b1.seed();
  1180. _M_b2.seed();
  1181. }
  1182. template<class _Gen>
  1183. void
  1184. seed(_Gen& __g)
  1185. {
  1186. _M_b1.seed(__g);
  1187. _M_b2.seed(__g);
  1188. }
  1189. const base1_type&
  1190. base1() const
  1191. { return _M_b1; }
  1192. const base2_type&
  1193. base2() const
  1194. { return _M_b2; }
  1195. result_type
  1196. min() const
  1197. { return 0; }
  1198. result_type
  1199. max() const
  1200. { return _M_max; }
  1201. /**
  1202. * Gets the next random number in the sequence.
  1203. */
  1204. // NB: Not exactly the TR1 formula, per N2079 instead.
  1205. result_type
  1206. operator()()
  1207. {
  1208. return ((result_type(_M_b1() - _M_b1.min()) << shift1)
  1209. ^ (result_type(_M_b2() - _M_b2.min()) << shift2));
  1210. }
  1211. /**
  1212. * Compares two %xor_combine random number generator objects of
  1213. * the same type for equality.
  1214. *
  1215. * @param __lhs A %xor_combine random number generator object.
  1216. * @param __rhs Another %xor_combine random number generator
  1217. * object.
  1218. *
  1219. * @returns true if the two objects are equal, false otherwise.
  1220. */
  1221. friend bool
  1222. operator==(const xor_combine& __lhs, const xor_combine& __rhs)
  1223. {
  1224. return (__lhs.base1() == __rhs.base1())
  1225. && (__lhs.base2() == __rhs.base2());
  1226. }
  1227. /**
  1228. * Compares two %xor_combine random number generator objects of
  1229. * the same type for inequality.
  1230. *
  1231. * @param __lhs A %xor_combine random number generator object.
  1232. * @param __rhs Another %xor_combine random number generator
  1233. * object.
  1234. *
  1235. * @returns true if the two objects are not equal, false otherwise.
  1236. */
  1237. friend bool
  1238. operator!=(const xor_combine& __lhs, const xor_combine& __rhs)
  1239. { return !(__lhs == __rhs); }
  1240. /**
  1241. * Inserts the current state of a %xor_combine random number
  1242. * generator engine @p __x into the output stream @p __os.
  1243. *
  1244. * @param __os An output stream.
  1245. * @param __x A %xor_combine random number generator engine.
  1246. *
  1247. * @returns The output stream with the state of @p __x inserted or in
  1248. * an error state.
  1249. */
  1250. template<class _UniformRandomNumberGenerator11, int __s11,
  1251. class _UniformRandomNumberGenerator21, int __s21,
  1252. typename _CharT, typename _Traits>
  1253. friend std::basic_ostream<_CharT, _Traits>&
  1254. operator<<(std::basic_ostream<_CharT, _Traits>& __os,
  1255. const xor_combine<_UniformRandomNumberGenerator11, __s11,
  1256. _UniformRandomNumberGenerator21, __s21>& __x);
  1257. /**
  1258. * Extracts the current state of a %xor_combine random number
  1259. * generator engine @p __x from the input stream @p __is.
  1260. *
  1261. * @param __is An input stream.
  1262. * @param __x A %xor_combine random number generator engine.
  1263. *
  1264. * @returns The input stream with the state of @p __x extracted or in
  1265. * an error state.
  1266. */
  1267. template<class _UniformRandomNumberGenerator11, int __s11,
  1268. class _UniformRandomNumberGenerator21, int __s21,
  1269. typename _CharT, typename _Traits>
  1270. friend std::basic_istream<_CharT, _Traits>&
  1271. operator>>(std::basic_istream<_CharT, _Traits>& __is,
  1272. xor_combine<_UniformRandomNumberGenerator11, __s11,
  1273. _UniformRandomNumberGenerator21, __s21>& __x);
  1274. private:
  1275. void
  1276. _M_initialize_max();
  1277. result_type
  1278. _M_initialize_max_aux(result_type, result_type, int);
  1279. base1_type _M_b1;
  1280. base2_type _M_b2;
  1281. result_type _M_max;
  1282. };
  1283. /**
  1284. * A standard interface to a platform-specific non-deterministic
  1285. * random number generator (if any are available).
  1286. */
  1287. class random_device
  1288. {
  1289. public:
  1290. // types
  1291. typedef unsigned int result_type;
  1292. // constructors, destructors and member functions
  1293. #ifdef _GLIBCXX_USE_RANDOM_TR1
  1294. explicit
  1295. random_device(const std::string& __token = "/dev/urandom")
  1296. {
  1297. if ((__token != "/dev/urandom" && __token != "/dev/random")
  1298. || !(_M_file = std::fopen(__token.c_str(), "rb")))
  1299. std::__throw_runtime_error(__N("random_device::"
  1300. "random_device(const std::string&)"));
  1301. }
  1302. ~random_device()
  1303. { std::fclose(_M_file); }
  1304. #else
  1305. explicit
  1306. random_device(const std::string& __token = "mt19937")
  1307. : _M_mt(_M_strtoul(__token)) { }
  1308. private:
  1309. static unsigned long
  1310. _M_strtoul(const std::string& __str)
  1311. {
  1312. unsigned long __ret = 5489UL;
  1313. if (__str != "mt19937")
  1314. {
  1315. const char* __nptr = __str.c_str();
  1316. char* __endptr;
  1317. __ret = std::strtoul(__nptr, &__endptr, 0);
  1318. if (*__nptr == '\0' || *__endptr != '\0')
  1319. std::__throw_runtime_error(__N("random_device::_M_strtoul"
  1320. "(const std::string&)"));
  1321. }
  1322. return __ret;
  1323. }
  1324. public:
  1325. #endif
  1326. result_type
  1327. min() const
  1328. { return std::numeric_limits<result_type>::min(); }
  1329. result_type
  1330. max() const
  1331. { return std::numeric_limits<result_type>::max(); }
  1332. double
  1333. entropy() const
  1334. { return 0.0; }
  1335. result_type
  1336. operator()()
  1337. {
  1338. #ifdef _GLIBCXX_USE_RANDOM_TR1
  1339. result_type __ret;
  1340. std::fread(reinterpret_cast<void*>(&__ret), sizeof(result_type),
  1341. 1, _M_file);
  1342. return __ret;
  1343. #else
  1344. return _M_mt();
  1345. #endif
  1346. }
  1347. private:
  1348. random_device(const random_device&);
  1349. void operator=(const random_device&);
  1350. #ifdef _GLIBCXX_USE_RANDOM_TR1
  1351. FILE* _M_file;
  1352. #else
  1353. mt19937 _M_mt;
  1354. #endif
  1355. };
  1356. /* @} */ // group tr1_random_generators
  1357. /**
  1358. * @addtogroup tr1_random_distributions Random Number Distributions
  1359. * @ingroup tr1_random
  1360. * @{
  1361. */
  1362. /**
  1363. * @addtogroup tr1_random_distributions_discrete Discrete Distributions
  1364. * @ingroup tr1_random_distributions
  1365. * @{
  1366. */
  1367. /**
  1368. * @brief Uniform discrete distribution for random numbers.
  1369. * A discrete random distribution on the range @f$[min, max]@f$ with equal
  1370. * probability throughout the range.
  1371. */
  1372. template<typename _IntType = int>
  1373. class uniform_int
  1374. {
  1375. __glibcxx_class_requires(_IntType, _IntegerConcept)
  1376. public:
  1377. /** The type of the parameters of the distribution. */
  1378. typedef _IntType input_type;
  1379. /** The type of the range of the distribution. */
  1380. typedef _IntType result_type;
  1381. public:
  1382. /**
  1383. * Constructs a uniform distribution object.
  1384. */
  1385. explicit
  1386. uniform_int(_IntType __min = 0, _IntType __max = 9)
  1387. : _M_min(__min), _M_max(__max)
  1388. {
  1389. _GLIBCXX_DEBUG_ASSERT(_M_min <= _M_max);
  1390. }
  1391. /**
  1392. * Gets the inclusive lower bound of the distribution range.
  1393. */
  1394. result_type
  1395. min() const
  1396. { return _M_min; }
  1397. /**
  1398. * Gets the inclusive upper bound of the distribution range.
  1399. */
  1400. result_type
  1401. max() const
  1402. { return _M_max; }
  1403. /**
  1404. * Resets the distribution state.
  1405. *
  1406. * Does nothing for the uniform integer distribution.
  1407. */
  1408. void
  1409. reset() { }
  1410. /**
  1411. * Gets a uniformly distributed random number in the range
  1412. * @f$(min, max)@f$.
  1413. */
  1414. template<typename _UniformRandomNumberGenerator>
  1415. result_type
  1416. operator()(_UniformRandomNumberGenerator& __urng)
  1417. {
  1418. typedef typename _UniformRandomNumberGenerator::result_type
  1419. _UResult_type;
  1420. return _M_call(__urng, _M_min, _M_max,
  1421. typename is_integral<_UResult_type>::type());
  1422. }
  1423. /**
  1424. * Gets a uniform random number in the range @f$[0, n)@f$.
  1425. *
  1426. * This function is aimed at use with std::random_shuffle.
  1427. */
  1428. template<typename _UniformRandomNumberGenerator>
  1429. result_type
  1430. operator()(_UniformRandomNumberGenerator& __urng, result_type __n)
  1431. {
  1432. typedef typename _UniformRandomNumberGenerator::result_type
  1433. _UResult_type;
  1434. return _M_call(__urng, 0, __n - 1,
  1435. typename is_integral<_UResult_type>::type());
  1436. }
  1437. /**
  1438. * Inserts a %uniform_int random number distribution @p __x into the
  1439. * output stream @p os.
  1440. *
  1441. * @param __os An output stream.
  1442. * @param __x A %uniform_int random number distribution.
  1443. *
  1444. * @returns The output stream with the state of @p __x inserted or in
  1445. * an error state.
  1446. */
  1447. template<typename _IntType1, typename _CharT, typename _Traits>
  1448. friend std::basic_ostream<_CharT, _Traits>&
  1449. operator<<(std::basic_ostream<_CharT, _Traits>& __os,
  1450. const uniform_int<_IntType1>& __x);
  1451. /**
  1452. * Extracts a %uniform_int random number distribution
  1453. * @p __x from the input stream @p __is.
  1454. *
  1455. * @param __is An input stream.
  1456. * @param __x A %uniform_int random number generator engine.
  1457. *
  1458. * @returns The input stream with @p __x extracted or in an error state.
  1459. */
  1460. template<typename _IntType1, typename _CharT, typename _Traits>
  1461. friend std::basic_istream<_CharT, _Traits>&
  1462. operator>>(std::basic_istream<_CharT, _Traits>& __is,
  1463. uniform_int<_IntType1>& __x);
  1464. private:
  1465. template<typename _UniformRandomNumberGenerator>
  1466. result_type
  1467. _M_call(_UniformRandomNumberGenerator& __urng,
  1468. result_type __min, result_type __max, true_type);
  1469. template<typename _UniformRandomNumberGenerator>
  1470. result_type
  1471. _M_call(_UniformRandomNumberGenerator& __urng,
  1472. result_type __min, result_type __max, false_type)
  1473. {
  1474. return result_type((__urng() - __urng.min())
  1475. / (__urng.max() - __urng.min())
  1476. * (__max - __min + 1)) + __min;
  1477. }
  1478. _IntType _M_min;
  1479. _IntType _M_max;
  1480. };
  1481. /**
  1482. * @brief A Bernoulli random number distribution.
  1483. *
  1484. * Generates a sequence of true and false values with likelihood @f$ p @f$
  1485. * that true will come up and @f$ (1 - p) @f$ that false will appear.
  1486. */
  1487. class bernoulli_distribution
  1488. {
  1489. public:
  1490. typedef int input_type;
  1491. typedef bool result_type;
  1492. public:
  1493. /**
  1494. * Constructs a Bernoulli distribution with likelihood @p p.
  1495. *
  1496. * @param __p [IN] The likelihood of a true result being returned. Must
  1497. * be in the interval @f$ [0, 1] @f$.
  1498. */
  1499. explicit
  1500. bernoulli_distribution(double __p = 0.5)
  1501. : _M_p(__p)
  1502. {
  1503. _GLIBCXX_DEBUG_ASSERT((_M_p >= 0.0) && (_M_p <= 1.0));
  1504. }
  1505. /**
  1506. * Gets the @p p parameter of the distribution.
  1507. */
  1508. double
  1509. p() const
  1510. { return _M_p; }
  1511. /**
  1512. * Resets the distribution state.
  1513. *
  1514. * Does nothing for a Bernoulli distribution.
  1515. */
  1516. void
  1517. reset() { }
  1518. /**
  1519. * Gets the next value in the Bernoullian sequence.
  1520. */
  1521. template<class _UniformRandomNumberGenerator>
  1522. result_type
  1523. operator()(_UniformRandomNumberGenerator& __urng)
  1524. {
  1525. if ((__urng() - __urng.min()) < _M_p * (__urng.max() - __urng.min()))
  1526. return true;
  1527. return false;
  1528. }
  1529. /**
  1530. * Inserts a %bernoulli_distribution random number distribution
  1531. * @p __x into the output stream @p __os.
  1532. *
  1533. * @param __os An output stream.
  1534. * @param __x A %bernoulli_distribution random number distribution.
  1535. *
  1536. * @returns The output stream with the state of @p __x inserted or in
  1537. * an error state.
  1538. */
  1539. template<typename _CharT, typename _Traits>
  1540. friend std::basic_ostream<_CharT, _Traits>&
  1541. operator<<(std::basic_ostream<_CharT, _Traits>& __os,
  1542. const bernoulli_distribution& __x);
  1543. /**
  1544. * Extracts a %bernoulli_distribution random number distribution
  1545. * @p __x from the input stream @p __is.
  1546. *
  1547. * @param __is An input stream.
  1548. * @param __x A %bernoulli_distribution random number generator engine.
  1549. *
  1550. * @returns The input stream with @p __x extracted or in an error state.
  1551. */
  1552. template<typename _CharT, typename _Traits>
  1553. friend std::basic_istream<_CharT, _Traits>&
  1554. operator>>(std::basic_istream<_CharT, _Traits>& __is,
  1555. bernoulli_distribution& __x)
  1556. { return __is >> __x._M_p; }
  1557. private:
  1558. double _M_p;
  1559. };
  1560. /**
  1561. * @brief A discrete geometric random number distribution.
  1562. *
  1563. * The formula for the geometric probability mass function is
  1564. * @f$ p(i) = (1 - p)p^{i-1} @f$ where @f$ p @f$ is the parameter of the
  1565. * distribution.
  1566. */
  1567. template<typename _IntType = int, typename _RealType = double>
  1568. class geometric_distribution
  1569. {
  1570. public:
  1571. // types
  1572. typedef _RealType input_type;
  1573. typedef _IntType result_type;
  1574. // constructors and member function
  1575. explicit
  1576. geometric_distribution(const _RealType& __p = _RealType(0.5))
  1577. : _M_p(__p)
  1578. {
  1579. _GLIBCXX_DEBUG_ASSERT((_M_p > 0.0) && (_M_p < 1.0));
  1580. _M_initialize();
  1581. }
  1582. /**
  1583. * Gets the distribution parameter @p p.
  1584. */
  1585. _RealType
  1586. p() const
  1587. { return _M_p; }
  1588. void
  1589. reset() { }
  1590. template<class _UniformRandomNumberGenerator>
  1591. result_type
  1592. operator()(_UniformRandomNumberGenerator& __urng);
  1593. /**
  1594. * Inserts a %geometric_distribution random number distribution
  1595. * @p __x into the output stream @p __os.
  1596. *
  1597. * @param __os An output stream.
  1598. * @param __x A %geometric_distribution random number distribution.
  1599. *
  1600. * @returns The output stream with the state of @p __x inserted or in
  1601. * an error state.
  1602. */
  1603. template<typename _IntType1, typename _RealType1,
  1604. typename _CharT, typename _Traits>
  1605. friend std::basic_ostream<_CharT, _Traits>&
  1606. operator<<(std::basic_ostream<_CharT, _Traits>& __os,
  1607. const geometric_distribution<_IntType1, _RealType1>& __x);
  1608. /**
  1609. * Extracts a %geometric_distribution random number distribution
  1610. * @p __x from the input stream @p __is.
  1611. *
  1612. * @param __is An input stream.
  1613. * @param __x A %geometric_distribution random number generator engine.
  1614. *
  1615. * @returns The input stream with @p __x extracted or in an error state.
  1616. */
  1617. template<typename _CharT, typename _Traits>
  1618. friend std::basic_istream<_CharT, _Traits>&
  1619. operator>>(std::basic_istream<_CharT, _Traits>& __is,
  1620. geometric_distribution& __x)
  1621. {
  1622. __is >> __x._M_p;
  1623. __x._M_initialize();
  1624. return __is;
  1625. }
  1626. private:
  1627. void
  1628. _M_initialize()
  1629. { _M_log_p = std::log(_M_p); }
  1630. _RealType _M_p;
  1631. _RealType _M_log_p;
  1632. };
  1633. template<typename _RealType>
  1634. class normal_distribution;
  1635. /**
  1636. * @brief A discrete Poisson random number distribution.
  1637. *
  1638. * The formula for the Poisson probability mass function is
  1639. * @f$ p(i) = \frac{mean^i}{i!} e^{-mean} @f$ where @f$ mean @f$ is the
  1640. * parameter of the distribution.
  1641. */
  1642. template<typename _IntType = int, typename _RealType = double>
  1643. class poisson_distribution
  1644. {
  1645. public:
  1646. // types
  1647. typedef _RealType input_type;
  1648. typedef _IntType result_type;
  1649. // constructors and member function
  1650. explicit
  1651. poisson_distribution(const _RealType& __mean = _RealType(1))
  1652. : _M_mean(__mean), _M_nd()
  1653. {
  1654. _GLIBCXX_DEBUG_ASSERT(_M_mean > 0.0);
  1655. _M_initialize();
  1656. }
  1657. /**
  1658. * Gets the distribution parameter @p mean.
  1659. */
  1660. _RealType
  1661. mean() const
  1662. { return _M_mean; }
  1663. void
  1664. reset()
  1665. { _M_nd.reset(); }
  1666. template<class _UniformRandomNumberGenerator>
  1667. result_type
  1668. operator()(_UniformRandomNumberGenerator& __urng);
  1669. /**
  1670. * Inserts a %poisson_distribution random number distribution
  1671. * @p __x into the output stream @p __os.
  1672. *
  1673. * @param __os An output stream.
  1674. * @param __x A %poisson_distribution random number distribution.
  1675. *
  1676. * @returns The output stream with the state of @p __x inserted or in
  1677. * an error state.
  1678. */
  1679. template<typename _IntType1, typename _RealType1,
  1680. typename _CharT, typename _Traits>
  1681. friend std::basic_ostream<_CharT, _Traits>&
  1682. operator<<(std::basic_ostream<_CharT, _Traits>& __os,
  1683. const poisson_distribution<_IntType1, _RealType1>& __x);
  1684. /**
  1685. * Extracts a %poisson_distribution random number distribution
  1686. * @p __x from the input stream @p __is.
  1687. *
  1688. * @param __is An input stream.
  1689. * @param __x A %poisson_distribution random number generator engine.
  1690. *
  1691. * @returns The input stream with @p __x extracted or in an error state.
  1692. */
  1693. template<typename _IntType1, typename _RealType1,
  1694. typename _CharT, typename _Traits>
  1695. friend std::basic_istream<_CharT, _Traits>&
  1696. operator>>(std::basic_istream<_CharT, _Traits>& __is,
  1697. poisson_distribution<_IntType1, _RealType1>& __x);
  1698. private:
  1699. void
  1700. _M_initialize();
  1701. // NB: Unused when _GLIBCXX_USE_C99_MATH_TR1 is undefined.
  1702. normal_distribution<_RealType> _M_nd;
  1703. _RealType _M_mean;
  1704. // Hosts either log(mean) or the threshold of the simple method.
  1705. _RealType _M_lm_thr;
  1706. #if _GLIBCXX_USE_C99_MATH_TR1
  1707. _RealType _M_lfm, _M_sm, _M_d, _M_scx, _M_1cx, _M_c2b, _M_cb;
  1708. #endif
  1709. };
  1710. /**
  1711. * @brief A discrete binomial random number distribution.
  1712. *
  1713. * The formula for the binomial probability mass function is
  1714. * @f$ p(i) = \binom{n}{i} p^i (1 - p)^{t - i} @f$ where @f$ t @f$
  1715. * and @f$ p @f$ are the parameters of the distribution.
  1716. */
  1717. template<typename _IntType = int, typename _RealType = double>
  1718. class binomial_distribution
  1719. {
  1720. public:
  1721. // types
  1722. typedef _RealType input_type;
  1723. typedef _IntType result_type;
  1724. // constructors and member function
  1725. explicit
  1726. binomial_distribution(_IntType __t = 1,
  1727. const _RealType& __p = _RealType(0.5))
  1728. : _M_t(__t), _M_p(__p), _M_nd()
  1729. {
  1730. _GLIBCXX_DEBUG_ASSERT((_M_t >= 0) && (_M_p >= 0.0) && (_M_p <= 1.0));
  1731. _M_initialize();
  1732. }
  1733. /**
  1734. * Gets the distribution @p t parameter.
  1735. */
  1736. _IntType
  1737. t() const
  1738. { return _M_t; }
  1739. /**
  1740. * Gets the distribution @p p parameter.
  1741. */
  1742. _RealType
  1743. p() const
  1744. { return _M_p; }
  1745. void
  1746. reset()
  1747. { _M_nd.reset(); }
  1748. template<class _UniformRandomNumberGenerator>
  1749. result_type
  1750. operator()(_UniformRandomNumberGenerator& __urng);
  1751. /**
  1752. * Inserts a %binomial_distribution random number distribution
  1753. * @p __x into the output stream @p __os.
  1754. *
  1755. * @param __os An output stream.
  1756. * @param __x A %binomial_distribution random number distribution.
  1757. *
  1758. * @returns The output stream with the state of @p __x inserted or in
  1759. * an error state.
  1760. */
  1761. template<typename _IntType1, typename _RealType1,
  1762. typename _CharT, typename _Traits>
  1763. friend std::basic_ostream<_CharT, _Traits>&
  1764. operator<<(std::basic_ostream<_CharT, _Traits>& __os,
  1765. const binomial_distribution<_IntType1, _RealType1>& __x);
  1766. /**
  1767. * Extracts a %binomial_distribution random number distribution
  1768. * @p __x from the input stream @p __is.
  1769. *
  1770. * @param __is An input stream.
  1771. * @param __x A %binomial_distribution random number generator engine.
  1772. *
  1773. * @returns The input stream with @p __x extracted or in an error state.
  1774. */
  1775. template<typename _IntType1, typename _RealType1,
  1776. typename _CharT, typename _Traits>
  1777. friend std::basic_istream<_CharT, _Traits>&
  1778. operator>>(std::basic_istream<_CharT, _Traits>& __is,
  1779. binomial_distribution<_IntType1, _RealType1>& __x);
  1780. private:
  1781. void
  1782. _M_initialize();
  1783. template<class _UniformRandomNumberGenerator>
  1784. result_type
  1785. _M_waiting(_UniformRandomNumberGenerator& __urng, _IntType __t);
  1786. // NB: Unused when _GLIBCXX_USE_C99_MATH_TR1 is undefined.
  1787. normal_distribution<_RealType> _M_nd;
  1788. _RealType _M_q;
  1789. #if _GLIBCXX_USE_C99_MATH_TR1
  1790. _RealType _M_d1, _M_d2, _M_s1, _M_s2, _M_c,
  1791. _M_a1, _M_a123, _M_s, _M_lf, _M_lp1p;
  1792. #endif
  1793. _RealType _M_p;
  1794. _IntType _M_t;
  1795. bool _M_easy;
  1796. };
  1797. /* @} */ // group tr1_random_distributions_discrete
  1798. /**
  1799. * @addtogroup tr1_random_distributions_continuous Continuous Distributions
  1800. * @ingroup tr1_random_distributions
  1801. * @{
  1802. */
  1803. /**
  1804. * @brief Uniform continuous distribution for random numbers.
  1805. *
  1806. * A continuous random distribution on the range [min, max) with equal
  1807. * probability throughout the range. The URNG should be real-valued and
  1808. * deliver number in the range [0, 1).
  1809. */
  1810. template<typename _RealType = double>
  1811. class uniform_real
  1812. {
  1813. public:
  1814. // types
  1815. typedef _RealType input_type;
  1816. typedef _RealType result_type;
  1817. public:
  1818. /**
  1819. * Constructs a uniform_real object.
  1820. *
  1821. * @param __min [IN] The lower bound of the distribution.
  1822. * @param __max [IN] The upper bound of the distribution.
  1823. */
  1824. explicit
  1825. uniform_real(_RealType __min = _RealType(0),
  1826. _RealType __max = _RealType(1))
  1827. : _M_min(__min), _M_max(__max)
  1828. {
  1829. _GLIBCXX_DEBUG_ASSERT(_M_min <= _M_max);
  1830. }
  1831. result_type
  1832. min() const
  1833. { return _M_min; }
  1834. result_type
  1835. max() const
  1836. { return _M_max; }
  1837. void
  1838. reset() { }
  1839. template<class _UniformRandomNumberGenerator>
  1840. result_type
  1841. operator()(_UniformRandomNumberGenerator& __urng)
  1842. { return (__urng() * (_M_max - _M_min)) + _M_min; }
  1843. /**
  1844. * Inserts a %uniform_real random number distribution @p __x into the
  1845. * output stream @p __os.
  1846. *
  1847. * @param __os An output stream.
  1848. * @param __x A %uniform_real random number distribution.
  1849. *
  1850. * @returns The output stream with the state of @p __x inserted or in
  1851. * an error state.
  1852. */
  1853. template<typename _RealType1, typename _CharT, typename _Traits>
  1854. friend std::basic_ostream<_CharT, _Traits>&
  1855. operator<<(std::basic_ostream<_CharT, _Traits>& __os,
  1856. const uniform_real<_RealType1>& __x);
  1857. /**
  1858. * Extracts a %uniform_real random number distribution
  1859. * @p __x from the input stream @p __is.
  1860. *
  1861. * @param __is An input stream.
  1862. * @param __x A %uniform_real random number generator engine.
  1863. *
  1864. * @returns The input stream with @p __x extracted or in an error state.
  1865. */
  1866. template<typename _RealType1, typename _CharT, typename _Traits>
  1867. friend std::basic_istream<_CharT, _Traits>&
  1868. operator>>(std::basic_istream<_CharT, _Traits>& __is,
  1869. uniform_real<_RealType1>& __x);
  1870. private:
  1871. _RealType _M_min;
  1872. _RealType _M_max;
  1873. };
  1874. /**
  1875. * @brief An exponential continuous distribution for random numbers.
  1876. *
  1877. * The formula for the exponential probability mass function is
  1878. * @f$ p(x) = \lambda e^{-\lambda x} @f$.
  1879. *
  1880. * <table border=1 cellpadding=10 cellspacing=0>
  1881. * <caption align=top>Distribution Statistics</caption>
  1882. * <tr><td>Mean</td><td>@f$ \frac{1}{\lambda} @f$</td></tr>
  1883. * <tr><td>Median</td><td>@f$ \frac{\ln 2}{\lambda} @f$</td></tr>
  1884. * <tr><td>Mode</td><td>@f$ zero @f$</td></tr>
  1885. * <tr><td>Range</td><td>@f$[0, \infty]@f$</td></tr>
  1886. * <tr><td>Standard Deviation</td><td>@f$ \frac{1}{\lambda} @f$</td></tr>
  1887. * </table>
  1888. */
  1889. template<typename _RealType = double>
  1890. class exponential_distribution
  1891. {
  1892. public:
  1893. // types
  1894. typedef _RealType input_type;
  1895. typedef _RealType result_type;
  1896. public:
  1897. /**
  1898. * Constructs an exponential distribution with inverse scale parameter
  1899. * @f$ \lambda @f$.
  1900. */
  1901. explicit
  1902. exponential_distribution(const result_type& __lambda = result_type(1))
  1903. : _M_lambda(__lambda)
  1904. {
  1905. _GLIBCXX_DEBUG_ASSERT(_M_lambda > 0);
  1906. }
  1907. /**
  1908. * Gets the inverse scale parameter of the distribution.
  1909. */
  1910. _RealType
  1911. lambda() const
  1912. { return _M_lambda; }
  1913. /**
  1914. * Resets the distribution.
  1915. *
  1916. * Has no effect on exponential distributions.
  1917. */
  1918. void
  1919. reset() { }
  1920. template<class _UniformRandomNumberGenerator>
  1921. result_type
  1922. operator()(_UniformRandomNumberGenerator& __urng)
  1923. { return -std::log(__urng()) / _M_lambda; }
  1924. /**
  1925. * Inserts a %exponential_distribution random number distribution
  1926. * @p __x into the output stream @p __os.
  1927. *
  1928. * @param __os An output stream.
  1929. * @param __x A %exponential_distribution random number distribution.
  1930. *
  1931. * @returns The output stream with the state of @p __x inserted or in
  1932. * an error state.
  1933. */
  1934. template<typename _RealType1, typename _CharT, typename _Traits>
  1935. friend std::basic_ostream<_CharT, _Traits>&
  1936. operator<<(std::basic_ostream<_CharT, _Traits>& __os,
  1937. const exponential_distribution<_RealType1>& __x);
  1938. /**
  1939. * Extracts a %exponential_distribution random number distribution
  1940. * @p __x from the input stream @p __is.
  1941. *
  1942. * @param __is An input stream.
  1943. * @param __x A %exponential_distribution random number
  1944. * generator engine.
  1945. *
  1946. * @returns The input stream with @p __x extracted or in an error state.
  1947. */
  1948. template<typename _CharT, typename _Traits>
  1949. friend std::basic_istream<_CharT, _Traits>&
  1950. operator>>(std::basic_istream<_CharT, _Traits>& __is,
  1951. exponential_distribution& __x)
  1952. { return __is >> __x._M_lambda; }
  1953. private:
  1954. result_type _M_lambda;
  1955. };
  1956. /**
  1957. * @brief A normal continuous distribution for random numbers.
  1958. *
  1959. * The formula for the normal probability mass function is
  1960. * @f$ p(x) = \frac{1}{\sigma \sqrt{2 \pi}}
  1961. * e^{- \frac{{x - mean}^ {2}}{2 \sigma ^ {2}} } @f$.
  1962. */
  1963. template<typename _RealType = double>
  1964. class normal_distribution
  1965. {
  1966. public:
  1967. // types
  1968. typedef _RealType input_type;
  1969. typedef _RealType result_type;
  1970. public:
  1971. /**
  1972. * Constructs a normal distribution with parameters @f$ mean @f$ and
  1973. * @f$ \sigma @f$.
  1974. */
  1975. explicit
  1976. normal_distribution(const result_type& __mean = result_type(0),
  1977. const result_type& __sigma = result_type(1))
  1978. : _M_mean(__mean), _M_sigma(__sigma), _M_saved_available(false)
  1979. {
  1980. _GLIBCXX_DEBUG_ASSERT(_M_sigma > 0);
  1981. }
  1982. /**
  1983. * Gets the mean of the distribution.
  1984. */
  1985. _RealType
  1986. mean() const
  1987. { return _M_mean; }
  1988. /**
  1989. * Gets the @f$ \sigma @f$ of the distribution.
  1990. */
  1991. _RealType
  1992. sigma() const
  1993. { return _M_sigma; }
  1994. /**
  1995. * Resets the distribution.
  1996. */
  1997. void
  1998. reset()
  1999. { _M_saved_available = false; }
  2000. template<class _UniformRandomNumberGenerator>
  2001. result_type
  2002. operator()(_UniformRandomNumberGenerator& __urng);
  2003. /**
  2004. * Inserts a %normal_distribution random number distribution
  2005. * @p __x into the output stream @p __os.
  2006. *
  2007. * @param __os An output stream.
  2008. * @param __x A %normal_distribution random number distribution.
  2009. *
  2010. * @returns The output stream with the state of @p __x inserted or in
  2011. * an error state.
  2012. */
  2013. template<typename _RealType1, typename _CharT, typename _Traits>
  2014. friend std::basic_ostream<_CharT, _Traits>&
  2015. operator<<(std::basic_ostream<_CharT, _Traits>& __os,
  2016. const normal_distribution<_RealType1>& __x);
  2017. /**
  2018. * Extracts a %normal_distribution random number distribution
  2019. * @p __x from the input stream @p __is.
  2020. *
  2021. * @param __is An input stream.
  2022. * @param __x A %normal_distribution random number generator engine.
  2023. *
  2024. * @returns The input stream with @p __x extracted or in an error state.
  2025. */
  2026. template<typename _RealType1, typename _CharT, typename _Traits>
  2027. friend std::basic_istream<_CharT, _Traits>&
  2028. operator>>(std::basic_istream<_CharT, _Traits>& __is,
  2029. normal_distribution<_RealType1>& __x);
  2030. private:
  2031. result_type _M_mean;
  2032. result_type _M_sigma;
  2033. result_type _M_saved;
  2034. bool _M_saved_available;
  2035. };
  2036. /**
  2037. * @brief A gamma continuous distribution for random numbers.
  2038. *
  2039. * The formula for the gamma probability mass function is
  2040. * @f$ p(x) = \frac{1}{\Gamma(\alpha)} x^{\alpha - 1} e^{-x} @f$.
  2041. */
  2042. template<typename _RealType = double>
  2043. class gamma_distribution
  2044. {
  2045. public:
  2046. // types
  2047. typedef _RealType input_type;
  2048. typedef _RealType result_type;
  2049. public:
  2050. /**
  2051. * Constructs a gamma distribution with parameters @f$ \alpha @f$.
  2052. */
  2053. explicit
  2054. gamma_distribution(const result_type& __alpha_val = result_type(1))
  2055. : _M_alpha(__alpha_val)
  2056. {
  2057. _GLIBCXX_DEBUG_ASSERT(_M_alpha > 0);
  2058. _M_initialize();
  2059. }
  2060. /**
  2061. * Gets the @f$ \alpha @f$ of the distribution.
  2062. */
  2063. _RealType
  2064. alpha() const
  2065. { return _M_alpha; }
  2066. /**
  2067. * Resets the distribution.
  2068. */
  2069. void
  2070. reset() { }
  2071. template<class _UniformRandomNumberGenerator>
  2072. result_type
  2073. operator()(_UniformRandomNumberGenerator& __urng);
  2074. /**
  2075. * Inserts a %gamma_distribution random number distribution
  2076. * @p __x into the output stream @p __os.
  2077. *
  2078. * @param __os An output stream.
  2079. * @param __x A %gamma_distribution random number distribution.
  2080. *
  2081. * @returns The output stream with the state of @p __x inserted or in
  2082. * an error state.
  2083. */
  2084. template<typename _RealType1, typename _CharT, typename _Traits>
  2085. friend std::basic_ostream<_CharT, _Traits>&
  2086. operator<<(std::basic_ostream<_CharT, _Traits>& __os,
  2087. const gamma_distribution<_RealType1>& __x);
  2088. /**
  2089. * Extracts a %gamma_distribution random number distribution
  2090. * @p __x from the input stream @p __is.
  2091. *
  2092. * @param __is An input stream.
  2093. * @param __x A %gamma_distribution random number generator engine.
  2094. *
  2095. * @returns The input stream with @p __x extracted or in an error state.
  2096. */
  2097. template<typename _CharT, typename _Traits>
  2098. friend std::basic_istream<_CharT, _Traits>&
  2099. operator>>(std::basic_istream<_CharT, _Traits>& __is,
  2100. gamma_distribution& __x)
  2101. {
  2102. __is >> __x._M_alpha;
  2103. __x._M_initialize();
  2104. return __is;
  2105. }
  2106. private:
  2107. void
  2108. _M_initialize();
  2109. result_type _M_alpha;
  2110. // Hosts either lambda of GB or d of modified Vaduva's.
  2111. result_type _M_l_d;
  2112. };
  2113. /* @} */ // group tr1_random_distributions_continuous
  2114. /* @} */ // group tr1_random_distributions
  2115. /* @} */ // group tr1_random
  2116. }
  2117. _GLIBCXX_END_NAMESPACE_VERSION
  2118. }
  2119. #endif // _GLIBCXX_TR1_RANDOM_H