← Back to branch summary

~ubuntu-branches/ubuntu/trusty/bmagic/trusty-proposed

« back to all changes in this revision

Viewing changes to doc/html/a00079.html

  • Committer: Bazaar Package Importer
  • Author(s): Roberto C. Sanchez
  • Date: 2010-04-08 16:47:58 UTC
  • mfrom: (4.1.7 sid)
  • Revision ID: james.westby@ubuntu.com-20100408164758-3vu6wmrk1dnzqnnj
Tags: 3.6.4-1
* New upstream release
* Update to Standards-Version 3.8.4 (no changes)

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/a00079.html
2
2
<html xmlns="http://www.w3.org/1999/xhtml">
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5
 
<title>BitMagic: bm::random_subset&lt; BV &gt; Class Template Reference</title>
 
5
<title>BitMagic: bm::ptr_guard&lt; T &gt; Class Template Reference</title>
6
6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
7
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
8
8
</head>
27
27
      <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
28
28
    </ul>
29
29
  </div>
30
 
  <div class="navpath"><a class="el" href="a00115.html">bm</a>::<a class="el" href="a00079.html">random_subset</a>
 
30
  <div class="navpath"><a class="el" href="a00116.html">bm</a>::<a class="el" href="a00079.html">ptr_guard</a>
31
31
  </div>
32
32
</div>
33
33
<div class="contents">
34
 
<h1>bm::random_subset&lt; BV &gt; Class Template Reference<br/>
35
 
<small>
36
 
[<a class="el" href="a00124.html">Set algorithms</a>]</small>
37
 
</h1><!-- doxytag: class="bm::random_subset" -->
38
 
<p><code>#include &lt;<a class="el" href="a00095_source.html">bmrandom.h</a>&gt;</code></p>
 
34
<h1>bm::ptr_guard&lt; T &gt; Class Template Reference</h1><!-- doxytag: class="bm::ptr_guard" -->
 
35
<p>Mini auto-pointer for internal memory management.  
 
36
<a href="#_details">More...</a></p>
 
37
 
 
38
<p><code>#include &lt;<a class="el" href="a00103_source.html">bmutil.h</a>&gt;</code></p>
39
39
<table border="0" cellpadding="0" cellspacing="0">
40
40
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
41
 
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00079.html#ab47431e0fe23053d0dc5d3799822c109">random_subset</a> ()</td></tr>
42
 
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00079.html#a6cd4b5521110aad7f8c8511b88d11bff">~random_subset</a> ()</td></tr>
43
 
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00079.html#addbc2e7ae5308fed4c92da441b236ce4">sample</a> (BV &amp;bv_out, const BV &amp;bv_in, unsigned count)</td></tr>
44
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get random subset of input vector.  <a href="#addbc2e7ae5308fed4c92da441b236ce4"></a><br/></td></tr>
 
41
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00079.html#abc96b2ee795bd9353fdf6eab39e29ebc">ptr_guard</a> (T *p)</td></tr>
 
42
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00079.html#a0c99d726c78b751315eb3450108f236b">~ptr_guard</a> ()</td></tr>
45
43
</table>
46
44
<hr/><a name="_details"></a><h2>Detailed Description</h2>
47
 
<h3>template&lt;class BV&gt;<br/>
48
 
 class bm::random_subset&lt; BV &gt;</h3>
49
 
 
50
 
<p>Class implements algorithm for random subset generation.</p>
51
 
<p>Implemented method tries to be fair, but doesn't guarantee true randomeness.</p>
52
 
<p>Performace note: Class holds temporary buffers and variables, so it is recommended to re-use instances over multiple calls. </p>
53
 
<dl><dt><b>Examples: </b></dt><dd>
54
 
<p><a class="el" href="a00010.html#_a4">sample10.cpp</a>.</p>
55
 
</dd>
56
 
</dl>
57
 
<p>Definition at line <a class="el" href="a00095_source.html#l00053">53</a> of file <a class="el" href="a00095_source.html">bmrandom.h</a>.</p>
 
45
<h3>template&lt;class T&gt;<br/>
 
46
 class bm::ptr_guard&lt; T &gt;</h3>
 
47
 
 
48
<p>Mini auto-pointer for internal memory management. </p>
 
