EQ2EMu/EQ2/source/depends/boost_1_72_0/libs/geometry/doc/generated/centroid_exception.qbk

[/============================================================================
  Boost.Geometry (aka GGL, Generic Geometry Library)

  Copyright (c) 2007-2013 Barend Gehrels, Amsterdam, the Netherlands.
  Copyright (c) 2008-2013 Bruno Lalande, Paris, France.
  Copyright (c) 2009-2013 Mateusz Loskot, London, UK.

  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 1.1.1, 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]

'''<indexterm><primary>centroid_exception</primary></indexterm>'''
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()``

] [The default constructor. ] [

]]
]

[heading Member Function(s)]
[table
[[Function] [Description] [Parameters]  [Returns]]
[[``char const  * what()``

] [Returns the explanatory string. ] [

][
Pointer to a null-terminated string with explanatory information. 

]
]
]

[heading Header]
Either

`#include <boost/geometry.hpp>`


Or

`#include <boost/geometry/algorithms/centroid.hpp>`

[heading See also]
* [link geometry.reference.algorithms.centroid the centroid function]

[endsect]