geometry/doc/generated/centroid_exception.qbk
Barend Gehrels 9382f261fb Doc update, moved reference/* to generated/* and ref/* to reference/*
doxygen_xml2qbk escaping of underscores

[SVN r69328]
2011-02-27 14:02:14 +00:00

67 lines
1.6 KiB
Plaintext

[/============================================================================
Boost.Geometry (aka GGL, Generic Geometry Library)
Copyright (c) 2009-2011 Barend Gehrels, Geodan, Amsterdam, the Netherlands.
Copyright (c) 2009-2011 Mateusz Loskot (mateusz@loskot.net)
Copyright (c) 2009-2011 Bruno Lalande, Paris, France.
Use, modification and distribution is subject to the Boost Software License,
Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
http://www.boost.org/LICENSE_1_0.txt)
=============================================================================/]
[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1centroid__exception.xml]
[section:centroid_exception centroid_exception]
Centroid Exception.
[heading Description]
The centroid\u005fexception is thrown if the free centroid function is called with geometries for which the centroid cannot be calculated. For example: a linestring without points, a polygon without points, an empty multi-geometry.
[heading Synopsis]
``class centroid_exception
: public exception
{
// ...
};
``
[heading Constructor(s)]
[table
[[Function] [Description] [Parameters] ]
[[``centroid_exception``
] [] [
]]
]
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns]]
[[``char const * what``
] [] [
]]
]
[heading Header]
Either
`#include <boost/geometry/geometry.hpp>`
Or
`#include <boost/geometry/algorithms/centroid.hpp>`
[heading See also]
* [link geometry.reference.algorithms.centroid the centroid function]
[endsect]