1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class template hyperexponential_distribution</title>
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
<link rel="up" href="../../boost_random/reference.html#header.boost.random.hyperexponential_distribution_hpp" title="Header <boost/random/hyperexponential_distribution.hpp>">
<link rel="prev" href="geometric_distribution/param_type.html" title="Class param_type">
<link rel="next" href="hyperexponent_idp735841904/param_type.html" title="Class param_type">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="geometric_distribution/param_type.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_random/reference.html#header.boost.random.hyperexponential_distribution_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="hyperexponent_idp735841904/param_type.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="boost.random.hyperexponent_idp735841904"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class template hyperexponential_distribution</span></h2>
<p>boost::random::hyperexponential_distribution</p>
</div>
<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../boost_random/reference.html#header.boost.random.hyperexponential_distribution_hpp" title="Header <boost/random/hyperexponential_distribution.hpp>">boost/random/hyperexponential_distribution.hpp</a>>
</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> RealT <span class="special">=</span> <span class="keyword">double</span><span class="special">></span>
<span class="keyword">class</span> <a class="link" href="hyperexponent_idp735841904.html" title="Class template hyperexponential_distribution">hyperexponential_distribution</a> <span class="special">{</span>
<span class="keyword">public</span><span class="special">:</span>
<span class="comment">// types</span>
<span class="keyword">typedef</span> <span class="identifier">RealT</span> <a name="boost.random.hyperexponent_idp735841904.result_type"></a><span class="identifier">result_type</span><span class="special">;</span>
<span class="keyword">typedef</span> <span class="identifier">RealT</span> <a name="boost.random.hyperexponent_idp735841904.input_type"></a><span class="identifier">input_type</span><span class="special">;</span>
<span class="comment">// member classes/structs/unions</span>
<span class="keyword">class</span> <a class="link" href="hyperexponent_idp735841904/param_type.html" title="Class param_type">param_type</a> <span class="special">{</span>
<span class="keyword">public</span><span class="special">:</span>
<span class="comment">// types</span>
<span class="keyword">typedef</span> <a class="link" href="hyperexponent_idp735841904.html" title="Class template hyperexponential_distribution">hyperexponential_distribution</a> <a class="link" href="hyperexponent_idp735841904/param_type.html#boost.random.hyperexponent_idp735841904.param_type.distribution_type"><span class="identifier">distribution_type</span></a><span class="special">;</span>
<span class="comment">// <a class="link" href="hyperexponent_idp735841904/param_type.html#boost.random.hyperexponent_idp735841904.param_typeconstruct-copy-destruct">construct/copy/destruct</a></span>
<a class="link" href="hyperexponent_idp735841904/param_type.html#idp735950464-bb"><span class="identifier">param_type</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> ProbIterT<span class="special">,</span> <span class="keyword">typename</span> RateIterT<span class="special">></span>
<a class="link" href="hyperexponent_idp735841904/param_type.html#idp735952096-bb"><span class="identifier">param_type</span></a><span class="special">(</span><span class="identifier">ProbIterT</span><span class="special">,</span> <span class="identifier">ProbIterT</span><span class="special">,</span> <span class="identifier">RateIterT</span><span class="special">,</span> <span class="identifier">RateIterT</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> ProbRangeT<span class="special">,</span> <span class="keyword">typename</span> RateRangeT<span class="special">></span>
<a class="link" href="hyperexponent_idp735841904/param_type.html#idp735967456-bb"><span class="identifier">param_type</span></a><span class="special">(</span><span class="identifier">ProbRangeT</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">RateRangeT</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">disable_if_c</span><span class="special"><</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">has_pre_increment</span><span class="special"><</span> <span class="identifier">ProbRangeT</span> <span class="special">></span><span class="special">::</span><span class="identifier">value</span><span class="special">||</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">has_pre_increment</span><span class="special"><</span> <span class="identifier">RateRangeT</span> <span class="special">></span><span class="special">::</span><span class="identifier">value</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> RateIterT<span class="special">></span>
<a class="link" href="hyperexponent_idp735841904/param_type.html#idp735980832-bb"><span class="identifier">param_type</span></a><span class="special">(</span><span class="identifier">RateIterT</span><span class="special">,</span> <span class="identifier">RateIterT</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">enable_if_c</span><span class="special"><</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">has_pre_increment</span><span class="special"><</span> <span class="identifier">RateIterT</span> <span class="special">></span><span class="special">::</span><span class="identifier">value</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> RateRangeT<span class="special">></span> <a class="link" href="hyperexponent_idp735841904/param_type.html#idp735998576-bb"><span class="identifier">param_type</span></a><span class="special">(</span><span class="identifier">RateRangeT</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
<a class="link" href="hyperexponent_idp735841904/param_type.html#idp736010896-bb"><span class="identifier">param_type</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">initializer_list</span><span class="special"><</span> <span class="identifier">RealT</span> <span class="special">></span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">initializer_list</span><span class="special"><</span> <span class="identifier">RealT</span> <span class="special">></span><span class="special">)</span><span class="special">;</span>
<a class="link" href="hyperexponent_idp735841904/param_type.html#idp736020496-bb"><span class="identifier">param_type</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">initializer_list</span><span class="special"><</span> <span class="identifier">RealT</span> <span class="special">></span><span class="special">)</span><span class="special">;</span>
<span class="comment">// <a class="link" href="hyperexponent_idp735841904/param_type.html#idp735942720-bb">public member functions</a></span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">RealT</span> <span class="special">></span> <a class="link" href="hyperexponent_idp735841904/param_type.html#idp735943280-bb"><span class="identifier">probabilities</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">RealT</span> <span class="special">></span> <a class="link" href="hyperexponent_idp735841904/param_type.html#idp735947136-bb"><span class="identifier">rates</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="comment">// <a class="link" href="hyperexponent_idp735841904/param_type.html#idp736033056-bb">friend functions</a></span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">></span>
<span class="keyword">friend</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span>
<a class="link" href="hyperexponent_idp735841904/param_type.html#idp736033616-bb"><span class="keyword">operator</span><span class="special"><<</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="hyperexponent_idp735841904/param_type.html" title="Class param_type">param_type</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">></span>
<span class="keyword">friend</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span>
<a class="link" href="hyperexponent_idp735841904/param_type.html#idp736039504-bb"><span class="keyword">operator</span><span class="special">>></span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="hyperexponent_idp735841904/param_type.html" title="Class param_type">param_type</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="hyperexponent_idp735841904/param_type.html#idp736045392-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="hyperexponent_idp735841904/param_type.html" title="Class param_type">param_type</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="hyperexponent_idp735841904/param_type.html" title="Class param_type">param_type</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="hyperexponent_idp735841904/param_type.html#idp736048976-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="hyperexponent_idp735841904/param_type.html" title="Class param_type">param_type</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="hyperexponent_idp735841904/param_type.html" title="Class param_type">param_type</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
<span class="special">}</span><span class="special">;</span>
<span class="comment">// <a class="link" href="hyperexponent_idp735841904.html#boost.random.hyperexponent_idp735841904construct-copy-destruct">construct/copy/destruct</a></span>
<a class="link" href="hyperexponent_idp735841904.html#idp736082880-bb"><span class="identifier">hyperexponential_distribution</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> ProbIterT<span class="special">,</span> <span class="keyword">typename</span> RateIterT<span class="special">></span>
<a class="link" href="hyperexponent_idp735841904.html#idp736084512-bb"><span class="identifier">hyperexponential_distribution</span></a><span class="special">(</span><span class="identifier">ProbIterT</span><span class="special">,</span> <span class="identifier">ProbIterT</span><span class="special">,</span> <span class="identifier">RateIterT</span><span class="special">,</span> <span class="identifier">RateIterT</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> ProbRangeT<span class="special">,</span> <span class="keyword">typename</span> RateRangeT<span class="special">></span>
<a class="link" href="hyperexponent_idp735841904.html#idp736099872-bb"><span class="identifier">hyperexponential_distribution</span></a><span class="special">(</span><span class="identifier">ProbRangeT</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">RateRangeT</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">disable_if_c</span><span class="special"><</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">has_pre_increment</span><span class="special"><</span> <span class="identifier">ProbRangeT</span> <span class="special">></span><span class="special">::</span><span class="identifier">value</span><span class="special">||</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">has_pre_increment</span><span class="special"><</span> <span class="identifier">RateRangeT</span> <span class="special">></span><span class="special">::</span><span class="identifier">value</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> RateIterT<span class="special">></span>
<a class="link" href="hyperexponent_idp735841904.html#idp736113248-bb"><span class="identifier">hyperexponential_distribution</span></a><span class="special">(</span><span class="identifier">RateIterT</span><span class="special">,</span> <span class="identifier">RateIterT</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">enable_if_c</span><span class="special"><</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">has_pre_increment</span><span class="special"><</span> <span class="identifier">RateIterT</span> <span class="special">></span><span class="special">::</span><span class="identifier">value</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> RateRangeT<span class="special">></span>
<a class="link" href="hyperexponent_idp735841904.html#idp736130992-bb"><span class="identifier">hyperexponential_distribution</span></a><span class="special">(</span><span class="identifier">RateRangeT</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">explicit</span> <a class="link" href="hyperexponent_idp735841904.html#idp736143312-bb"><span class="identifier">hyperexponential_distribution</span></a><span class="special">(</span><a class="link" href="hyperexponent_idp735841904/param_type.html" title="Class param_type">param_type</a> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
<a class="link" href="hyperexponent_idp735841904.html#idp736146880-bb"><span class="identifier">hyperexponential_distribution</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">initializer_list</span><span class="special"><</span> <span class="identifier">RealT</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span><span class="special">,</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">initializer_list</span><span class="special"><</span> <span class="identifier">RealT</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
<a class="link" href="hyperexponent_idp735841904.html#idp736156480-bb"><span class="identifier">hyperexponential_distribution</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">initializer_list</span><span class="special"><</span> <span class="identifier">RealT</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
<span class="comment">// <a class="link" href="hyperexponent_idp735841904.html#idp736054416-bb">public member functions</a></span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> URNG<span class="special">></span> <span class="identifier">RealT</span> <a class="link" href="hyperexponent_idp735841904.html#idp736054976-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">URNG</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> URNG<span class="special">></span> <span class="identifier">RealT</span> <a class="link" href="hyperexponent_idp735841904.html#idp736060544-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">URNG</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="hyperexponent_idp735841904/param_type.html" title="Class param_type">param_type</a> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="hyperexponent_idp735841904.html#idp736068640-bb"><span class="identifier">num_phases</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">RealT</span> <span class="special">></span> <a class="link" href="hyperexponent_idp735841904.html#idp736070208-bb"><span class="identifier">probabilities</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">RealT</span> <span class="special">></span> <a class="link" href="hyperexponent_idp735841904.html#idp736072224-bb"><span class="identifier">rates</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="identifier">RealT</span> <a class="link" href="hyperexponent_idp735841904.html#idp736074224-bb"><span class="identifier">min</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="identifier">RealT</span> <a class="link" href="hyperexponent_idp735841904.html#idp736075808-bb"><span class="identifier">max</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<a class="link" href="hyperexponent_idp735841904/param_type.html" title="Class param_type">param_type</a> <a class="link" href="hyperexponent_idp735841904.html#idp736077392-bb"><span class="identifier">param</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">void</span> <a class="link" href="hyperexponent_idp735841904.html#idp736079088-bb"><span class="identifier">param</span></a><span class="special">(</span><a class="link" href="hyperexponent_idp735841904/param_type.html" title="Class param_type">param_type</a> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">void</span> <a class="link" href="hyperexponent_idp735841904.html#idp736081360-bb"><span class="identifier">reset</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="comment">// <a class="link" href="hyperexponent_idp735841904.html#idp736169040-bb">friend functions</a></span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">></span>
<span class="keyword">friend</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span>
<a class="link" href="hyperexponent_idp735841904.html#idp736169600-bb"><span class="keyword">operator</span><span class="special"><<</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span>
<span class="keyword">const</span> <a class="link" href="hyperexponent_idp735841904.html" title="Class template hyperexponential_distribution">hyperexponential_distribution</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">></span>
<span class="keyword">friend</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span>
<a class="link" href="hyperexponent_idp735841904.html#idp736175504-bb"><span class="keyword">operator</span><span class="special">>></span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span>
<span class="keyword">const</span> <a class="link" href="hyperexponent_idp735841904.html" title="Class template hyperexponential_distribution">hyperexponential_distribution</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="hyperexponent_idp735841904.html#idp736181408-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="hyperexponent_idp735841904.html" title="Class template hyperexponential_distribution">hyperexponential_distribution</a> <span class="special">&</span><span class="special">,</span>
<span class="keyword">const</span> <a class="link" href="hyperexponent_idp735841904.html" title="Class template hyperexponential_distribution">hyperexponential_distribution</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="hyperexponent_idp735841904.html#idp736185936-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="hyperexponent_idp735841904.html" title="Class template hyperexponential_distribution">hyperexponential_distribution</a> <span class="special">&</span><span class="special">,</span>
<span class="keyword">const</span> <a class="link" href="hyperexponent_idp735841904.html" title="Class template hyperexponential_distribution">hyperexponential_distribution</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
<a name="idp480186208"></a><h2>Description</h2>
<p>The hyperexponential distribution is a real-valued continuous distribution with two parameters, the <span class="emphasis"><em>phase probability vector</em></span> <code class="computeroutput">probs</code> and the <span class="emphasis"><em>rate vector</em></span> <code class="computeroutput">rates</code>.</p>
<p>A <span class="inlinemediaobject"><img src="../../images/random//form_15.png"></span>-phase hyperexponential distribution is a mixture of <span class="inlinemediaobject"><img src="../../images/random//form_15.png"></span> exponential distributions. For this reason, it is also referred to as <span class="emphasis"><em>mixed exponential distribution</em></span> or <span class="emphasis"><em>parallel <span class="inlinemediaobject"><img src="../../images/random//form_15.png"></span>-phase exponential distribution</em></span>.</p>
<p>A <span class="inlinemediaobject"><img src="../../images/random//form_15.png"></span>-phase hyperexponential distribution is characterized by two parameters, namely a <span class="emphasis"><em>phase probability vector</em></span> <span class="inlinemediaobject"><img src="../../images/random//form_16.png"></span> and a <span class="emphasis"><em>rate vector</em></span> <span class="inlinemediaobject"><img src="../../images/random//form_17.png"></span>.</p>
<p>A <span class="inlinemediaobject"><img src="../../images/random//form_15.png"></span>-phase hyperexponential distribution is frequently used in <span class="emphasis"><em>queueing theory</em></span> to model the distribution of the superposition of <span class="inlinemediaobject"><img src="../../images/random//form_15.png"></span> independent events, like, for instance, the service time distribution of a queueing station with <span class="inlinemediaobject"><img src="../../images/random//form_15.png"></span> servers in parallel where the <span class="inlinemediaobject"><img src="../../images/random//form_18.png"></span>-th server is chosen with probability <span class="inlinemediaobject"><img src="../../images/random//form_19.png"></span> and its service time distribution is an exponential distribution with rate <span class="inlinemediaobject"><img src="../../images/random//form_20.png"></span> (Allen,1990; Papadopolous et al.,1993; Trivedi,2002).</p>
<p>For instance, CPUs service-time distribution in a computing system has often been observed to possess such a distribution (Rosin,1965). Also, the arrival of different types of customer to a single queueing station is often modeled as a hyperexponential distribution (Papadopolous et al.,1993). Similarly, if a product manufactured in several parallel assemply lines and the outputs are merged, the failure density of the overall product is likely to be hyperexponential (Trivedi,2002).</p>
<p>Finally, since the hyperexponential distribution exhibits a high Coefficient of Variation (CoV), that is a CoV > 1, it is especially suited to fit empirical data with large CoV (Feitelson,2014; Wolski et al.,2013) and to approximate <span class="emphasis"><em>long-tail probability distributions</em></span> (Feldmann et al.,1998).</p>
<p>See (Boost,2014) for more information and examples.</p>
<p>A <span class="inlinemediaobject"><img src="../../images/random//form_15.png"></span>-phase hyperexponential distribution has a probability density function </p>
<div class="equation">
<a name="idp480226496"></a><p class="title"><b>Equation 33.1. </b></p>
<div class="equation-contents"><div class="mediaobject" align="center"><img src="../../images/random//form_21.png" align="middle"></div></div>
</div>
<p><br class="equation-break"> where:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p><span class="inlinemediaobject"><img src="../../images/random//form_15.png"></span> is the <span class="emphasis"><em>number of phases</em></span> and also the size of the input vector parameters,</p></li>
<li class="listitem"><p><span class="inlinemediaobject"><img src="../../images/random//form_16.png"></span> is the <span class="emphasis"><em>phase probability vector</em></span> parameter, and</p></li>
<li class="listitem"><p><span class="inlinemediaobject"><img src="../../images/random//form_17.png"></span> is the <span class="emphasis"><em>rate vector</em></span> parameter.</p></li>
</ul></div>
<p>
Given a <span class="inlinemediaobject"><img src="../../images/random//form_15.png"></span>-phase hyperexponential distribution with phase probability vector <span class="inlinemediaobject"><img src="../../images/random//form_22.png"></span> and rate vector <span class="inlinemediaobject"><img src="../../images/random//form_23.png"></span>, the random variate generation algorithm consists of the following steps (Tyszer,1999):</p>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem"><p>Generate a random variable <span class="inlinemediaobject"><img src="../../images/random//form_24.png"></span> uniformly distribution on the interval <span class="inlinemediaobject"><img src="../../images/random//form_25.png"></span>.</p></li>
<li class="listitem"><p>Use <span class="inlinemediaobject"><img src="../../images/random//form_24.png"></span> to select the appropriate <span class="inlinemediaobject"><img src="../../images/random//form_20.png"></span> (e.g., the <span class="emphasis"><em>alias method</em></span> can possibly be used for this step).</p></li>
<li class="listitem"><p>Generate an exponentially distributed random variable <span class="inlinemediaobject"><img src="../../images/random//form_26.png"></span> with rate parameter <span class="inlinemediaobject"><img src="../../images/random//form_20.png"></span>.</p></li>
<li class="listitem"><p>Return <span class="inlinemediaobject"><img src="../../images/random//form_26.png"></span>.</p></li>
</ol></div>
<p>
References:</p>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem"><p>A.O. Allen, <span class="emphasis"><em>Probability, Statistics, and Queuing Theory with Computer Science Applications, Second Edition</em></span>, Academic Press, 1990.</p></li>
<li class="listitem"><p>Boost C++ Libraries, <span class="emphasis"><em>Boost.Math / Statistical Distributions: Hyperexponential Distribution</em></span>, Online: <a href="http://www.boost.org/doc/libs/release/libs/math/doc/html/dist.html" target="_top">http://www.boost.org/doc/libs/release/libs/math/doc/html/dist.html</a> , 2014.</p></li>
<li class="listitem"><p>D.G. Feitelson, <span class="emphasis"><em>Workload Modeling for Computer Systems Performance Evaluation</em></span>, Cambridge University Press, 2014</p></li>
<li class="listitem"><p>A. Feldmann and W. Whitt, <span class="emphasis"><em>Fitting mixtures of exponentials to long-tail distributions to analyze network performance models</em></span>, Performance Evaluation 31(3-4):245, doi:10.1016/S0166-5316(97)00003-5, 1998.</p></li>
<li class="listitem"><p>H.T. Papadopolous, C. Heavey and J. Browne, <span class="emphasis"><em>Queueing Theory in Manufacturing Systems Analysis and Design</em></span>, Chapman & Hall/CRC, 1993, p. 35.</p></li>
<li class="listitem"><p>R.F. Rosin, <span class="emphasis"><em>Determining a computing center environment</em></span>, Communications of the ACM 8(7):463-468, 1965.</p></li>
<li class="listitem"><p>K.S. Trivedi, <span class="emphasis"><em>Probability and Statistics with Reliability, Queueing, and Computer Science Applications</em></span>, John Wiley & Sons, Inc., 2002.</p></li>
<li class="listitem"><p>J. Tyszer, <span class="emphasis"><em>Object-Oriented Computer Simulation of Discrete-Event Systems</em></span>, Springer, 1999.</p></li>
<li class="listitem"><p>Wikipedia, <span class="emphasis"><em>Hyperexponential Distribution</em></span>, Online: <a href="http://en.wikipedia.org/wiki/Hyperexponential_distribution" target="_top">http://en.wikipedia.org/wiki/Hyperexponential_distribution</a> , 2014.</p></li>
<li class="listitem"><p>Wolfram Mathematica, <span class="emphasis"><em>Hyperexponential Distribution</em></span>, Online: <a href="http://reference.wolfram.com/language/ref/HyperexponentialDistribution.html" target="_top">http://reference.wolfram.com/language/ref/HyperexponentialDistribution.html</a> , 2014.</p></li>
</ol></div>
<p>
</p>
<p>Marco Guazzone (<a href="mailto:marco.guazzone@gmail.com" target="_top">marco.guazzone@gmail.com</a>) </p>
<p>
</p>
<div class="refsect2">
<a name="idp480280400"></a><h3>
<a name="boost.random.hyperexponent_idp735841904construct-copy-destruct"></a><code class="computeroutput">hyperexponential_distribution</code>
public
construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><a name="idp736082880-bb"></a><span class="identifier">hyperexponential_distribution</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Constructs a 1-phase <code class="computeroutput"><code class="computeroutput"><a class="link" href="hyperexponent_idp735841904.html" title="Class template hyperexponential_distribution">hyperexponential_distribution</a></code></code> (i.e., an exponential distribution) with rate 1. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> ProbIterT<span class="special">,</span> <span class="keyword">typename</span> RateIterT<span class="special">></span>
<a name="idp736084512-bb"></a><span class="identifier">hyperexponential_distribution</span><span class="special">(</span><span class="identifier">ProbIterT</span> prob_first<span class="special">,</span> <span class="identifier">ProbIterT</span> prob_last<span class="special">,</span>
<span class="identifier">RateIterT</span> rate_first<span class="special">,</span> <span class="identifier">RateIterT</span> rate_last<span class="special">)</span><span class="special">;</span></pre>
<p>Constructs a <code class="computeroutput"><code class="computeroutput"><a class="link" href="hyperexponent_idp735841904.html" title="Class template hyperexponential_distribution">hyperexponential_distribution</a></code></code> from the <span class="emphasis"><em>phase probability vector</em></span> and <span class="emphasis"><em>rate vector</em></span> parameters of the distribution.</p>
<p>The <span class="emphasis"><em>phase probability vector</em></span> parameter is given by the range defined by [<span class="emphasis"><em>prob_first</em></span>, <span class="emphasis"><em>prob_last</em></span>) iterator pair, and the <span class="emphasis"><em>rate vector</em></span> parameter is given by the range defined by [<span class="emphasis"><em>rate_first</em></span>, <span class="emphasis"><em>rate_last</em></span>) iterator pair.</p>
<p>
References:</p>
<div class="orderedlist"><ol class="orderedlist" type="a"><li class="listitem"><p>ISO, <span class="emphasis"><em>ISO/IEC 14882-2014: Information technology - Programming languages - C++</em></span>, 2014</p></li></ol></div>
<p>
</p>
<div class="variablelist"><table border="0" class="variablelist compact">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0" class="variablelist compact">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="computeroutput">prob_first</code></span></p></td>
<td><p>The iterator to the beginning of the range of non-negative real elements representing the phase probabilities; if elements don't sum to 1, they are normalized. </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">prob_last</code></span></p></td>
<td><p>The iterator to the ending of the range of non-negative real elements representing the phase probabilities; if elements don't sum to 1, they are normalized. </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">rate_first</code></span></p></td>
<td><p>The iterator to the beginning of the range of non-negative real elements representing the rates. </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">rate_last</code></span></p></td>
<td><p>The iterator to the ending of the range of non-negative real elements representing the rates.</p></td>
</tr>
</tbody>
</table></div></td>
</tr>
<tr>
<td><p><span class="term">Template Parameters:</span></p></td>
<td><div class="variablelist"><table border="0" class="variablelist compact">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="computeroutput">ProbIterT</code></span></p></td>
<td><p>Must meet the requirements of <code class="computeroutput">InputIterator</code> concept (ISO,2014,sec. 24.2.3 [input.iterators]). </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">RateIterT</code></span></p></td>
<td><p>Must meet the requirements of <code class="computeroutput">InputIterator</code> concept (ISO,2014,sec. 24.2.3 [input.iterators]).</p></td>
</tr>
</tbody>
</table></div></td>
</tr>
</tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> ProbRangeT<span class="special">,</span> <span class="keyword">typename</span> RateRangeT<span class="special">></span>
<a name="idp736099872-bb"></a><span class="identifier">hyperexponential_distribution</span><span class="special">(</span><span class="identifier">ProbRangeT</span> <span class="keyword">const</span> <span class="special">&</span> prob_range<span class="special">,</span>
<span class="identifier">RateRangeT</span> <span class="keyword">const</span> <span class="special">&</span> rate_range<span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">disable_if_c</span><span class="special"><</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">has_pre_increment</span><span class="special"><</span> <span class="identifier">ProbRangeT</span> <span class="special">></span><span class="special">::</span><span class="identifier">value</span><span class="special">||</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">has_pre_increment</span><span class="special"><</span> <span class="identifier">RateRangeT</span> <span class="special">></span><span class="special">::</span><span class="identifier">value</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre>
<p>Constructs a <code class="computeroutput"><code class="computeroutput"><a class="link" href="hyperexponent_idp735841904.html" title="Class template hyperexponential_distribution">hyperexponential_distribution</a></code></code> from the <span class="emphasis"><em>phase probability vector</em></span> and <span class="emphasis"><em>rate vector</em></span> parameters of the distribution.</p>
<p>The <span class="emphasis"><em>phase probability vector</em></span> parameter is given by the range defined by <span class="emphasis"><em>prob_range</em></span>, and the <span class="emphasis"><em>rate vector</em></span> parameter is given by the range defined by <span class="emphasis"><em>rate_range</em></span>.</p>
<p>
</p>
<div class="note"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top"><p>The final <code class="computeroutput">disable_if</code> parameter is an implementation detail that differentiates between this two argument constructor and the iterator-based two argument constructor described below. </p></td></tr>
</table></div>
<p>
</p>
<div class="variablelist"><table border="0" class="variablelist compact">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0" class="variablelist compact">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="computeroutput">prob_range</code></span></p></td>
<td><p>The range of non-negative real elements representing the phase probabilities; if elements don't sum to 1, they are normalized. </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">rate_range</code></span></p></td>
<td><p>The range of positive real elements representing the rates.</p></td>
</tr>
</tbody>
</table></div></td>
</tr>
<tr>
<td><p><span class="term">Template Parameters:</span></p></td>
<td><div class="variablelist"><table border="0" class="variablelist compact">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="computeroutput">ProbRangeT</code></span></p></td>
<td><p>Must meet the requirements of <a href="../../../../libs/range/doc/html/range/concepts.html" target="_top">Range</a> concept. </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">RateRangeT</code></span></p></td>
<td><p>Must meet the requirements of <a href="../../../../libs/range/doc/html/range/concepts.html" target="_top">Range</a> concept.</p></td>
</tr>
</tbody>
</table></div></td>
</tr>
</tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> RateIterT<span class="special">></span>
<a name="idp736113248-bb"></a><span class="identifier">hyperexponential_distribution</span><span class="special">(</span><span class="identifier">RateIterT</span> rate_first<span class="special">,</span> <span class="identifier">RateIterT</span> rate_last<span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">enable_if_c</span><span class="special"><</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">has_pre_increment</span><span class="special"><</span> <span class="identifier">RateIterT</span> <span class="special">></span><span class="special">::</span><span class="identifier">value</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre>
<p>Constructs a <code class="computeroutput"><code class="computeroutput"><a class="link" href="hyperexponent_idp735841904.html" title="Class template hyperexponential_distribution">hyperexponential_distribution</a></code></code> from the <span class="emphasis"><em>rate vector</em></span> parameter of the distribution and with equal phase probabilities.</p>
<p>The <span class="emphasis"><em>rate vector</em></span> parameter is given by the range defined by [<span class="emphasis"><em>rate_first</em></span>, <span class="emphasis"><em>rate_last</em></span>) iterator pair, and the <span class="emphasis"><em>phase probability vector</em></span> parameter is set to the equal phase probabilities (i.e., to a vector of the same length <span class="inlinemediaobject"><img src="../../images/random//form_15.png"></span> of the <span class="emphasis"><em>rate vector</em></span> and with each element set to <span class="inlinemediaobject"><img src="../../images/random//form_27.png"></span>).</p>
<p>
</p>
<div class="note"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top"><p>The final <code class="computeroutput">disable_if</code> parameter is an implementation detail that differentiates between this two argument constructor and the range-based two argument constructor described above.</p></td></tr>
</table></div>
<p>
References:</p>
<div class="orderedlist"><ol class="orderedlist" type="a"><li class="listitem"><p>ISO, <span class="emphasis"><em>ISO/IEC 14882-2014: Information technology - Programming languages - C++</em></span>, 2014</p></li></ol></div>
<p>
</p>
<div class="variablelist"><table border="0" class="variablelist compact">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0" class="variablelist compact">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="computeroutput">rate_first</code></span></p></td>
<td><p>The iterator to the beginning of the range of non-negative real elements representing the rates. </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">rate_last</code></span></p></td>
<td><p>The iterator to the ending of the range of non-negative real elements representing the rates.</p></td>
</tr>
</tbody>
</table></div></td>
</tr>
<tr>
<td><p><span class="term">Template Parameters:</span></p></td>
<td><div class="variablelist"><table border="0" class="variablelist compact">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><code class="computeroutput">RateIterT</code></span></p></td>
<td><p>Must meet the requirements of <code class="computeroutput">InputIterator</code> concept (ISO,2014,sec. 24.2.3 [input.iterators]). </p></td>
</tr></tbody>
</table></div></td>
</tr>
</tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> RateRangeT<span class="special">></span>
<a name="idp736130992-bb"></a><span class="identifier">hyperexponential_distribution</span><span class="special">(</span><span class="identifier">RateRangeT</span> <span class="keyword">const</span> <span class="special">&</span> rate_range<span class="special">)</span><span class="special">;</span></pre>
<p>Constructs a <code class="computeroutput"><code class="computeroutput"><a class="link" href="hyperexponent_idp735841904/param_type.html" title="Class param_type">param_type</a></code></code> from the "rates" parameters of the distribution and with equal phase probabilities.</p>
<p>The <span class="emphasis"><em>rate vector</em></span> parameter is given by the range defined by <span class="emphasis"><em>rate_range</em></span>, and the <span class="emphasis"><em>phase probability vector</em></span> parameter is set to the equal phase probabilities (i.e., to a vector of the same length <span class="inlinemediaobject"><img src="../../images/random//form_15.png"></span> of the <span class="emphasis"><em>rate vector</em></span> and with each element set to <span class="inlinemediaobject"><img src="../../images/random//form_27.png"></span>).</p>
<p>
</p>
<div class="variablelist"><table border="0" class="variablelist compact">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0" class="variablelist compact">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><code class="computeroutput">rate_range</code></span></p></td>
<td><p>The range of positive real elements representing the rates. </p></td>
</tr></tbody>
</table></div></td>
</tr>
<tr>
<td><p><span class="term">Template Parameters:</span></p></td>
<td><div class="variablelist"><table border="0" class="variablelist compact">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><code class="computeroutput">RateRangeT</code></span></p></td>
<td><p>Must meet the requirements of <a href="../../../../libs/range/doc/html/range/concepts.html" target="_top">Range</a> concept.</p></td>
</tr></tbody>
</table></div></td>
</tr>
</tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp736143312-bb"></a><span class="identifier">hyperexponential_distribution</span><span class="special">(</span><a class="link" href="hyperexponent_idp735841904/param_type.html" title="Class param_type">param_type</a> <span class="keyword">const</span> <span class="special">&</span> param<span class="special">)</span><span class="special">;</span></pre>
<p>Constructs a <code class="computeroutput"><code class="computeroutput"><a class="link" href="hyperexponent_idp735841904.html" title="Class template hyperexponential_distribution">hyperexponential_distribution</a></code></code> from its parameters.</p>
<p>
</p>
<div class="variablelist"><table border="0" class="variablelist compact">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0" class="variablelist compact">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><code class="computeroutput">param</code></span></p></td>
<td><p>The parameters of the distribution. </p></td>
</tr></tbody>
</table></div></td>
</tr></tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><a name="idp736146880-bb"></a><span class="identifier">hyperexponential_distribution</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">initializer_list</span><span class="special"><</span> <span class="identifier">RealT</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> l1<span class="special">,</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">initializer_list</span><span class="special"><</span> <span class="identifier">RealT</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> l2<span class="special">)</span><span class="special">;</span></pre>
<p>Constructs a <code class="computeroutput"><code class="computeroutput"><a class="link" href="hyperexponent_idp735841904.html" title="Class template hyperexponential_distribution">hyperexponential_distribution</a></code></code> from the <span class="emphasis"><em>phase probability vector</em></span> and <span class="emphasis"><em>rate vector</em></span> parameters of the distribution.</p>
<p>The <span class="emphasis"><em>phase probability vector</em></span> parameter is given by the <span class="emphasis"><em>brace-init-list</em></span> (ISO,2014,sec. 8.5.4 [dcl.init.list]) defined by <span class="emphasis"><em>l1</em></span>, and the <span class="emphasis"><em>rate vector</em></span> parameter is given by the <span class="emphasis"><em>brace-init-list</em></span> (ISO,2014,sec. 8.5.4 [dcl.init.list]) defined by <span class="emphasis"><em>l2</em></span>.</p>
<p>
References:</p>
<div class="orderedlist"><ol class="orderedlist" type="a"><li class="listitem"><p>ISO, <span class="emphasis"><em>ISO/IEC 14882-2014: Information technology - Programming languages - C++</em></span>, 2014</p></li></ol></div>
<p>
</p>
<div class="variablelist"><table border="0" class="variablelist compact">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0" class="variablelist compact">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="computeroutput">l1</code></span></p></td>
<td><p>The initializer list for inizializing the phase probability vector. </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">l2</code></span></p></td>
<td><p>The initializer list for inizializing the rate vector.</p></td>
</tr>
</tbody>
</table></div></td>
</tr></tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><a name="idp736156480-bb"></a><span class="identifier">hyperexponential_distribution</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">initializer_list</span><span class="special"><</span> <span class="identifier">RealT</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> l1<span class="special">)</span><span class="special">;</span></pre>
<p>Constructs a <code class="computeroutput"><code class="computeroutput"><a class="link" href="hyperexponent_idp735841904.html" title="Class template hyperexponential_distribution">hyperexponential_distribution</a></code></code> from the <span class="emphasis"><em>rate vector</em></span> parameter of the distribution and with equal phase probabilities.</p>
<p>The <span class="emphasis"><em>rate vector</em></span> parameter is given by the <span class="emphasis"><em>brace-init-list</em></span> (ISO,2014,sec. 8.5.4 [dcl.init.list]) defined by <span class="emphasis"><em>l1</em></span>, and the <span class="emphasis"><em>phase probability vector</em></span> parameter is set to the equal phase probabilities (i.e., to a vector of the same length <span class="inlinemediaobject"><img src="../../images/random//form_15.png"></span> of the <span class="emphasis"><em>rate vector</em></span> and with each element set to <span class="inlinemediaobject"><img src="../../images/random//form_27.png"></span>).</p>
<p>
References:</p>
<div class="orderedlist"><ol class="orderedlist" type="a"><li class="listitem"><p>ISO, <span class="emphasis"><em>ISO/IEC 14882-2014: Information technology - Programming languages - C++</em></span>, 2014</p></li></ol></div>
<p>
</p>
<div class="variablelist"><table border="0" class="variablelist compact">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0" class="variablelist compact">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><code class="computeroutput">l1</code></span></p></td>
<td><p>The initializer list for inizializing the rate vector.</p></td>
</tr></tbody>
</table></div></td>
</tr></tbody>
</table></div>
</li>
</ol></div>
</div>
<div class="refsect2">
<a name="idp480494080"></a><h3>
<a name="idp736054416-bb"></a><code class="computeroutput">hyperexponential_distribution</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> URNG<span class="special">></span> <span class="identifier">RealT</span> <a name="idp736054976-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">URNG</span> <span class="special">&</span> urng<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Gets a random variate distributed according to the hyperexponential distribution.</p>
<p>
</p>
<div class="variablelist"><table border="0" class="variablelist compact">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0" class="variablelist compact">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><code class="computeroutput">urng</code></span></p></td>
<td><p>A uniform random number generator object.</p></td>
</tr></tbody>
</table></div></td>
</tr>
<tr>
<td><p><span class="term">Template Parameters:</span></p></td>
<td><div class="variablelist"><table border="0" class="variablelist compact">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><code class="computeroutput">URNG</code></span></p></td>
<td><p>Must meet the requirements of <a class="link" href="../../boost_random/reference.html#boost_random.reference.concepts.uniform_random_number_generator" title="Uniform Random Number Generator">uniform random number generator</a> .</p></td>
</tr></tbody>
</table></div></td>
</tr>
<tr>
<td><p><span class="term">Returns:</span></p></td>
<td><p>A random variate distributed according to the hyperexponential distribution. </p></td>
</tr>
</tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> URNG<span class="special">></span>
<span class="identifier">RealT</span> <a name="idp736060544-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">URNG</span> <span class="special">&</span> urng<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="hyperexponent_idp735841904/param_type.html" title="Class param_type">param_type</a> <span class="special">&</span> param<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Gets a random variate distributed according to the hyperexponential distribution with parameters specified by <code class="computeroutput">param</code>.</p>
<p>
</p>
<div class="variablelist"><table border="0" class="variablelist compact">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0" class="variablelist compact">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="computeroutput">param</code></span></p></td>
<td><p>A distribution parameter object.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">urng</code></span></p></td>
<td><p>A uniform random number generator object. </p></td>
</tr>
</tbody>
</table></div></td>
</tr>
<tr>
<td><p><span class="term">Template Parameters:</span></p></td>
<td><div class="variablelist"><table border="0" class="variablelist compact">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><code class="computeroutput">URNG</code></span></p></td>
<td><p>Must meet the requirements of <a class="link" href="../../boost_random/reference.html#boost_random.reference.concepts.uniform_random_number_generator" title="Uniform Random Number Generator">uniform random number generator</a> .</p></td>
</tr></tbody>
</table></div></td>
</tr>
<tr>
<td><p><span class="term">Returns:</span></p></td>
<td><p>A random variate distributed according to the hyperexponential distribution. distribution with parameters specified by <code class="computeroutput">param</code>. </p></td>
</tr>
</tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a name="idp736068640-bb"></a><span class="identifier">num_phases</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Returns the number of phases of the distribution. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">RealT</span> <span class="special">></span> <a name="idp736070208-bb"></a><span class="identifier">probabilities</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Returns the <span class="emphasis"><em>phase probability vector</em></span> parameter of the distribution. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">RealT</span> <span class="special">></span> <a name="idp736072224-bb"></a><span class="identifier">rates</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Returns the <span class="emphasis"><em>rate vector</em></span> parameter of the distribution. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">RealT</span> <a name="idp736074224-bb"></a><span class="identifier">min</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Returns the smallest value that the distribution can produce. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">RealT</span> <a name="idp736075808-bb"></a><span class="identifier">max</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Returns the largest value that the distribution can produce. </p>
</li>
<li class="listitem">
<pre class="literallayout"><a class="link" href="hyperexponent_idp735841904/param_type.html" title="Class param_type">param_type</a> <a name="idp736077392-bb"></a><span class="identifier">param</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Returns the parameters of the distribution. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="idp736079088-bb"></a><span class="identifier">param</span><span class="special">(</span><a class="link" href="hyperexponent_idp735841904/param_type.html" title="Class param_type">param_type</a> <span class="keyword">const</span> <span class="special">&</span> param<span class="special">)</span><span class="special">;</span></pre>
<p>Sets the parameters of the distribution. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="idp736081360-bb"></a><span class="identifier">reset</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Effects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset. </p>
</li>
</ol></div>
</div>
<div class="refsect2">
<a name="idp480588944"></a><h3>
<a name="idp736169040-bb"></a><code class="computeroutput">hyperexponential_distribution</code> friend functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">></span>
<span class="keyword">friend</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span>
<a name="idp736169600-bb"></a><span class="keyword">operator</span><span class="special"><<</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span> os<span class="special">,</span>
<span class="keyword">const</span> <a class="link" href="hyperexponent_idp735841904.html" title="Class template hyperexponential_distribution">hyperexponential_distribution</a> <span class="special">&</span> hd<span class="special">)</span><span class="special">;</span></pre>
<p>Writes an <code class="computeroutput"><code class="computeroutput"><a class="link" href="hyperexponent_idp735841904.html" title="Class template hyperexponential_distribution">hyperexponential_distribution</a></code></code> to a <code class="computeroutput">std::ostream</code>. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">></span>
<span class="keyword">friend</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span>
<a name="idp736175504-bb"></a><span class="keyword">operator</span><span class="special">>></span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span> is<span class="special">,</span>
<span class="keyword">const</span> <a class="link" href="hyperexponent_idp735841904.html" title="Class template hyperexponential_distribution">hyperexponential_distribution</a> <span class="special">&</span> hd<span class="special">)</span><span class="special">;</span></pre>
<p>Reads an <code class="computeroutput"><code class="computeroutput"><a class="link" href="hyperexponent_idp735841904.html" title="Class template hyperexponential_distribution">hyperexponential_distribution</a></code></code> from a <code class="computeroutput">std::istream</code>. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="idp736181408-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="hyperexponent_idp735841904.html" title="Class template hyperexponential_distribution">hyperexponential_distribution</a> <span class="special">&</span> lhs<span class="special">,</span>
<span class="keyword">const</span> <a class="link" href="hyperexponent_idp735841904.html" title="Class template hyperexponential_distribution">hyperexponential_distribution</a> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre>
<p>Returns true if the two instances of <code class="computeroutput"><code class="computeroutput"><a class="link" href="hyperexponent_idp735841904.html" title="Class template hyperexponential_distribution">hyperexponential_distribution</a></code></code> will return identical sequences of values given equal generators. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="idp736185936-bb"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="hyperexponent_idp735841904.html" title="Class template hyperexponential_distribution">hyperexponential_distribution</a> <span class="special">&</span> lhs<span class="special">,</span>
<span class="keyword">const</span> <a class="link" href="hyperexponent_idp735841904.html" title="Class template hyperexponential_distribution">hyperexponential_distribution</a> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre>
<p>Returns true if the two instances of <code class="computeroutput"><code class="computeroutput"><a class="link" href="hyperexponent_idp735841904.html" title="Class template hyperexponential_distribution">hyperexponential_distribution</a></code></code> will return different sequences of values given equal generators. </p>
</li>
</ol></div>
</div>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2000-2005 Jens Maurer<br>Copyright © 2009, 2010 Steven Watanabe<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="geometric_distribution/param_type.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_random/reference.html#header.boost.random.hyperexponential_distribution_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="hyperexponent_idp735841904/param_type.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
|