49
 
 
50
<p>Definition at line <a class="el" href="a00103_source.html#l00096">96</a> of file <a class="el" href="a00103_source.html">bmutil.h</a>.</p>
58
51
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
59
 
<a class="anchor" id="ab47431e0fe23053d0dc5d3799822c109"></a><!-- doxytag: member="bm::random_subset::random_subset" ref="ab47431e0fe23053d0dc5d3799822c109" args="()" -->
60
 
<div class="memitem">
61
 
<div class="memproto">
62
 
<div class="memtemplate">
63
 
template&lt;class BV &gt; </div>
64
 
      <table class="memname">
65
 
        <tr>
66
 
          <td class="memname"><a class="el" href="a00079.html">bm::random_subset</a>&lt; BV &gt;::<a class="el" href="a00079.html">random_subset</a> </td>
67
 
          <td>(</td>
68
 
          <td class="paramname"></td>
69
 
          <td>&nbsp;)&nbsp;</td>
70
 
          <td><code> [inline]</code></td>
71
 
        </tr>
72
 
      </table>
73
 
</div>
74
 
<div class="memdoc">
75
 
 
76
 
<p>Definition at line <a class="el" href="a00095_source.html#l00115">115</a> of file <a class="el" href="a00095_source.html">bmrandom.h</a>.</p>
77
 
 
78
 
</div>
79
 
</div>
80
 
<a class="anchor" id="a6cd4b5521110aad7f8c8511b88d11bff"></a><!-- doxytag: member="bm::random_subset::~random_subset" ref="a6cd4b5521110aad7f8c8511b88d11bff" args="()" -->
81
 
<div class="memitem">
82
 
<div class="memproto">
83
 
<div class="memtemplate">
84
 
template&lt;class BV &gt; </div>
85
 
      <table class="memname">
86
 
        <tr>
87
 
          <td class="memname"><a class="el" href="a00079.html">bm::random_subset</a>&lt; BV &gt;::~<a class="el" href="a00079.html">random_subset</a> </td>
88
 
          <td>(</td>
89
 
          <td class="paramname"></td>
90
 
          <td>&nbsp;)&nbsp;</td>
91
 
          <td><code> [inline]</code></td>
92
 
        </tr>
93
 
      </table>
94
 
</div>
95
 
<div class="memdoc">
96
 
 
97
 
<p>Definition at line <a class="el" href="a00095_source.html#l00125">125</a> of file <a class="el" href="a00095_source.html">bmrandom.h</a>.</p>
98
 
 
99
 
</div>
100
 
</div>
101
 
<hr/><h2>Member Function Documentation</h2>
102
 
<a class="anchor" id="addbc2e7ae5308fed4c92da441b236ce4"></a><!-- doxytag: member="bm::random_subset::sample" ref="addbc2e7ae5308fed4c92da441b236ce4" args="(BV &amp;bv_out, const BV &amp;bv_in, unsigned count)" -->
103
 
<div class="memitem">
104
 
<div class="memproto">
105
 
<div class="memtemplate">
106
 
template&lt;class BV &gt; </div>
107
 
      <table class="memname">
108
 
        <tr>
109
 
          <td class="memname">void <a class="el" href="a00079.html">bm::random_subset</a>&lt; BV &gt;::sample </td>
110
 
          <td>(</td>
111
 
          <td class="paramtype">BV &amp;&nbsp;</td>
112
 
          <td class="paramname"> <em>bv_out</em>, </td>
113
 
        </tr>
114
 
        <tr>
115
 
          <td class="paramkey"></td>
116
 
          <td></td>
117
 
          <td class="paramtype">const BV &amp;&nbsp;</td>
118
 
          <td class="paramname"> <em>bv_in</em>, </td>
119
 
        </tr>
120
 
        <tr>
121
 
          <td class="paramkey"></td>
122
 
          <td></td>
123
 
          <td class="paramtype">unsigned&nbsp;</td>
124
 
          <td class="paramname"> <em>count</em></td><td>&nbsp;</td>
125
 
        </tr>
126
 
        <tr>
127
 
          <td></td>
128
 
          <td>)</td>
129
 
          <td></td><td></td><td><code> [inline]</code></td>
130
 
        </tr>
131
 
      </table>
