← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/html/a00060.html

  • Committer: Bazaar Package Importer
  • Author(s): Roberto C. Sanchez
  • Date: 2011-03-03 12:22:16 UTC
  • mfrom: (4.1.8 sid)
  • Revision ID: james.westby@ubuntu.com-20110303122216-qll5migewxnxe3s5
Tags: 3.7.0-1
http://bugs.debian.org/615929
* New upstream release (Closes: #615929)
* Update to Standards-Version 3.9.1 (no changes)
* Specify Debian source format as '3.0 (quilt)'

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/a00060.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::bvector&lt; Alloc, MS &gt;::iterator_base::dgap_descr Struct Reference</title>
 
5
<title>BitMagic: bm::distance_metric_descriptor Struct 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="a00116.html">bm</a>::<a class="el" href="a00044.html">bvector</a>::<a class="el" href="a00072.html">iterator_base</a>::<a class="el" href="a00060.html">dgap_descr</a>
 
30
  <div class="navpath"><a class="el" href="a00115.html">bm</a>::<a class="el" href="a00060.html">distance_metric_descriptor</a>
31
31
  </div>
32
32
</div>
33
33
<div class="contents">
34
 
<h1>bm::bvector&lt; Alloc, MS &gt;::iterator_base::dgap_descr Struct Reference</h1><!-- doxytag: class="bm::bvector::iterator_base::dgap_descr" -->
35
 
<p>Information about current DGAP block.  
 
34
<h1>bm::distance_metric_descriptor Struct Reference</h1><!-- doxytag: class="bm::distance_metric_descriptor" -->
 
35
<p>Distance metric descriptor, holds metric code and result.  
36
36
<a href="#_details">More...</a></p>
37
37
 
38
 
<p><code>#include &lt;<a class="el" href="a00088_source.html">bm.h</a>&gt;</code></p>
 
38
<p><code>#include &lt;<a class="el" href="a00089_source.html">bmalgo_impl.h</a>&gt;</code></p>
39
39
<table border="0" cellpadding="0" cellspacing="0">
 
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="a00060.html#ab4cc0e59d35431f9a6fe110b7a1392df">distance_metric_descriptor</a> (<a class="el" href="a00125.html#gac38d64c8b27b652413a664cddd4d40ab">distance_metric</a> m)</td></tr>
 
42
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#a33061afe75bacd27a76abdcffbba65d5">distance_metric_descriptor</a> ()</td></tr>
 
43
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#a30de8a19da0c250c3d3645eb51ea942c">reset</a> ()</td></tr>
 
44
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets metric result to 0.  <a href="#a30de8a19da0c250c3d3645eb51ea942c"></a><br/></td></tr>
40
45
<tr><td colspan="2"><h2>Data Fields</h2></td></tr>
41
 
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="a00116.html#ac654d6319039a86546d235a236fc7cf6">gap_word_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#a06ab78e3b3b9c52de9b491dc2ad3a72f">ptr</a></td></tr>
42
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Word pointer.  <a href="#a06ab78e3b3b9c52de9b491dc2ad3a72f"></a><br/></td></tr>
43
 
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00116.html#ac654d6319039a86546d235a236fc7cf6">gap_word_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#af7766714caa1c9cb00750cd8b91314c2">gap_len</a></td></tr>
44
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Current dgap length.  <a href="#af7766714caa1c9cb00750cd8b91314c2"></a><br/></td></tr>
 
46
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00125.html#gac38d64c8b27b652413a664cddd4d40ab">distance_metric</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#a3ece2ccdb7a6616f06a5a15679ccabb1">metric</a></td></tr>
 
47
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00115.html#aa3824d882a037396370b16f2f0a8bf37">bm::id_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#a94c955fe1ac46589d6edc8df7fd35cf6">result</a></td></tr>
45
48
</table>
46
49
<hr/><a name="_details"></a><h2>Detailed Description</h2>
47
 
<h3>template&lt;class Alloc, class MS&gt;<br/>
48
 
 struct bm::bvector&lt; Alloc, MS &gt;::iterator_base::dgap_descr</h3>
49
 
 
50
 
<p>Information about current DGAP block. </p>
51
 
 
52
 
<p>Definition at line <a class="el" href="a00088_source.html#l00299">299</a> of file <a class="el" href="a00088_source.html">bm.h</a>.</p>
 
50
<p>Distance metric descriptor, holds metric code and result. </p>
 
51
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="a00125.html#ga815fef76f02576ab9ab58de0a45d8a4b" title="Distance computing template function.">distance_operation</a> </dd></dl>
 
52
<dl><dt><b>Examples: </b></dt><dd>
 
53
<p><a class="el" href="a00008.html#_a5">sample9.cpp</a>.</p>
 
54
</dd>
 
55
</dl>
 
56
<p>Definition at line <a class="el" href="a00089_source.html#l00085">85</a> of file <a class="el" href="a00089_source.html">bmalgo_impl.h</a>.</p>
 
57
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
 
58
<a class="anchor" id="ab4cc0e59d35431f9a6fe110b7a1392df"></a><!-- doxytag: member="bm::distance_metric_descriptor::distance_metric_descriptor" ref="ab4cc0e59d35431f9a6fe110b7a1392df" args="(distance_metric m)" -->
 
59
<div class="memitem">
 
60
<div class="memproto">
 
61
      <table class="memname">
 
62
        <tr>
 
63
          <td class="memname">bm::distance_metric_descriptor::distance_metric_descriptor </td>
 
64
          <td>(</td>
 
65
          <td class="paramtype"><a class="el" href="a00125.html#gac38d64c8b27b652413a664cddd4d40ab">distance_metric</a>&nbsp;</td>
 
66
          <td class="paramname"> <em>m</em></td>
 
67
          <td>&nbsp;)&nbsp;</td>
 
68
          <td><code> [inline]</code></td>
 
69
        </tr>
 
70
      </table>
 
71
</div>
 
72
<div class="memdoc">
 
73
 
 
74
<p>Definition at line <a class="el" href="a00089_source.html#l00090">90</a> of file <a class="el" href="a00089_source.html">bmalgo_impl.h</a>.</p>
 
75
 
 
76
</div>
 
77
</div>
 
78
<a class="anchor" id="a33061afe75bacd27a76abdcffbba65d5"></a><!-- doxytag: member="bm::distance_metric_descriptor::distance_metric_descriptor" ref="a33061afe75bacd27a76abdcffbba65d5" args="()" -->
 
79
<div class="memitem">
 
80
<div class="memproto">
 
81
      <table class="memname">
 
82
        <tr>
 
83
          <td class="memname">bm::distance_metric_descriptor::distance_metric_descriptor </td>
 
84
          <td>(</td>
 
85
          <td class="paramname"></td>
 
86
          <td>&nbsp;)&nbsp;</td>
 
87
          <td><code> [inline]</code></td>
 
88
        </tr>
 
89
      </table>
 
90
</div>
 
91
<div class="memdoc">
 
92
 
 
93
<p>Definition at line <a class="el" href="a00089_source.html#l00094">94</a> of file <a class="el" href="a00089_source.html">bmalgo_impl.h</a>.</p>
 
94
 
 
95
</div>
 
96
</div>
 
97
<hr/><h2>Member Function Documentation</h2>
 
98
<a class="anchor" id="a30de8a19da0c250c3d3645eb51ea942c"></a><!-- doxytag: member="bm::distance_metric_descriptor::reset" ref="a30de8a19da0c250c3d3645eb51ea942c" args="()" -->
 
99
<div class="memitem">
 
100
<div class="memproto">
 
101
      <table class="memname">
 
102
        <tr>
 
103
          <td class="memname">void bm::distance_metric_descriptor::reset </td>
 
104
          <td>(</td>
 
105
          <td class="paramname"></td>
 
106
          <td>&nbsp;)&nbsp;</td>
 
107
          <td><code> [inline]</code></td>
 
108
        </tr>
 
109
      </table>
 
110
</div>
 
111
<div class="memdoc">
 
112
 
 
113
<p>Sets metric result to 0. </p>
 
114
 
 
115
<p>Definition at line <a class="el" href="a00089_source.html#l00102">102</a> of file <a class="el" href="a00089_source.html">bmalgo_impl.h</a>.</p>
 
116
 
 
117
<p>References <a class="el" href="a00089_source.html#l00088">result</a>.</p>
 
118
 
 
119
</div>
 
120
</div>
53
121
<hr/><h2>Field Documentation</h2>
54
 
<a class="anchor" id="af7766714caa1c9cb00750cd8b91314c2"></a><!-- doxytag: member="bm::bvector::iterator_base::dgap_descr::gap_len" ref="af7766714caa1c9cb00750cd8b91314c2" args="" -->
55
 
<div class="memitem">
56
 
<div class="memproto">
57
 
<div class="memtemplate">
58
 
template&lt;class Alloc, class MS&gt; </div>
59
 
      <table class="memname">
60
 
        <tr>
61
 
          <td class="memname"><a class="el" href="a00116.html#ac654d6319039a86546d235a236fc7cf6">gap_word_t</a> <a class="el" href="a00044.html">bm::bvector</a>&lt; Alloc, MS &gt;::<a class="el" href="a00060.html#af7766714caa1c9cb00750cd8b91314c2">iterator_base::dgap_descr::gap_len</a></td>
62
 
        </tr>
63
 
      </table>
64
 
</div>
65
 
<div class="memdoc">
66
 
 
67
 
<p>Current dgap length. </p>
68
 
 
69
 
<p>Definition at line <a class="el" href="a00088_source.html#l00302">302</a> of file <a class="el" href="a00088_source.html">bm.h</a>.</p>
70
 
 
71
 
</div>
72
 
</div>
73
 
<a class="anchor" id="a06ab78e3b3b9c52de9b491dc2ad3a72f"></a><!-- doxytag: member="bm::bvector::iterator_base::dgap_descr::ptr" ref="a06ab78e3b3b9c52de9b491dc2ad3a72f" args="" -->
74
 
<div class="memitem">
75
 
<div class="memproto">
76
 
<div class="memtemplate">
77
 
template&lt;class Alloc, class MS&gt; </div>
78
 
      <table class="memname">
79
 
        <tr>
80
 
          <td class="memname">const <a class="el" href="a00116.html#ac654d6319039a86546d235a236fc7cf6">gap_word_t</a>* <a class="el" href="a00044.html">bm::bvector</a>&lt; Alloc, MS &gt;::<a class="el" href="a00060.html#a06ab78e3b3b9c52de9b491dc2ad3a72f">iterator_base::dgap_descr::ptr</a></td>
81
 
        </tr>
82
 
      </table>
83
 
</div>
84
 
<div class="memdoc">
85
 
 
86
 
<p>Word pointer. </p>
87
 
 
88
 
<p>Definition at line <a class="el" href="a00088_source.html#l00301">301</a> of file <a class="el" href="a00088_source.html">bm.h</a>.</p>
 
122
<a class="anchor" id="a3ece2ccdb7a6616f06a5a15679ccabb1"></a><!-- doxytag: member="bm::distance_metric_descriptor::metric" ref="a3ece2ccdb7a6616f06a5a15679ccabb1" args="" -->
 
123
<div class="memitem">
 
124
<div class="memproto">
 
125
      <table class="memname">
 
126
        <tr>
 
127
          <td class="memname"><a class="el" href="a00125.html#gac38d64c8b27b652413a664cddd4d40ab">distance_metric</a> <a class="el" href="a00060.html#a3ece2ccdb7a6616f06a5a15679ccabb1">bm::distance_metric_descriptor::metric</a></td>
 
128
        </tr>
 
129
      </table>
 
130
</div>
 
131
<div class="memdoc">
 
132
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="a00008.html#a6">sample9.cpp</a>.</dd>
 
133
</dl>
 
134
<p>Definition at line <a class="el" href="a00089_source.html#l00087">87</a> of file <a class="el" href="a00089_source.html">bmalgo_impl.h</a>.</p>
 
135
 
 
136
<p>Referenced by <a class="el" href="a00089_source.html#l00366">bm::combine_any_operation_with_block()</a>, <a class="el" href="a00089_source.html#l00116">bm::combine_count_operation_with_block()</a>, and <a class="el" href="a00114_source.html#l00047">main()</a>.</p>
 
137
 
 
138
</div>
 
139
</div>
 
140
<a class="anchor" id="a94c955fe1ac46589d6edc8df7fd35cf6"></a><!-- doxytag: member="bm::distance_metric_descriptor::result" ref="a94c955fe1ac46589d6edc8df7fd35cf6" args="" -->
 
141
<div class="memitem">
 
142
<div class="memproto">
 
143
      <table class="memname">
 
144
        <tr>
 
145
          <td class="memname"><a class="el" href="a00115.html#aa3824d882a037396370b16f2f0a8bf37">bm::id_t</a> <a class="el" href="a00060.html#a94c955fe1ac46589d6edc8df7fd35cf6">bm::distance_metric_descriptor::result</a></td>
 
146
        </tr>
 
147
      </table>
 
148
</div>
 
149
<div class="memdoc">
 
150
 
 
151
<p>Definition at line <a class="el" href="a00089_source.html#l00088">88</a> of file <a class="el" href="a00089_source.html">bmalgo_impl.h</a>.</p>
 
152
 
 
153
<p>Referenced by <a class="el" href="a00089_source.html#l00995">bm::any_and()</a>, <a class="el" href="a00089_source.html#l01097">bm::any_or()</a>, <a class="el" href="a00089_source.html#l01064">bm::any_sub()</a>, <a class="el" href="a00089_source.html#l01029">bm::any_xor()</a>, <a class="el" href="a00089_source.html#l00366">bm::combine_any_operation_with_block()</a>, <a class="el" href="a00089_source.html#l00116">bm::combine_count_operation_with_block()</a>, <a class="el" href="a00089_source.html#l01081">bm::count_or()</a>, <a class="el" href="a00089_source.html#l01047">bm::count_sub()</a>, <a class="el" href="a00089_source.html#l01013">bm::count_xor()</a>, <a class="el" href="a00089_source.html#l00853">bm::distance_operation_any()</a>, and <a class="el" href="a00089_source.html#l00102">reset()</a>.</p>
89
154
 
90
155
</div>
91
156
</div>
92
157
<hr/>The documentation for this struct was generated from the following file:<ul>
93
 
<li><a class="el" href="a00088_source.html">bm.h</a></li>
 
158
<li><a class="el" href="a00089_source.html">bmalgo_impl.h</a></li>
94
159
</ul>
95
160
</div>
96
 
<hr size="1"/><address style="text-align: right;"><small>Generated on Tue Mar 23 20:48:13 2010 for BitMagic by&nbsp;
 
161
<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Apr 25 09:37:45 2010 for BitMagic by&nbsp;
97
162
<a href="http://www.doxygen.org/index.html">
98
163
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
99
164
</body>