/usr/share/doc/mia-2.0/libdoc/classC2DPolygon.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 205 206 207 208 209 210 | <!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>C2DPolygon 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">C2DPolygon Class Reference<div class="ingroups"><a class="el" href="group__misc.html">Uncategorized</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>A simple 2D polygon class.
<a href="classC2DPolygon.html#details">More...</a></p>
<p><code>#include <<a class="el" href="polygon_8hh_source.html">mia/2d/polygon.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:a88744138e2aa7eb7186b792664a0d6a6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classC2DPolygon.html#a88744138e2aa7eb7186b792664a0d6a6">append</a> (const <a class="el" href="2d_2vector_8hh.html#a1ff708442aa1da9d0b897f04042c7e0c">C2DFVector</a> &point)</td></tr>
<tr class="separator:a88744138e2aa7eb7186b792664a0d6a6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4c2b53414e24228cf64708a599478a0f"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classC2DPolygon.html#a4c2b53414e24228cf64708a599478a0f">get_hausdorff_distance</a> (const <a class="el" href="classC2DPolygon.html">C2DPolygon</a> &other) const </td></tr>
<tr class="separator:a4c2b53414e24228cf64708a599478a0f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a099ff3c6dce5412e7beed327904990f3"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classC2DPolygon.html#a099ff3c6dce5412e7beed327904990f3">get_mimimum_distance</a> (const <a class="el" href="2d_2vector_8hh.html#a1ff708442aa1da9d0b897f04042c7e0c">C2DFVector</a> &point) const </td></tr>
<tr class="separator:a099ff3c6dce5412e7beed327904990f3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afc4538fe081f1b56cb895254800eab9e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classC2DPolygon.html#afc4538fe081f1b56cb895254800eab9e">is_inside_closed_set</a> (const <a class="el" href="2d_2vector_8hh.html#a1ff708442aa1da9d0b897f04042c7e0c">C2DFVector</a> &point) const </td></tr>
<tr class="separator:afc4538fe081f1b56cb895254800eab9e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a89079985a093b1504967d87e3149aa10"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classC2DPolygon.html#a89079985a093b1504967d87e3149aa10">is_inside_open_set</a> (const <a class="el" href="2d_2vector_8hh.html#a1ff708442aa1da9d0b897f04042c7e0c">C2DFVector</a> &point) const </td></tr>
<tr class="separator:a89079985a093b1504967d87e3149aa10"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4747ab8b2c9274ebe90609ae8a41e72f"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classC2DPolygon.html#a4747ab8b2c9274ebe90609ae8a41e72f">size</a> () const </td></tr>
<tr class="separator:a4747ab8b2c9274ebe90609ae8a41e72f"><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 simple 2D polygon class. </p>
<p>This class defines a polygon in 2D space and some functions on it. </p>
<dl class="section remark"><dt>Remarks</dt><dd>Adding two polygons together is not done in a proper algebraic way. </dd></dl>
<p>Definition at line <a class="el" href="polygon_8hh_source.html#l00039">39</a> of file <a class="el" href="polygon_8hh_source.html">polygon.hh</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a88744138e2aa7eb7186b792664a0d6a6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void C2DPolygon::append </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="2d_2vector_8hh.html#a1ff708442aa1da9d0b897f04042c7e0c">C2DFVector</a> & </td>
<td class="paramname"><em>point</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Append a point to the polyon </p>
</div>
</div>
<a class="anchor" id="a4c2b53414e24228cf64708a599478a0f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float C2DPolygon::get_hausdorff_distance </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classC2DPolygon.html">C2DPolygon</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Evaluate the Hausdorff distance between this polygon and another one </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Hausdorff distance </dd></dl>
</div>
</div>
<a class="anchor" id="a099ff3c6dce5412e7beed327904990f3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float C2DPolygon::get_mimimum_distance </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="2d_2vector_8hh.html#a1ff708442aa1da9d0b897f04042c7e0c">C2DFVector</a> & </td>
<td class="paramname"><em>point</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Evaluate the minimum distance of a point to the polygon </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">point</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>distance </dd></dl>
</div>
</div>
<a class="anchor" id="afc4538fe081f1b56cb895254800eab9e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool C2DPolygon::is_inside_closed_set </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="2d_2vector_8hh.html#a1ff708442aa1da9d0b897f04042c7e0c">C2DFVector</a> & </td>
<td class="paramname"><em>point</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Evaluate if a given points is within the polygon if the polygon is considered to be a closed set, i.e. contains its boundary. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">point</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the poin is inside, false otherwiese </dd></dl>
</div>
</div>
<a class="anchor" id="a89079985a093b1504967d87e3149aa10"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool C2DPolygon::is_inside_open_set </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="2d_2vector_8hh.html#a1ff708442aa1da9d0b897f04042c7e0c">C2DFVector</a> & </td>
<td class="paramname"><em>point</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Evaluate if a given points is within the polygon if the polygon is considered to be an open set, i.e. doesn't contain its boundary. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">point</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the poin is inside, false otherwiese </dd></dl>
</div>
</div>
<a class="anchor" id="a4747ab8b2c9274ebe90609ae8a41e72f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t C2DPolygon::size </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 points within the polygon </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="polygon_8hh_source.html">polygon.hh</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 25 2014 23:52:08 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>
|