/usr/share/doc/mia-2.0/libdoc/classCCircularIndex.html is in libmia-2.0-doc 2.0.13-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.6"/>
<title>CCircularIndex Class 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! -->
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">CCircularIndex Class Reference<div class="ingroups"><a class="el" href="group__misc.html">Uncategorized</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>A class to adress a circulat bufer of a fixed size.
<a href="classCCircularIndex.html#details">More...</a></p>
<p><code>#include <<a class="el" href="index_8hh_source.html">mia/core/index.hh</a>></code></p>
<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:a605ee779bfc97772ab7e5a52dfcc407f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCircularIndex.html#a605ee779bfc97772ab7e5a52dfcc407f">CCircularIndex</a> (unsigned int size, unsigned int start)</td></tr>
<tr class="separator:a605ee779bfc97772ab7e5a52dfcc407f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8af96da5fe5df7fbe14160ab0dde548d"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCircularIndex.html#a8af96da5fe5df7fbe14160ab0dde548d">fill</a> () const </td></tr>
<tr class="separator:a8af96da5fe5df7fbe14160ab0dde548d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a552ed295573b2745a2a108eab838a1a7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCircularIndex.html#a552ed295573b2745a2a108eab838a1a7">insert_one</a> ()</td></tr>
<tr class="separator:a552ed295573b2745a2a108eab838a1a7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae8f62b9c8d702f9ea7274d8e24d22f42"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCircularIndex.html#ae8f62b9c8d702f9ea7274d8e24d22f42">new_start</a> (unsigned int start)</td></tr>
<tr class="separator:ae8f62b9c8d702f9ea7274d8e24d22f42"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7a30b62b6de3071fc48dd2a3ca83a58e"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCircularIndex.html#a7a30b62b6de3071fc48dd2a3ca83a58e">next</a> () const </td></tr>
<tr class="separator:a7a30b62b6de3071fc48dd2a3ca83a58e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab74f11b4bc39bbe0a4dcb93f5bf71d90"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCircularIndex.html#ab74f11b4bc39bbe0a4dcb93f5bf71d90">value</a> (unsigned int i) const </td></tr>
<tr class="separator:ab74f11b4bc39bbe0a4dcb93f5bf71d90"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A class to adress a circulat bufer of a fixed size. </p>
<p>This class provides the structure for the translation of a linear index to a circular buffer. An example for its use can be found in mia/3d/translate/spline.cc: on_grid (BLAS_VERSION) </p>
<p>Definition at line <a class="el" href="index_8hh_source.html#l00038">38</a> of file <a class="el" href="index_8hh_source.html">index.hh</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a605ee779bfc97772ab7e5a52dfcc407f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CCircularIndex::CCircularIndex </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>start</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct the buffer </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td>size ofthe buffer </td></tr>
<tr><td class="paramname">start</td><td>start index </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a8af96da5fe5df7fbe14160ab0dde548d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int CCircularIndex::fill </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the number of occupied indices </dd></dl>
</div>
</div>
<a class="anchor" id="a552ed295573b2745a2a108eab838a1a7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCircularIndex::insert_one </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Insert one index </p>
</div>
</div>
<a class="anchor" id="ae8f62b9c8d702f9ea7274d8e24d22f42"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCircularIndex::new_start </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>start</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>reset the start index </p>
</div>
</div>
<a class="anchor" id="a7a30b62b6de3071fc48dd2a3ca83a58e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int CCircularIndex::next </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>get the next index </p>
</div>
</div>
<a class="anchor" id="ab74f11b4bc39bbe0a4dcb93f5bf71d90"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int CCircularIndex::value </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>i</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Translate the linear index i to the index in the circular buffer </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">i</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>circular index </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="index_8hh_source.html">index.hh</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 25 2014 23:52:09 by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>
|