Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

This is the documentation for an old version of Boost. Click here to view this page for the latest version.
PrevUpHomeNext

strategy::distance::pythagoras_point_box

Strategy to calculate the distance between a point and a box.

Synopsis

template<typename CalculationType>
class strategy::distance::pythagoras_point_box
{
  // ...
};

Template parameter(s)

Parameter

Default

Description

typename CalculationType

void

numeric type for calculation (e.g. high precision); if void then it is extracted automatically from the coordinate type and (if necessary) promoted to floating point

Member Function(s)

Function

Description

Parameters

Returns

template<typename Point, typename Box>
calculation_type< Point, Box >::type apply(Point const & point, Box const & box)

applies the distance calculation using pythagoras

Point const &: point: point

Box const &: box: box

the calculated distance (including taking the square root)

Header

#include <boost/geometry/strategies/cartesian/distance_pythagoras_point_box.hpp>

Notes
[Note] Note

Can be used for points and boxes with two, three or more dimensions

See also

distance (with strategy)


PrevUpHomeNext