darkblueb
/
geos_390_docs
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
geos_390_docs/classgeos_1_1index_1_1strtr...

147 lines
7.7 KiB
HTML
Raw Permalink Blame History

<!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.11"/>
<title>GEOS: geos::index::strtree::ItemDistance 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! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">GEOS
&#160;<span id="projectnumber">3.9.1dev</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</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>Class&#160;List</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacegeos.html">geos</a></li><li class="navelem"><a class="el" href="namespacegeos_1_1index.html">index</a></li><li class="navelem"><a class="el" href="namespacegeos_1_1index_1_1strtree.html">strtree</a></li><li class="navelem"><a class="el" href="classgeos_1_1index_1_1strtree_1_1ItemDistance.html">ItemDistance</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classgeos_1_1index_1_1strtree_1_1ItemDistance-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">geos::index::strtree::ItemDistance Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>A function method which computes the distance between two <a class="el" href="classgeos_1_1index_1_1strtree_1_1ItemBoundable.html">ItemBoundables</a> in an <a class="el" href="classgeos_1_1index_1_1strtree_1_1STRtree.html" title="A query-only R-tree created using the Sort-Tile-Recursive (STR) algorithm. For two-dimensional spatia...">STRtree</a>. Used for Nearest Neighbour searches.
<a href="classgeos_1_1index_1_1strtree_1_1ItemDistance.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="ItemDistance_8h_source.html">ItemDistance.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for geos::index::strtree::ItemDistance:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classgeos_1_1index_1_1strtree_1_1ItemDistance__inherit__graph.svg" width="188" height="147"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<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:a0c7b20a6215eb6101e30faee2c5f5262"><td class="memItemLeft" align="right" valign="top">virtual double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1index_1_1strtree_1_1ItemDistance.html#a0c7b20a6215eb6101e30faee2c5f5262">distance</a> (const <a class="el" href="classgeos_1_1index_1_1strtree_1_1ItemBoundable.html">ItemBoundable</a> *item1, const <a class="el" href="classgeos_1_1index_1_1strtree_1_1ItemBoundable.html">ItemBoundable</a> *item2)=0</td></tr>
<tr class="memdesc:a0c7b20a6215eb6101e30faee2c5f5262"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computes the distance between two items. <a href="#a0c7b20a6215eb6101e30faee2c5f5262">More...</a><br /></td></tr>
<tr class="separator:a0c7b20a6215eb6101e30faee2c5f5262"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A function method which computes the distance between two <a class="el" href="classgeos_1_1index_1_1strtree_1_1ItemBoundable.html">ItemBoundables</a> in an <a class="el" href="classgeos_1_1index_1_1strtree_1_1STRtree.html" title="A query-only R-tree created using the Sort-Tile-Recursive (STR) algorithm. For two-dimensional spatia...">STRtree</a>. Used for Nearest Neighbour searches. </p>
<dl class="section author"><dt>Author</dt><dd>Martin Davis </dd></dl>
<p>Definition at line <a class="el" href="ItemDistance_8h_source.html#l00034">34</a> of file <a class="el" href="ItemDistance_8h_source.html">ItemDistance.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a0c7b20a6215eb6101e30faee2c5f5262"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual double geos::index::strtree::ItemDistance::distance </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgeos_1_1index_1_1strtree_1_1ItemBoundable.html">ItemBoundable</a> *&#160;</td>
<td class="paramname"><em>item1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classgeos_1_1index_1_1strtree_1_1ItemBoundable.html">ItemBoundable</a> *&#160;</td>
<td class="paramname"><em>item2</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Computes the distance between two items. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">item1</td><td></td></tr>
<tr><td class="paramname">item2</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the distance between the items</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">IllegalArgumentException</td><td>if the metric is not applicable to the arguments </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classgeos_1_1index_1_1strtree_1_1GeometryItemDistance.html#ae4bbc07ac58f4b0f30a7616b8525ae75">geos::index::strtree::GeometryItemDistance</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="ItemDistance_8h_source.html">ItemDistance.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink