summaryrefslogtreecommitdiff
path: root/boost/geometry/index/predicates.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'boost/geometry/index/predicates.hpp')
-rw-r--r--boost/geometry/index/predicates.hpp58
1 files changed, 33 insertions, 25 deletions
diff --git a/boost/geometry/index/predicates.hpp b/boost/geometry/index/predicates.hpp
index f4e22bdd55..a79e3f173a 100644
--- a/boost/geometry/index/predicates.hpp
+++ b/boost/geometry/index/predicates.hpp
@@ -2,7 +2,7 @@
//
// Spatial query predicates
//
-// Copyright (c) 2011-2015 Adam Wulkiewicz, Lodz, Poland.
+// Copyright (c) 2011-2018 Adam Wulkiewicz, Lodz, Poland.
//
// Use, modification and distribution is subject to the Boost Software License,
// Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
@@ -23,9 +23,10 @@ namespace boost { namespace geometry { namespace index {
/*!
\brief Generate \c contains() predicate.
-Generate a predicate defining Value and Geometry relationship.
-Value will be returned by the query if <tt>bg::within(Geometry, Indexable)</tt>
-returns true.
+Generate a predicate defining Value and Geometry relationship. With this
+predicate query returns indexed Values that contain passed Geometry.
+Value is returned by the query if <tt>bg::within(Geometry, Indexable)</tt>
+returns <tt>true</tt>.
\par Example
\verbatim
@@ -53,9 +54,10 @@ contains(Geometry const& g)
/*!
\brief Generate \c covered_by() predicate.
-Generate a predicate defining Value and Geometry relationship.
-Value will be returned by the query if <tt>bg::covered_by(Indexable, Geometry)</tt>
-returns true.
+Generate a predicate defining Value and Geometry relationship. With this
+predicate query returns indexed Values that are covered by passed Geometry.
+Value is returned by the query if <tt>bg::covered_by(Indexable, Geometry)</tt>
+returns <tt>true</tt>.
\par Example
\verbatim
@@ -83,9 +85,10 @@ covered_by(Geometry const& g)
/*!
\brief Generate \c covers() predicate.
-Generate a predicate defining Value and Geometry relationship.
-Value will be returned by the query if <tt>bg::covered_by(Geometry, Indexable)</tt>
-returns true.
+Generate a predicate defining Value and Geometry relationship. With this
+predicate query returns indexed Values that cover passed Geometry.
+Value is returned by the query if <tt>bg::covered_by(Geometry, Indexable)</tt>
+returns <tt>true</tt>.
\par Example
\verbatim
@@ -113,9 +116,10 @@ covers(Geometry const& g)
/*!
\brief Generate \c disjoint() predicate.
-Generate a predicate defining Value and Geometry relationship.
-Value will be returned by the query if <tt>bg::disjoint(Indexable, Geometry)</tt>
-returns true.
+Generate a predicate defining Value and Geometry relationship. With this
+predicate query returns indexed Values that are disjoint with passed Geometry.
+Value is returned by the query if <tt>bg::disjoint(Indexable, Geometry)</tt>
+returns <tt>true</tt>.
\par Example
\verbatim
@@ -143,9 +147,10 @@ disjoint(Geometry const& g)
/*!
\brief Generate \c intersects() predicate.
-Generate a predicate defining Value and Geometry relationship.
-Value will be returned by the query if <tt>bg::intersects(Indexable, Geometry)</tt>
-returns true.
+Generate a predicate defining Value and Geometry relationship. With this
+predicate query returns indexed Values that intersect passed Geometry.
+Value is returned by the query if <tt>bg::intersects(Indexable, Geometry)</tt>
+returns <tt>true</tt>.
\par Example
\verbatim
@@ -175,9 +180,10 @@ intersects(Geometry const& g)
/*!
\brief Generate \c overlaps() predicate.
-Generate a predicate defining Value and Geometry relationship.
-Value will be returned by the query if <tt>bg::overlaps(Indexable, Geometry)</tt>
-returns true.
+Generate a predicate defining Value and Geometry relationship. With this
+predicate query returns indexed Values that overlap passed Geometry.
+Value is returned by the query if <tt>bg::overlaps(Indexable, Geometry)</tt>
+returns <tt>true</tt>.
\par Example
\verbatim
@@ -207,9 +213,10 @@ overlaps(Geometry const& g)
/*!
\brief Generate \c touches() predicate.
-Generate a predicate defining Value and Geometry relationship.
-Value will be returned by the query if <tt>bg::touches(Indexable, Geometry)</tt>
-returns true.
+Generate a predicate defining Value and Geometry relationship. With this
+predicate query returns indexed Values that touch passed Geometry.
+Value is returned by the query if <tt>bg::touches(Indexable, Geometry)</tt>
+returns <tt>true</tt>.
\ingroup predicates
@@ -234,9 +241,10 @@ touches(Geometry const& g)
/*!
\brief Generate \c within() predicate.
-Generate a predicate defining Value and Geometry relationship.
-Value will be returned by the query if <tt>bg::within(Indexable, Geometry)</tt>
-returns true.
+Generate a predicate defining Value and Geometry relationship. With this
+predicate query returns indexed Values that are within passed Geometry.
+Value is returned by the query if <tt>bg::within(Indexable, Geometry)</tt>
+returns <tt>true</tt>.
\par Example
\verbatim