132
 
</div>
133
 
<div class="memdoc">
134
 
 
135
 
<p>Get random subset of input vector. </p>
136
 
<dl><dt><b>Parameters:</b></dt><dd>
137
 
  <table border="0" cellspacing="2" cellpadding="0">
138
 
    <tr><td valign="top"></td><td valign="top"><em>bv_out</em>&nbsp;</td><td>- destination vector </td></tr>
139
 
    <tr><td valign="top"></td><td valign="top"><em>bv_in</em>&nbsp;</td><td>- input vector </td></tr>
140
 
    <tr><td valign="top"></td><td valign="top"><em>count</em>&nbsp;</td><td>- number of bits to pick </td></tr>
141
 
  </table>
142
 
  </dd>
143
 
</dl>
144
 
 
145
 
<p>Definition at line <a class="el" href="a00095_source.html#l00134">134</a> of file <a class="el" href="a00095_source.html">bmrandom.h</a>.</p>
146
 
 
147
 
<p>Referenced by <a class="el" href="a00106_source.html#l00050">main()</a>.</p>
 
52
<a class="anchor" id="abc96b2ee795bd9353fdf6eab39e29ebc"></a><!-- doxytag: member="bm::ptr_guard::ptr_guard" ref="abc96b2ee795bd9353fdf6eab39e29ebc" args="(T *p)" -->
 
53
<div class="memitem">
 
54
<div class="memproto">
 
55
<div class="memtemplate">
 
56
template&lt;class T&gt; </div>
 
57
      <table class="memname">
 
58
        <tr>
 
59
          <td class="memname"><a class="el" href="a00079.html">bm::ptr_guard</a>&lt; T &gt;::<a class="el" href="a00079.html">ptr_guard</a> </td>
 
60
          <td>(</td>
 
61
          <td class="paramtype">T *&nbsp;</td>
 
62
          <td class="paramname"> <em>p</em></td>
 
63
          <td>&nbsp;)&nbsp;</td>
 
64
          <td><code> [inline]</code></td>
 
65
        </tr>
 
66
      </table>
 
67
</div>
 
68
<div class="memdoc">
 
69
 
 
70
<p>Definition at line <a class="el" href="a00103_source.html#l00099">99</a> of file <a class="el" href="a00103_source.html">bmutil.h</a>.</p>
 
71
 
 
72
</div>
 
73
</div>
 
74
<a class="anchor" id="a0c99d726c78b751315eb3450108f236b"></a><!-- doxytag: member="bm::ptr_guard::~ptr_guard" ref="a0c99d726c78b751315eb3450108f236b" args="()" -->
 
75
<div class="memitem">
 
76
<div class="memproto">
 
77
<div class="memtemplate">
 
78
template&lt;class T&gt; </div>
 
79
      <table class="memname">
 
80
        <tr>
 
81
          <td class="memname"><a class="el" href="a00079.html">bm::ptr_guard</a>&lt; T &gt;::~<a class="el" href="a00079.html">ptr_guard</a> </td>
 
82
          <td>(</td>
 
83
          <td class="paramname"></td>
 
84
          <td>&nbsp;)&nbsp;</td>
 
85
          <td><code> [inline]</code></td>
 
86
        </tr>
 
87
      </table>
 
88
</div>
 
89
<div class="memdoc">
 
90
 
 
91
<p>Definition at line <a class="el" href="a00103_source.html#l00100">100</a> of file <a class="el" href="a00103_source.html">bmutil.h</a>.</p>
148
92
 
149
93
</div>
150
94
</div>
151
95
<hr/>The documentation for this class was generated from the following file:<ul>
152
 
<li><a class="el" href="a00095_source.html">bmrandom.h</a></li>
 
96
<li><a class="el" href="a00103_source.html">bmutil.h</a></li>
153
97
</ul>
154
98
</div>
155
 
<hr size="1"/><address style="text-align: right;"><small>Generated on Fri Jan 8 20:09:20 2010 for BitMagic by&nbsp;
 
99
<hr size="1"/><address style="text-align: right;"><small>Generated on Tue Mar 23 20:48:14 2010 for BitMagic by&nbsp;
156
100
<a href="http://www.doxygen.org/index.html">
157
101
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
158
102
</body>