mirror of
https://github.com/boostorg/geometry.git
synced 2025-05-12 14:01:47 +00:00
[index][doc] Remove manually enabled doxygen code for details since now it should be automatically generated.
This commit is contained in:
parent
3475f33972
commit
d3f95f2cbb
@ -284,8 +284,7 @@ SEARCH_INCLUDES = YES
|
|||||||
INCLUDE_PATH =
|
INCLUDE_PATH =
|
||||||
INCLUDE_FILE_PATTERNS =
|
INCLUDE_FILE_PATTERNS =
|
||||||
PREDEFINED = "BOOST_RV_REF(T)=T &&" \
|
PREDEFINED = "BOOST_RV_REF(T)=T &&" \
|
||||||
"BOOST_COPY_ASSIGN_REF(T)=T const &" \
|
"BOOST_COPY_ASSIGN_REF(T)=T const &"
|
||||||
DOXYGEN_NO_DETAIL
|
|
||||||
EXPAND_AS_DEFINED =
|
EXPAND_AS_DEFINED =
|
||||||
SKIP_FUNCTION_MACROS = YES
|
SKIP_FUNCTION_MACROS = YES
|
||||||
#---------------------------------------------------------------------------
|
#---------------------------------------------------------------------------
|
||||||
|
@ -75,11 +75,7 @@ operator|(
|
|||||||
\param pred Predicates.
|
\param pred Predicates.
|
||||||
*/
|
*/
|
||||||
template <typename Predicates>
|
template <typename Predicates>
|
||||||
#ifndef DOXYGEN_NO_DETAIL
|
|
||||||
detail::query<Predicates>
|
detail::query<Predicates>
|
||||||
#else
|
|
||||||
unspecified
|
|
||||||
#endif
|
|
||||||
queried(Predicates const& pred)
|
queried(Predicates const& pred)
|
||||||
{
|
{
|
||||||
return detail::query<Predicates>(pred);
|
return detail::query<Predicates>(pred);
|
||||||
|
@ -235,9 +235,7 @@ other types using operator==.
|
|||||||
*/
|
*/
|
||||||
template <typename Value>
|
template <typename Value>
|
||||||
struct equal_to
|
struct equal_to
|
||||||
#ifndef DOXYGEN_NO_DETAIL
|
|
||||||
: detail::equal_to<Value>
|
: detail::equal_to<Value>
|
||||||
#endif
|
|
||||||
{
|
{
|
||||||
/*! \brief The type of result returned by function object. */
|
/*! \brief The type of result returned by function object. */
|
||||||
typedef typename detail::equal_to<Value>::result_type result_type;
|
typedef typename detail::equal_to<Value>::result_type result_type;
|
||||||
|
@ -195,9 +195,7 @@ and variadic templates are supported.
|
|||||||
*/
|
*/
|
||||||
template <typename Value>
|
template <typename Value>
|
||||||
struct indexable
|
struct indexable
|
||||||
#ifndef DOXYGEN_NO_DETAIL
|
|
||||||
: detail::indexable<Value>
|
: detail::indexable<Value>
|
||||||
#endif
|
|
||||||
{
|
{
|
||||||
/*! \brief The type of result returned by function object. It should be const Indexable reference. */
|
/*! \brief The type of result returned by function object. It should be const Indexable reference. */
|
||||||
typedef typename detail::indexable<Value>::result_type result_type;
|
typedef typename detail::indexable<Value>::result_type result_type;
|
||||||
|
@ -70,12 +70,7 @@ inline size_t default_rstar_reinserted_elements_d_calc(size_t max_elements, size
|
|||||||
\tparam MinElements Minimum number of elements in nodes. Default: 0.3*Max.
|
\tparam MinElements Minimum number of elements in nodes. Default: 0.3*Max.
|
||||||
*/
|
*/
|
||||||
template <size_t MaxElements,
|
template <size_t MaxElements,
|
||||||
#ifndef DOXYGEN_NO_DETAIL
|
size_t MinElements = detail::default_min_elements_s<MaxElements>::value>
|
||||||
size_t MinElements = detail::default_min_elements_s<MaxElements>::value
|
|
||||||
#else
|
|
||||||
size_t MinElements = 0.3*MaxElements
|
|
||||||
#endif
|
|
||||||
>
|
|
||||||
struct linear
|
struct linear
|
||||||
{
|
{
|
||||||
BOOST_MPL_ASSERT_MSG((0 < MinElements && 2*MinElements <= MaxElements+1),
|
BOOST_MPL_ASSERT_MSG((0 < MinElements && 2*MinElements <= MaxElements+1),
|
||||||
@ -95,12 +90,7 @@ struct linear
|
|||||||
\tparam MinElements Minimum number of elements in nodes. Default: 0.3*Max.
|
\tparam MinElements Minimum number of elements in nodes. Default: 0.3*Max.
|
||||||
*/
|
*/
|
||||||
template <size_t MaxElements,
|
template <size_t MaxElements,
|
||||||
#ifndef DOXYGEN_NO_DETAIL
|
size_t MinElements = detail::default_min_elements_s<MaxElements>::value>
|
||||||
size_t MinElements = detail::default_min_elements_s<MaxElements>::value
|
|
||||||
#else
|
|
||||||
size_t MinElements = 0.3*MaxElements
|
|
||||||
#endif
|
|
||||||
>
|
|
||||||
struct quadratic
|
struct quadratic
|
||||||
{
|
{
|
||||||
BOOST_MPL_ASSERT_MSG((0 < MinElements && 2*MinElements <= MaxElements+1),
|
BOOST_MPL_ASSERT_MSG((0 < MinElements && 2*MinElements <= MaxElements+1),
|
||||||
@ -128,13 +118,8 @@ struct quadratic
|
|||||||
and true minimum overlap cost is calculated. Default: 32.
|
and true minimum overlap cost is calculated. Default: 32.
|
||||||
*/
|
*/
|
||||||
template <size_t MaxElements,
|
template <size_t MaxElements,
|
||||||
#ifndef DOXYGEN_NO_DETAIL
|
|
||||||
size_t MinElements = detail::default_min_elements_s<MaxElements>::value,
|
size_t MinElements = detail::default_min_elements_s<MaxElements>::value,
|
||||||
size_t ReinsertedElements = detail::default_rstar_reinserted_elements_s<MaxElements>::value,
|
size_t ReinsertedElements = detail::default_rstar_reinserted_elements_s<MaxElements>::value,
|
||||||
#else
|
|
||||||
size_t MinElements = 0.3*MaxElements,
|
|
||||||
size_t ReinsertedElements = 0.3*MaxElements,
|
|
||||||
#endif
|
|
||||||
size_t OverlapCostThreshold = 32>
|
size_t OverlapCostThreshold = 32>
|
||||||
struct rstar
|
struct rstar
|
||||||
{
|
{
|
||||||
@ -172,11 +157,7 @@ public:
|
|||||||
\param min_elements Minimum number of elements in nodes. Default: 0.3*Max.
|
\param min_elements Minimum number of elements in nodes. Default: 0.3*Max.
|
||||||
*/
|
*/
|
||||||
dynamic_linear(size_t max_elements,
|
dynamic_linear(size_t max_elements,
|
||||||
#ifndef DOXYGEN_NO_DETAIL
|
|
||||||
size_t min_elements = detail::default_min_elements_d())
|
size_t min_elements = detail::default_min_elements_d())
|
||||||
#else
|
|
||||||
size_t min_elements = 0.3*max_elements)
|
|
||||||
#endif
|
|
||||||
: m_max_elements(max_elements)
|
: m_max_elements(max_elements)
|
||||||
, m_min_elements(detail::default_min_elements_d_calc(max_elements, min_elements))
|
, m_min_elements(detail::default_min_elements_d_calc(max_elements, min_elements))
|
||||||
{
|
{
|
||||||
@ -205,11 +186,7 @@ public:
|
|||||||
\param min_elements Minimum number of elements in nodes. Default: 0.3*Max.
|
\param min_elements Minimum number of elements in nodes. Default: 0.3*Max.
|
||||||
*/
|
*/
|
||||||
dynamic_quadratic(size_t max_elements,
|
dynamic_quadratic(size_t max_elements,
|
||||||
#ifndef DOXYGEN_NO_DETAIL
|
|
||||||
size_t min_elements = detail::default_min_elements_d())
|
size_t min_elements = detail::default_min_elements_d())
|
||||||
#else
|
|
||||||
size_t min_elements = 0.3*max_elements)
|
|
||||||
#endif
|
|
||||||
: m_max_elements(max_elements)
|
: m_max_elements(max_elements)
|
||||||
, m_min_elements(detail::default_min_elements_d_calc(max_elements, min_elements))
|
, m_min_elements(detail::default_min_elements_d_calc(max_elements, min_elements))
|
||||||
{
|
{
|
||||||
@ -246,13 +223,8 @@ public:
|
|||||||
and true minimum overlap cost is calculated. Default: 32.
|
and true minimum overlap cost is calculated. Default: 32.
|
||||||
*/
|
*/
|
||||||
dynamic_rstar(size_t max_elements,
|
dynamic_rstar(size_t max_elements,
|
||||||
#ifndef DOXYGEN_NO_DETAIL
|
|
||||||
size_t min_elements = detail::default_min_elements_d(),
|
size_t min_elements = detail::default_min_elements_d(),
|
||||||
size_t reinserted_elements = detail::default_rstar_reinserted_elements_d(),
|
size_t reinserted_elements = detail::default_rstar_reinserted_elements_d(),
|
||||||
#else
|
|
||||||
size_t min_elements = 0.3*max_elements,
|
|
||||||
size_t reinserted_elements = 0.3*max_elements,
|
|
||||||
#endif
|
|
||||||
size_t overlap_cost_threshold = 32)
|
size_t overlap_cost_threshold = 32)
|
||||||
: m_max_elements(max_elements)
|
: m_max_elements(max_elements)
|
||||||
, m_min_elements(detail::default_min_elements_d_calc(max_elements, min_elements))
|
, m_min_elements(detail::default_min_elements_d_calc(max_elements, min_elements))
|
||||||
|
@ -43,11 +43,7 @@ bgi::query(spatial_index, bgi::contains(box), std::back_inserter(result));
|
|||||||
\param g The Geometry object.
|
\param g The Geometry object.
|
||||||
*/
|
*/
|
||||||
template <typename Geometry> inline
|
template <typename Geometry> inline
|
||||||
#ifndef DOXYGEN_NO_DETAIL
|
|
||||||
detail::predicates::spatial_predicate<Geometry, detail::predicates::contains_tag, false>
|
detail::predicates::spatial_predicate<Geometry, detail::predicates::contains_tag, false>
|
||||||
#else
|
|
||||||
unspecified
|
|
||||||
#endif
|
|
||||||
contains(Geometry const& g)
|
contains(Geometry const& g)
|
||||||
{
|
{
|
||||||
return detail::predicates::spatial_predicate
|
return detail::predicates::spatial_predicate
|
||||||
@ -77,11 +73,7 @@ bgi::query(spatial_index, bgi::covered_by(box), std::back_inserter(result));
|
|||||||
\param g The Geometry object.
|
\param g The Geometry object.
|
||||||
*/
|
*/
|
||||||
template <typename Geometry> inline
|
template <typename Geometry> inline
|
||||||
#ifndef DOXYGEN_NO_DETAIL
|
|
||||||
detail::predicates::spatial_predicate<Geometry, detail::predicates::covered_by_tag, false>
|
detail::predicates::spatial_predicate<Geometry, detail::predicates::covered_by_tag, false>
|
||||||
#else
|
|
||||||
unspecified
|
|
||||||
#endif
|
|
||||||
covered_by(Geometry const& g)
|
covered_by(Geometry const& g)
|
||||||
{
|
{
|
||||||
return detail::predicates::spatial_predicate
|
return detail::predicates::spatial_predicate
|
||||||
@ -111,11 +103,7 @@ bgi::query(spatial_index, bgi::covers(box), std::back_inserter(result));
|
|||||||
\param g The Geometry object.
|
\param g The Geometry object.
|
||||||
*/
|
*/
|
||||||
template <typename Geometry> inline
|
template <typename Geometry> inline
|
||||||
#ifndef DOXYGEN_NO_DETAIL
|
|
||||||
detail::predicates::spatial_predicate<Geometry, detail::predicates::covers_tag, false>
|
detail::predicates::spatial_predicate<Geometry, detail::predicates::covers_tag, false>
|
||||||
#else
|
|
||||||
unspecified
|
|
||||||
#endif
|
|
||||||
covers(Geometry const& g)
|
covers(Geometry const& g)
|
||||||
{
|
{
|
||||||
return detail::predicates::spatial_predicate
|
return detail::predicates::spatial_predicate
|
||||||
@ -145,11 +133,7 @@ bgi::query(spatial_index, bgi::disjoint(box), std::back_inserter(result));
|
|||||||
\param g The Geometry object.
|
\param g The Geometry object.
|
||||||
*/
|
*/
|
||||||
template <typename Geometry> inline
|
template <typename Geometry> inline
|
||||||
#ifndef DOXYGEN_NO_DETAIL
|
|
||||||
detail::predicates::spatial_predicate<Geometry, detail::predicates::disjoint_tag, false>
|
detail::predicates::spatial_predicate<Geometry, detail::predicates::disjoint_tag, false>
|
||||||
#else
|
|
||||||
unspecified
|
|
||||||
#endif
|
|
||||||
disjoint(Geometry const& g)
|
disjoint(Geometry const& g)
|
||||||
{
|
{
|
||||||
return detail::predicates::spatial_predicate
|
return detail::predicates::spatial_predicate
|
||||||
@ -181,11 +165,7 @@ bgi::query(spatial_index, bgi::intersects(polygon), std::back_inserter(result));
|
|||||||
\param g The Geometry object.
|
\param g The Geometry object.
|
||||||
*/
|
*/
|
||||||
template <typename Geometry> inline
|
template <typename Geometry> inline
|
||||||
#ifndef DOXYGEN_NO_DETAIL
|
|
||||||
detail::predicates::spatial_predicate<Geometry, detail::predicates::intersects_tag, false>
|
detail::predicates::spatial_predicate<Geometry, detail::predicates::intersects_tag, false>
|
||||||
#else
|
|
||||||
unspecified
|
|
||||||
#endif
|
|
||||||
intersects(Geometry const& g)
|
intersects(Geometry const& g)
|
||||||
{
|
{
|
||||||
return detail::predicates::spatial_predicate
|
return detail::predicates::spatial_predicate
|
||||||
@ -215,11 +195,7 @@ bgi::query(spatial_index, bgi::overlaps(box), std::back_inserter(result));
|
|||||||
\param g The Geometry object.
|
\param g The Geometry object.
|
||||||
*/
|
*/
|
||||||
template <typename Geometry> inline
|
template <typename Geometry> inline
|
||||||
#ifndef DOXYGEN_NO_DETAIL
|
|
||||||
detail::predicates::spatial_predicate<Geometry, detail::predicates::overlaps_tag, false>
|
detail::predicates::spatial_predicate<Geometry, detail::predicates::overlaps_tag, false>
|
||||||
#else
|
|
||||||
unspecified
|
|
||||||
#endif
|
|
||||||
overlaps(Geometry const& g)
|
overlaps(Geometry const& g)
|
||||||
{
|
{
|
||||||
return detail::predicates::spatial_predicate
|
return detail::predicates::spatial_predicate
|
||||||
@ -246,11 +222,7 @@ returns true.
|
|||||||
\param g The Geometry object.
|
\param g The Geometry object.
|
||||||
*/
|
*/
|
||||||
template <typename Geometry> inline
|
template <typename Geometry> inline
|
||||||
#ifndef DOXYGEN_NO_DETAIL
|
|
||||||
detail::predicates::spatial_predicate<Geometry, detail::predicates::touches_tag, false>
|
detail::predicates::spatial_predicate<Geometry, detail::predicates::touches_tag, false>
|
||||||
#else
|
|
||||||
unspecified
|
|
||||||
#endif
|
|
||||||
touches(Geometry const& g)
|
touches(Geometry const& g)
|
||||||
{
|
{
|
||||||
return detail::predicates::spatial_predicate
|
return detail::predicates::spatial_predicate
|
||||||
@ -282,11 +254,7 @@ bgi::query(spatial_index, bgi::within(box), std::back_inserter(result));
|
|||||||
\param g The Geometry object.
|
\param g The Geometry object.
|
||||||
*/
|
*/
|
||||||
template <typename Geometry> inline
|
template <typename Geometry> inline
|
||||||
#ifndef DOXYGEN_NO_DETAIL
|
|
||||||
detail::predicates::spatial_predicate<Geometry, detail::predicates::within_tag, false>
|
detail::predicates::spatial_predicate<Geometry, detail::predicates::within_tag, false>
|
||||||
#else
|
|
||||||
unspecified
|
|
||||||
#endif
|
|
||||||
within(Geometry const& g)
|
within(Geometry const& g)
|
||||||
{
|
{
|
||||||
return detail::predicates::spatial_predicate
|
return detail::predicates::spatial_predicate
|
||||||
@ -331,11 +299,7 @@ std::back_inserter(result));
|
|||||||
\param pred The unary predicate function or function object.
|
\param pred The unary predicate function or function object.
|
||||||
*/
|
*/
|
||||||
template <typename UnaryPredicate> inline
|
template <typename UnaryPredicate> inline
|
||||||
#ifndef DOXYGEN_NO_DETAIL
|
|
||||||
detail::predicates::satisfies<UnaryPredicate, false>
|
detail::predicates::satisfies<UnaryPredicate, false>
|
||||||
#else
|
|
||||||
unspecified
|
|
||||||
#endif
|
|
||||||
satisfies(UnaryPredicate const& pred)
|
satisfies(UnaryPredicate const& pred)
|
||||||
{
|
{
|
||||||
return detail::predicates::satisfies<UnaryPredicate, false>(pred);
|
return detail::predicates::satisfies<UnaryPredicate, false>(pred);
|
||||||
@ -365,11 +329,7 @@ Only one \c nearest() predicate may be used in a query.
|
|||||||
\param k The maximum number of values to return.
|
\param k The maximum number of values to return.
|
||||||
*/
|
*/
|
||||||
template <typename Geometry> inline
|
template <typename Geometry> inline
|
||||||
#ifndef DOXYGEN_NO_DETAIL
|
|
||||||
detail::predicates::nearest<Geometry>
|
detail::predicates::nearest<Geometry>
|
||||||
#else
|
|
||||||
unspecified
|
|
||||||
#endif
|
|
||||||
nearest(Geometry const& geometry, unsigned k)
|
nearest(Geometry const& geometry, unsigned k)
|
||||||
{
|
{
|
||||||
return detail::predicates::nearest<Geometry>(geometry, k);
|
return detail::predicates::nearest<Geometry>(geometry, k);
|
||||||
@ -399,11 +359,7 @@ Only one distance predicate (\c nearest() or \c path()) may be used in a query.
|
|||||||
\param k The maximum number of values to return.
|
\param k The maximum number of values to return.
|
||||||
*/
|
*/
|
||||||
template <typename SegmentOrLinestring> inline
|
template <typename SegmentOrLinestring> inline
|
||||||
#ifndef DOXYGEN_NO_DETAIL
|
|
||||||
detail::predicates::path<SegmentOrLinestring>
|
detail::predicates::path<SegmentOrLinestring>
|
||||||
#else
|
|
||||||
unspecified
|
|
||||||
#endif
|
|
||||||
path(SegmentOrLinestring const& linestring, unsigned k)
|
path(SegmentOrLinestring const& linestring, unsigned k)
|
||||||
{
|
{
|
||||||
return detail::predicates::path<SegmentOrLinestring>(linestring, k);
|
return detail::predicates::path<SegmentOrLinestring>(linestring, k);
|
||||||
|
Loading…
x
Reference in New Issue
Block a user