| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> |
| <title>strategy::distance::pythagoras</title> |
| <link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css"> |
| <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> |
| <link rel="home" href="../../../index.html" title="Chapter 1. Geometry"> |
| <link rel="up" href="../strategies.html" title="Strategies"> |
| <link rel="prev" href="../strategies.html" title="Strategies"> |
| <link rel="next" href="strategy_distance_pythagoras_box_box.html" title="strategy::distance::pythagoras_box_box"> |
| </head> |
| <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
| <table cellpadding="2" width="100%"><tr> |
| <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td> |
| <td align="center"><a href="../../../../../../../index.html">Home</a></td> |
| <td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td> |
| <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> |
| <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> |
| <td align="center"><a href="../../../../../../../more/index.htm">More</a></td> |
| </tr></table> |
| <hr> |
| <div class="spirit-nav"> |
| <a accesskey="p" href="../strategies.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../strategies.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="strategy_distance_pythagoras_box_box.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> |
| </div> |
| <div class="section"> |
| <div class="titlepage"><div><div><h4 class="title"> |
| <a name="geometry.reference.strategies.strategy_distance_pythagoras"></a><a class="link" href="strategy_distance_pythagoras.html" title="strategy::distance::pythagoras">strategy::distance::pythagoras</a> |
| </h4></div></div></div> |
| <p> |
| <a class="indexterm" name="idp130602896"></a><a class="indexterm" name="idp130603584"></a><a class="indexterm" name="idp130604272"></a> |
| Strategy to calculate the distance between two points. |
| </p> |
| <h6> |
| <a name="geometry.reference.strategies.strategy_distance_pythagoras.h0"></a> |
| <span class="phrase"><a name="geometry.reference.strategies.strategy_distance_pythagoras.synopsis"></a></span><a class="link" href="strategy_distance_pythagoras.html#geometry.reference.strategies.strategy_distance_pythagoras.synopsis">Synopsis</a> |
| </h6> |
| <p> |
| </p> |
| <pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">CalculationType</span><span class="special">></span> |
| <span class="keyword">class</span> <span class="identifier">strategy</span><span class="special">::</span><span class="identifier">distance</span><span class="special">::</span><span class="identifier">pythagoras</span> |
| <span class="special">{</span> |
| <span class="comment">// ...</span> |
| <span class="special">};</span> |
| </pre> |
| <p> |
| </p> |
| <h6> |
| <a name="geometry.reference.strategies.strategy_distance_pythagoras.h1"></a> |
| <span class="phrase"><a name="geometry.reference.strategies.strategy_distance_pythagoras.template_parameter_s_"></a></span><a class="link" href="strategy_distance_pythagoras.html#geometry.reference.strategies.strategy_distance_pythagoras.template_parameter_s_">Template |
| parameter(s)</a> |
| </h6> |
| <div class="informaltable"><table class="table"> |
| <colgroup> |
| <col> |
| <col> |
| <col> |
| </colgroup> |
| <thead><tr> |
| <th> |
| <p> |
| Parameter |
| </p> |
| </th> |
| <th> |
| <p> |
| Default |
| </p> |
| </th> |
| <th> |
| <p> |
| Description |
| </p> |
| </th> |
| </tr></thead> |
| <tbody><tr> |
| <td> |
| <p> |
| typename CalculationType |
| </p> |
| </td> |
| <td> |
| <p> |
| void |
| </p> |
| </td> |
| <td> |
| <p> |
| numeric type for calculation (e.g. high precision); if <span class="bold"><strong>void</strong></span> then it is extracted automatically |
| from the coordinate type and (if necessary) promoted to floating |
| point |
| </p> |
| </td> |
| </tr></tbody> |
| </table></div> |
| <h6> |
| <a name="geometry.reference.strategies.strategy_distance_pythagoras.h2"></a> |
| <span class="phrase"><a name="geometry.reference.strategies.strategy_distance_pythagoras.member_function_s_"></a></span><a class="link" href="strategy_distance_pythagoras.html#geometry.reference.strategies.strategy_distance_pythagoras.member_function_s_">Member |
| Function(s)</a> |
| </h6> |
| <div class="informaltable"><table class="table"> |
| <colgroup> |
| <col> |
| <col> |
| <col> |
| <col> |
| </colgroup> |
| <thead><tr> |
| <th> |
| <p> |
| Function |
| </p> |
| </th> |
| <th> |
| <p> |
| Description |
| </p> |
| </th> |
| <th> |
| <p> |
| Parameters |
| </p> |
| </th> |
| <th> |
| <p> |
| Returns |
| </p> |
| </th> |
| </tr></thead> |
| <tbody><tr> |
| <td> |
| <p> |
| </p> |
| <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">P1</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">P2</span><span class="special">></span> |
| <span class="identifier">calculation_type</span><span class="special"><</span> <span class="identifier">P1</span><span class="special">,</span> <span class="identifier">P2</span> <span class="special">>::</span><span class="identifier">type</span> <span class="identifier">apply</span><span class="special">(</span><span class="identifier">P1</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">p1</span><span class="special">,</span> <span class="identifier">P2</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">p2</span><span class="special">)</span></pre> |
| <p> |
| </p> |
| </td> |
| <td> |
| <p> |
| applies the distance calculation using pythagoras |
| </p> |
| </td> |
| <td> |
| <p> |
| <span class="bold"><strong>P1 const &</strong></span>: <span class="emphasis"><em>p1</em></span>: |
| first point |
| </p> |
| <p> |
| <span class="bold"><strong>P2 const &</strong></span>: <span class="emphasis"><em>p2</em></span>: |
| second point |
| </p> |
| </td> |
| <td> |
| <p> |
| the calculated distance (including taking the square root) |
| </p> |
| </td> |
| </tr></tbody> |
| </table></div> |
| <h6> |
| <a name="geometry.reference.strategies.strategy_distance_pythagoras.h3"></a> |
| <span class="phrase"><a name="geometry.reference.strategies.strategy_distance_pythagoras.header"></a></span><a class="link" href="strategy_distance_pythagoras.html#geometry.reference.strategies.strategy_distance_pythagoras.header">Header</a> |
| </h6> |
| <p> |
| <code class="computeroutput"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">strategies</span><span class="special">/</span><span class="identifier">cartesian</span><span class="special">/</span><span class="identifier">distance_pythagoras</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> |
| </p> |
| <h6> |
| <a name="geometry.reference.strategies.strategy_distance_pythagoras.h4"></a> |
| <span class="phrase"><a name="geometry.reference.strategies.strategy_distance_pythagoras.notes"></a></span><a class="link" href="strategy_distance_pythagoras.html#geometry.reference.strategies.strategy_distance_pythagoras.notes">Notes</a> |
| </h6> |
| <div class="note"><table border="0" summary="Note"> |
| <tr> |
| <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../doc/src/images/note.png"></td> |
| <th align="left">Note</th> |
| </tr> |
| <tr><td align="left" valign="top"><p> |
| Can be used for points with two, three or more dimensions |
| </p></td></tr> |
| </table></div> |
| <h6> |
| <a name="geometry.reference.strategies.strategy_distance_pythagoras.h5"></a> |
| <span class="phrase"><a name="geometry.reference.strategies.strategy_distance_pythagoras.see_also"></a></span><a class="link" href="strategy_distance_pythagoras.html#geometry.reference.strategies.strategy_distance_pythagoras.see_also">See |
| also</a> |
| </h6> |
| <p> |
| <a class="link" href="../algorithms/distance/distance_3_with_strategy.html" title="distance (with strategy)">distance |
| (with strategy)</a> |
| </p> |
| </div> |
| <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> |
| <td align="left"></td> |
| <td align="right"><div class="copyright-footer">Copyright © 2009-2015 Barend Gehrels, Bruno Lalande, |
| Mateusz Loskot, Adam Wulkiewicz, Oracle and/or its affiliates<p> |
| Distributed under the Boost Software License, Version 1.0. (See accompanying |
| file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) |
| </p> |
| </div></td> |
| </tr></table> |
| <hr> |
| <div class="spirit-nav"> |
| <a accesskey="p" href="../strategies.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../strategies.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="strategy_distance_pythagoras_box_box.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> |
| </div> |
| </body> |
| </html> |
