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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>BitMagic-C++: bm::random_subset< BV > Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">BitMagic-C++
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacebm.html">bm</a></li><li class="navelem"><a class="el" href="classbm_1_1random__subset.html">random_subset</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">bm::random_subset< BV > Class Template Reference<div class="ingroups"><a class="el" href="group__bmagic.html">BitMagic Library</a> » <a class="el" href="group__bvector.html">bvector<> container</a> » <a class="el" href="group__setalgo.html">bvector<> algorithms</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="bmrandom_8h_source.html">bmrandom.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a3e0b204d64051edfc8a8dec0426f553c"><td class="memItemLeft" align="right" valign="top">typedef BV </td><td class="memItemRight" valign="bottom"><a class="el" href="classbm_1_1random__subset.html#a3e0b204d64051edfc8a8dec0426f553c">bvector_type</a></td></tr>
<tr class="separator:a3e0b204d64051edfc8a8dec0426f553c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad8442e900a3e8802f245c9573961d7c2"><td class="memItemLeft" align="right" valign="top">typedef BV::size_type </td><td class="memItemRight" valign="bottom"><a class="el" href="classbm_1_1random__subset.html#ad8442e900a3e8802f245c9573961d7c2">size_type</a></td></tr>
<tr class="separator:ad8442e900a3e8802f245c9573961d7c2"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ab47431e0fe23053d0dc5d3799822c109"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classbm_1_1random__subset.html#ab47431e0fe23053d0dc5d3799822c109">random_subset</a> ()</td></tr>
<tr class="separator:ab47431e0fe23053d0dc5d3799822c109"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6cd4b5521110aad7f8c8511b88d11bff"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classbm_1_1random__subset.html#a6cd4b5521110aad7f8c8511b88d11bff">~random_subset</a> ()</td></tr>
<tr class="separator:a6cd4b5521110aad7f8c8511b88d11bff"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abdf1e716e124ff4d7ad8ccef1646c99e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classbm_1_1random__subset.html#abdf1e716e124ff4d7ad8ccef1646c99e">sample</a> (BV &bv_out, const BV &bv_in, <a class="el" href="classbm_1_1random__subset.html#ad8442e900a3e8802f245c9573961d7c2">size_type</a> sample_count)</td></tr>
<tr class="memdesc:abdf1e716e124ff4d7ad8ccef1646c99e"><td class="mdescLeft"> </td><td class="mdescRight">Get random subset of input vector. <a href="classbm_1_1random__subset.html#abdf1e716e124ff4d7ad8ccef1646c99e">More...</a><br /></td></tr>
<tr class="separator:abdf1e716e124ff4d7ad8ccef1646c99e"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template<class BV><br />
class bm::random_subset< BV ></h3>
<p>Class implements algorithm for random subset generation.</p>
<p>Implemented method tries to be fair, but doesn't guarantee true randomeness or absense of bias.</p>
<p>Performace note: Class holds temporary buffers and variables, so it is recommended to re-use instances over multiple calls. </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="sample10_8cpp-example.html#_a4">sample10.cpp</a>, and <a class="el" href="xsample03_8cpp-example.html#_a25">xsample03.cpp</a>.</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="bmrandom_8h_source.html#l00056">56</a> of file <a class="el" href="bmrandom_8h_source.html">bmrandom.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a3e0b204d64051edfc8a8dec0426f553c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3e0b204d64051edfc8a8dec0426f553c">◆ </a></span>bvector_type</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class BV > </div>
<table class="memname">
<tr>
<td class="memname">typedef BV <a class="el" href="classbm_1_1random__subset.html">bm::random_subset</a>< BV >::<a class="el" href="classbm_1_1random__subset.html#a3e0b204d64051edfc8a8dec0426f553c">bvector_type</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="bmrandom_8h_source.html#l00059">59</a> of file <a class="el" href="bmrandom_8h_source.html">bmrandom.h</a>.</p>
</div>
</div>
<a id="ad8442e900a3e8802f245c9573961d7c2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad8442e900a3e8802f245c9573961d7c2">◆ </a></span>size_type</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class BV > </div>
<table class="memname">
<tr>
<td class="memname">typedef BV::size_type <a class="el" href="classbm_1_1random__subset.html">bm::random_subset</a>< BV >::<a class="el" href="classbm_1_1random__subset.html#ad8442e900a3e8802f245c9573961d7c2">size_type</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="bmrandom_8h_source.html#l00060">60</a> of file <a class="el" href="bmrandom_8h_source.html">bmrandom.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="ab47431e0fe23053d0dc5d3799822c109"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab47431e0fe23053d0dc5d3799822c109">◆ </a></span>random_subset()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class BV > </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classbm_1_1random__subset.html">bm::random_subset</a>< BV >::<a class="el" href="classbm_1_1random__subset.html">random_subset</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="bmrandom_8h_source.html#l00128">128</a> of file <a class="el" href="bmrandom_8h_source.html">bmrandom.h</a>.</p>
<p class="reference">References <a class="el" href="bmconst_8h_source.html#l00054">bm::set_block_size</a>.</p>
</div>
</div>
<a id="a6cd4b5521110aad7f8c8511b88d11bff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6cd4b5521110aad7f8c8511b88d11bff">◆ </a></span>~random_subset()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class BV > </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classbm_1_1random__subset.html">bm::random_subset</a>< BV >::~<a class="el" href="classbm_1_1random__subset.html">random_subset</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="bmrandom_8h_source.html#l00134">134</a> of file <a class="el" href="bmrandom_8h_source.html">bmrandom.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="abdf1e716e124ff4d7ad8ccef1646c99e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abdf1e716e124ff4d7ad8ccef1646c99e">◆ </a></span>sample()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class BV > </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classbm_1_1random__subset.html">bm::random_subset</a>< BV >::sample </td>
<td>(</td>
<td class="paramtype">BV & </td>
<td class="paramname"><em>bv_out</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const BV & </td>
<td class="paramname"><em>bv_in</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classbm_1_1random__subset.html#ad8442e900a3e8802f245c9573961d7c2">size_type</a> </td>
<td class="paramname"><em>sample_count</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get random subset of input vector. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bv_out</td><td>- destination vector </td></tr>
<tr><td class="paramname">bv_in</td><td>- input vector </td></tr>
<tr><td class="paramname">sample_count</td><td>- number of bits to pick </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="bmrandom_8h_source.html#l00140">140</a> of file <a class="el" href="bmrandom_8h_source.html">bmrandom.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="xsample03_8cpp_source.html#l00291">generate_random_subset()</a>, and <a class="el" href="sample10_8cpp_source.html#l00047">main()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="bmrandom_8h_source.html">bmrandom.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
|
