mirror of
https://github.com/boostorg/geometry.git
synced 2026-02-13 00:22:10 +00:00
455b2d9f45
empty() removed. value() parameter renamed to Fun const& fun. operator! moved to index::detail namespace. Reference updated. [SVN r82595]
161 lines
5.5 KiB
Plaintext
161 lines
5.5 KiB
Plaintext
[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
|
|
[/ Generated from xml/group__predicates.xml]
|
|
[section:group__predicates Spatial predicates (boost::geometry::index::)]
|
|
[heading Functions]
|
|
[table
|
|
[[Function][Description]]
|
|
[[[link group__predicates_1ga0a613a7f1d18ac33955bfdc2c5777c61 `covered_by(Geometry const &)`]][Generate [^[link group__predicates_1ga0a613a7f1d18ac33955bfdc2c5777c61 covered_by()]] predicate. ]]
|
|
[[[link group__predicates_1ga351bb3b82e019ff45adf789385b8007d `disjoint(Geometry const &)`]][Generate [^[link group__predicates_1ga351bb3b82e019ff45adf789385b8007d disjoint()]] predicate. ]]
|
|
[[[link group__predicates_1ga7301c50e0272976b9f1434536383e6d0 `intersects(Geometry const &)`]][Generate [^[link group__predicates_1ga7301c50e0272976b9f1434536383e6d0 intersects()]] predicate. ]]
|
|
[[[link group__predicates_1ga5511236f56be1defcccbf11e742ccd88 `overlaps(Geometry const &)`]][Generate [^[link group__predicates_1ga5511236f56be1defcccbf11e742ccd88 overlaps()]] predicate. ]]
|
|
[[[link group__predicates_1gabf9c4e76dd8a09a4c476f2f8fa8a0e4d `within(Geometry const &)`]][Generate [^[link group__predicates_1gabf9c4e76dd8a09a4c476f2f8fa8a0e4d within()]] predicate. ]]
|
|
[[[link group__predicates_1ga8acb81106fce01da72f310184ab4d9ce `value(Fun const &)`]][Generate value predicate. ]]
|
|
]
|
|
|
|
[#group__predicates_1ga0a613a7f1d18ac33955bfdc2c5777c61]
|
|
[section covered_by(Geometry const &)]
|
|
Generate [^[link group__predicates_1ga0a613a7f1d18ac33955bfdc2c5777c61 covered_by()]] predicate.
|
|
|
|
[heading Description]
|
|
Generate a predicate defining Value and Geometry relationship. Value will be returned by the query if [^`bg::covered_by(Indexable, Geometry)`] returns true.[heading Synopsis]
|
|
[pre
|
|
`template<``typename Geometry``>`
|
|
`detail::covered_by<Geometry> boost::geometry::index::covered_by``(``Geometry const &` `g``)`
|
|
]
|
|
|
|
[heading Template parameter(s)]
|
|
[table
|
|
[[Parameter] [Description]]
|
|
[[`Geometry`][The Geometry type.]]
|
|
]
|
|
|
|
[heading Parameter(s)]
|
|
[table
|
|
[[Type][Name][Description]]
|
|
[[`Geometry const &`][ `g` ][The Geometry object. ]]
|
|
]
|
|
[endsect]
|
|
|
|
[#group__predicates_1ga351bb3b82e019ff45adf789385b8007d]
|
|
[section disjoint(Geometry const &)]
|
|
Generate [^[link group__predicates_1ga351bb3b82e019ff45adf789385b8007d disjoint()]] predicate.
|
|
|
|
[heading Description]
|
|
Generate a predicate defining Value and Geometry relationship. Value will be returned by the query if [^`bg::disjoint(Indexable, Geometry)`] returns true.[heading Synopsis]
|
|
[pre
|
|
`template<``typename Geometry``>`
|
|
`detail::disjoint<Geometry> boost::geometry::index::disjoint``(``Geometry const &` `g``)`
|
|
]
|
|
|
|
[heading Template parameter(s)]
|
|
[table
|
|
[[Parameter] [Description]]
|
|
[[`Geometry`][The Geometry type.]]
|
|
]
|
|
|
|
[heading Parameter(s)]
|
|
[table
|
|
[[Type][Name][Description]]
|
|
[[`Geometry const &`][ `g` ][The Geometry object. ]]
|
|
]
|
|
[endsect]
|
|
|
|
[#group__predicates_1ga7301c50e0272976b9f1434536383e6d0]
|
|
[section intersects(Geometry const &)]
|
|
Generate [^[link group__predicates_1ga7301c50e0272976b9f1434536383e6d0 intersects()]] predicate.
|
|
|
|
[heading Description]
|
|
Generate a predicate defining Value and Geometry relationship. Value will be returned by the query if [^`bg::intersects(Indexable, Geometry)`] returns true.[heading Synopsis]
|
|
[pre
|
|
`template<``typename Geometry``>`
|
|
`detail::intersects<Geometry> boost::geometry::index::intersects``(``Geometry const &` `g``)`
|
|
]
|
|
|
|
[heading Template parameter(s)]
|
|
[table
|
|
[[Parameter] [Description]]
|
|
[[`Geometry`][The Geometry type.]]
|
|
]
|
|
|
|
[heading Parameter(s)]
|
|
[table
|
|
[[Type][Name][Description]]
|
|
[[`Geometry const &`][ `g` ][The Geometry object. ]]
|
|
]
|
|
[endsect]
|
|
|
|
[#group__predicates_1ga5511236f56be1defcccbf11e742ccd88]
|
|
[section overlaps(Geometry const &)]
|
|
Generate [^[link group__predicates_1ga5511236f56be1defcccbf11e742ccd88 overlaps()]] predicate.
|
|
|
|
[heading Description]
|
|
Generate a predicate defining Value and Geometry relationship. Value will be returned by the query if [^`bg::overlaps(Indexable, Geometry)`] returns true.[heading Synopsis]
|
|
[pre
|
|
`template<``typename Geometry``>`
|
|
`detail::overlaps<Geometry> boost::geometry::index::overlaps``(``Geometry const &` `g``)`
|
|
]
|
|
|
|
[heading Template parameter(s)]
|
|
[table
|
|
[[Parameter] [Description]]
|
|
[[`Geometry`][The Geometry type.]]
|
|
]
|
|
|
|
[heading Parameter(s)]
|
|
[table
|
|
[[Type][Name][Description]]
|
|
[[`Geometry const &`][ `g` ][The Geometry object. ]]
|
|
]
|
|
[endsect]
|
|
|
|
[#group__predicates_1gabf9c4e76dd8a09a4c476f2f8fa8a0e4d]
|
|
[section within(Geometry const &)]
|
|
Generate [^[link group__predicates_1gabf9c4e76dd8a09a4c476f2f8fa8a0e4d within()]] predicate.
|
|
|
|
[heading Description]
|
|
Generate a predicate defining Value and Geometry relationship. Value will be returned by the query if [^`bg::within(Indexable, Geometry)`] returns true.[heading Synopsis]
|
|
[pre
|
|
`template<``typename Geometry``>`
|
|
`detail::within<Geometry> boost::geometry::index::within``(``Geometry const &` `g``)`
|
|
]
|
|
|
|
[heading Template parameter(s)]
|
|
[table
|
|
[[Parameter] [Description]]
|
|
[[`Geometry`][The Geometry type.]]
|
|
]
|
|
|
|
[heading Parameter(s)]
|
|
[table
|
|
[[Type][Name][Description]]
|
|
[[`Geometry const &`][ `g` ][The Geometry object. ]]
|
|
]
|
|
[endsect]
|
|
|
|
[#group__predicates_1ga8acb81106fce01da72f310184ab4d9ce]
|
|
[section value(Fun const &)]
|
|
Generate value predicate.
|
|
|
|
[heading Description]
|
|
A wrapper around user-defined functor describing if Value should be returned by spatial query.[heading Synopsis]
|
|
[pre
|
|
`template<``typename Fun``>`
|
|
`detail::value<Fun> boost::geometry::index::value``(``Fun const &` `fun``)`
|
|
]
|
|
|
|
[heading Template parameter(s)]
|
|
[table
|
|
[[Parameter] [Description]]
|
|
[[`Fun`][Functor type.]]
|
|
]
|
|
|
|
[heading Parameter(s)]
|
|
[table
|
|
[[Type][Name][Description]]
|
|
[[`Fun const &`][ `fun` ][The functor. ]]
|
|
]
|
|
[endsect]
|
|
|
|
[endsect]
|
|
|