diff --git a/doc/Jamfile.v2 b/doc/Jamfile.v2 index b30e99393..94f0c55a1 100644 --- a/doc/Jamfile.v2 +++ b/doc/Jamfile.v2 @@ -8,18 +8,56 @@ project geometry_index/doc ; +import doxygen ; import boostbook ; import quickbook ; +using auto-index ; + +path-constant images_location : html ; +path-constant here : . ; + +doxygen autodoc + : + [ glob + ../boost/geometry/extensions/index/rtree/rtree.hpp +# ../boost/geometry/extensions/index/predicates.hpp +# ../boost/geometry/extensions/index/distance_predicates.hpp +# ../boost/geometry/extensions/index/inserter.hpp +# ../boost/geometry/extensions/index/adaptors/nearest_query.hpp +# ../boost/geometry/extensions/index/adaptors/spatial_query.hpp +# ../boost/geometry/extensions/index/translator/def.hpp +# ../boost/geometry/extensions/index/translator/index.hpp + ] + : + EXTRACT_ALL=NO + EXTRACT_PRIVATE=NO + HIDE_UNDOC_MEMBERS=YES + HIDE_UNDOC_CLASSES=YES + ENABLE_PREPROCESSING=YES + EXPAND_ONLY_PREDEF=YES + MACRO_EXPANSION=YES + "PREDEFINED=\"BOOST_RV_REF(T)=T &&\" \\ + \"BOOST_RV_REF_BEG=\" \\ + \"BOOST_RV_REF_END=&&\" \\ + \"BOOST_COPY_ASSIGN_REF(T)=const T &\" \\ + \"BOOST_RV_REF_2_TEMPL_ARGS(T,a,b)=T &&\" \\ + \"BOOST_RV_REF_3_TEMPL_ARGS(T,a,b,c)=TT &&\" \\ + \"BOOST_FWD_REF(a)=a &&\"" + "boost.doxygen.reftitle=Header Reference" + ; + +xml index : index.qbk + : + ../../tools/auto_index/include + ; + boostbook geometry_index-doc : - index.qbk + index : Jamfile.v2 -# off -# on -# off -# index.on.type=1 + html pdf:boost.url.prefix=http://www.boost.org/doc/libs/release/doc/html chunk.section.depth=2 @@ -28,6 +66,15 @@ boostbook geometry_index-doc toc.max.depth=2 generate.section.toc.level=4 boost.root=http://www.boost.org/doc/libs/release + + autodoc + on + on + pdf:off + html:on + $(here)/index.idx + "$(here)/.." + enable_index $(here) ; diff --git a/doc/html/boost/geometry/index/box.html b/doc/html/boost/geometry/index/box.html new file mode 100644 index 000000000..5d3b98acc --- /dev/null +++ b/doc/html/boost/geometry/index/box.html @@ -0,0 +1,84 @@ + + + +Function template box + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHome +
+
+
+
+

Function template box

+

boost::geometry::index::box

+
+

Synopsis

+
// In header: <boost/geometry/extensions/index/rtree/rtree.hpp>
+
+
+template<typename Value, typename Options, typename Translator, 
+         typename Allocator> 
+  rtree< Value, Options, Translator, Allocator >::box_type 
+  box(rtree< Value, Options, Translator, Allocator > const & tree);
+
+

Description

+

Description: Get the box containing all stored values or an invalid box if the index has no values.

+

+ +

+
++++ + + + + + + + + + + +

Parameters:

++++ + + + + +

tree

The spatial index.

Returns:

The box containing all stored values or an invalid box.

+
+
+ + + +
Copyright © 2011, 2012 Adam Wulkiewicz
Copyright © 2008 Federico J. Fernandez

+ Distributed under 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) +

+
+
+
+PrevUpHome +
+ + diff --git a/doc/html/boost/geometry/index/clear.html b/doc/html/boost/geometry/index/clear.html new file mode 100644 index 000000000..ff33614fd --- /dev/null +++ b/doc/html/boost/geometry/index/clear.html @@ -0,0 +1,77 @@ + + + +Function template clear + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Function template clear

+

boost::geometry::index::clear

+
+

Synopsis

+
// In header: <boost/geometry/extensions/index/rtree/rtree.hpp>
+
+
+template<typename Value, typename Options, typename Translator, 
+         typename Allocator> 
+  void clear(rtree< Value, Options, Translator, Allocator > & tree);
+
+

Description

+

Description: Remove all values from the index.

+

+

+
++++ + + + + +

Parameters:

++++ + + + + +

tree

The spatial index.

+
+
+ + + +
Copyright © 2011, 2012 Adam Wulkiewicz
Copyright © 2008 Federico J. Fernandez

+ Distributed under 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) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/doc/html/boost/geometry/index/empty.html b/doc/html/boost/geometry/index/empty.html new file mode 100644 index 000000000..ad69355a4 --- /dev/null +++ b/doc/html/boost/geometry/index/empty.html @@ -0,0 +1,84 @@ + + + +Function template empty + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Function template empty

+

boost::geometry::index::empty

+
+

Synopsis

+
// In header: <boost/geometry/extensions/index/rtree/rtree.hpp>
+
+
+template<typename Value, typename Options, typename Translator, 
+         typename Allocator> 
+  bool empty(rtree< Value, Options, Translator, Allocator > const & tree);
+
+

Description

+

Description: Query if there are no values stored in the index.

+

+ +

+
++++ + + + + + + + + + + +

Parameters:

++++ + + + + +

tree

The spatial index.

Returns:

true if there are no values in the index.

+
+
+ + + +
Copyright © 2011, 2012 Adam Wulkiewicz
Copyright © 2008 Federico J. Fernandez

+ Distributed under 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) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/doc/html/boost/geometry/index/insert_id265665.html b/doc/html/boost/geometry/index/insert_id265665.html new file mode 100644 index 000000000..c6a038d1f --- /dev/null +++ b/doc/html/boost/geometry/index/insert_id265665.html @@ -0,0 +1,84 @@ + + + +Function template insert + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Function template insert

+

boost::geometry::index::insert

+
+

Synopsis

+
// In header: <boost/geometry/extensions/index/rtree/rtree.hpp>
+
+
+template<typename Value, typename Options, typename Translator, 
+         typename Allocator> 
+  void insert(rtree< Value, Options, Translator, Allocator > & tree, 
+              Value const & v);
+
+

Description

+

Description: Insert a value to the index.

+

+

+
++++ + + + + +

Parameters:

++++ + + + + + + + + + + +

tree

The spatial index.

v

The value which will be stored in the index.

+
+
+ + + +
Copyright © 2011, 2012 Adam Wulkiewicz
Copyright © 2008 Federico J. Fernandez

+ Distributed under 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) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/doc/html/boost/geometry/index/insert_id265715.html b/doc/html/boost/geometry/index/insert_id265715.html new file mode 100644 index 000000000..127367946 --- /dev/null +++ b/doc/html/boost/geometry/index/insert_id265715.html @@ -0,0 +1,88 @@ + + + +Function template insert + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Function template insert

+

boost::geometry::index::insert

+
+

Synopsis

+
// In header: <boost/geometry/extensions/index/rtree/rtree.hpp>
+
+
+template<typename Value, typename Options, typename Translator, 
+         typename Allocator, typename Iterator> 
+  void insert(rtree< Value, Options, Translator, Allocator > & tree, 
+              Iterator first, Iterator last);
+
+

Description

+

Description: Insert a range of values to the index.

+

+

+
++++ + + + + +

Parameters:

++++ + + + + + + + + + + + + + + +

first

The beginning of the range of values.

last

The end of the range of values.

tree

The spatial index.

+
+
+ + + +
Copyright © 2011, 2012 Adam Wulkiewicz
Copyright © 2008 Federico J. Fernandez

+ Distributed under 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) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/doc/html/boost/geometry/index/insert_id265778.html b/doc/html/boost/geometry/index/insert_id265778.html new file mode 100644 index 000000000..1464dde23 --- /dev/null +++ b/doc/html/boost/geometry/index/insert_id265778.html @@ -0,0 +1,84 @@ + + + +Function template insert + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Function template insert

+

boost::geometry::index::insert

+
+

Synopsis

+
// In header: <boost/geometry/extensions/index/rtree/rtree.hpp>
+
+
+template<typename Value, typename Options, typename Translator, 
+         typename Allocator, typename Range> 
+  void insert(rtree< Value, Options, Translator, Allocator > & tree, 
+              Range const & rng);
+
+

Description

+

Description: Insert a range of values to the index.

+

+

+
++++ + + + + +

Parameters:

++++ + + + + + + + + + + +

rng

The range of values.

tree

The spatial index.

+
+
+ + + +
Copyright © 2011, 2012 Adam Wulkiewicz
Copyright © 2008 Federico J. Fernandez

+ Distributed under 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) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/doc/html/boost/geometry/index/insert_id274403.html b/doc/html/boost/geometry/index/insert_id274403.html new file mode 100644 index 000000000..1a7819d7c --- /dev/null +++ b/doc/html/boost/geometry/index/insert_id274403.html @@ -0,0 +1,84 @@ + + + +Function template insert + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Function template insert

+

boost::geometry::index::insert

+
+

Synopsis

+
// In header: <boost/geometry/extensions/index/rtree/rtree.hpp>
+
+
+template<typename Value, typename Options, typename Translator, 
+         typename Allocator> 
+  void insert(rtree< Value, Options, Translator, Allocator > & tree, 
+              Value const & v);
+
+

Description

+

Description: Insert a value to the index.

+

+

+
++++ + + + + +

Parameters:

++++ + + + + + + + + + + +

tree

The spatial index.

v

The value which will be stored in the index.

+
+
+ + + +
Copyright © 2011, 2012 Adam Wulkiewicz
Copyright © 2008 Federico J. Fernandez

+ Distributed under 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) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/doc/html/boost/geometry/index/insert_id274453.html b/doc/html/boost/geometry/index/insert_id274453.html new file mode 100644 index 000000000..e79e1d719 --- /dev/null +++ b/doc/html/boost/geometry/index/insert_id274453.html @@ -0,0 +1,88 @@ + + + +Function template insert + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Function template insert

+

boost::geometry::index::insert

+
+

Synopsis

+
// In header: <boost/geometry/extensions/index/rtree/rtree.hpp>
+
+
+template<typename Value, typename Options, typename Translator, 
+         typename Allocator, typename Iterator> 
+  void insert(rtree< Value, Options, Translator, Allocator > & tree, 
+              Iterator first, Iterator last);
+
+

Description

+

Description: Insert a range of values to the index.

+

+

+
++++ + + + + +

Parameters:

++++ + + + + + + + + + + + + + + +

first

The beginning of the range of values.

last

The end of the range of values.

tree

The spatial index.

+
+
+ + + +
Copyright © 2011, 2012 Adam Wulkiewicz
Copyright © 2008 Federico J. Fernandez

+ Distributed under 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) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/doc/html/boost/geometry/index/insert_id274516.html b/doc/html/boost/geometry/index/insert_id274516.html new file mode 100644 index 000000000..3afa7785f --- /dev/null +++ b/doc/html/boost/geometry/index/insert_id274516.html @@ -0,0 +1,84 @@ + + + +Function template insert + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Function template insert

+

boost::geometry::index::insert

+
+

Synopsis

+
// In header: <boost/geometry/extensions/index/rtree/rtree.hpp>
+
+
+template<typename Value, typename Options, typename Translator, 
+         typename Allocator, typename Range> 
+  void insert(rtree< Value, Options, Translator, Allocator > & tree, 
+              Range const & rng);
+
+

Description

+

Description: Insert a range of values to the index.

+

+

+
++++ + + + + +

Parameters:

++++ + + + + + + + + + + +

rng

The range of values.

tree

The spatial index.

+
+
+ + + +
Copyright © 2011, 2012 Adam Wulkiewicz
Copyright © 2008 Federico J. Fernandez

+ Distributed under 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) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/doc/html/boost/geometry/index/insert_id278981.html b/doc/html/boost/geometry/index/insert_id278981.html new file mode 100644 index 000000000..63d268a49 --- /dev/null +++ b/doc/html/boost/geometry/index/insert_id278981.html @@ -0,0 +1,84 @@ + + + +Function template insert + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Function template insert

+

boost::geometry::index::insert

+
+

Synopsis

+
// In header: <boost/geometry/extensions/index/rtree/rtree.hpp>
+
+
+template<typename Value, typename Options, typename Translator, 
+         typename Allocator> 
+  void insert(rtree< Value, Options, Translator, Allocator > & tree, 
+              Value const & v);
+
+

Description

+

Description: Insert a value to the index.

+

+

+
++++ + + + + +

Parameters:

++++ + + + + + + + + + + +

tree

The spatial index.

v

The value which will be stored in the index.

+
+
+ + + +
Copyright © 2011, 2012 Adam Wulkiewicz
Copyright © 2008 Federico J. Fernandez

+ Distributed under 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) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/doc/html/boost/geometry/index/insert_id279031.html b/doc/html/boost/geometry/index/insert_id279031.html new file mode 100644 index 000000000..24867e2c1 --- /dev/null +++ b/doc/html/boost/geometry/index/insert_id279031.html @@ -0,0 +1,88 @@ + + + +Function template insert + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Function template insert

+

boost::geometry::index::insert

+
+

Synopsis

+
// In header: <boost/geometry/extensions/index/rtree/rtree.hpp>
+
+
+template<typename Value, typename Options, typename Translator, 
+         typename Allocator, typename Iterator> 
+  void insert(rtree< Value, Options, Translator, Allocator > & tree, 
+              Iterator first, Iterator last);
+
+

Description

+

Description: Insert a range of values to the index.

+

+

+
++++ + + + + +

Parameters:

++++ + + + + + + + + + + + + + + +

first

The beginning of the range of values.

last

The end of the range of values.

tree

The spatial index.

+
+
+ + + +
Copyright © 2011, 2012 Adam Wulkiewicz
Copyright © 2008 Federico J. Fernandez

+ Distributed under 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) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/doc/html/boost/geometry/index/insert_id279094.html b/doc/html/boost/geometry/index/insert_id279094.html new file mode 100644 index 000000000..b3f0756fa --- /dev/null +++ b/doc/html/boost/geometry/index/insert_id279094.html @@ -0,0 +1,84 @@ + + + +Function template insert + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Function template insert

+

boost::geometry::index::insert

+
+

Synopsis

+
// In header: <boost/geometry/extensions/index/rtree/rtree.hpp>
+
+
+template<typename Value, typename Options, typename Translator, 
+         typename Allocator, typename Range> 
+  void insert(rtree< Value, Options, Translator, Allocator > & tree, 
+              Range const & rng);
+
+

Description

+

Description: Insert a range of values to the index.

+

+

+
++++ + + + + +

Parameters:

++++ + + + + + + + + + + +

rng

The range of values.

tree

The spatial index.

+
+
+ + + +
Copyright © 2011, 2012 Adam Wulkiewicz
Copyright © 2008 Federico J. Fernandez

+ Distributed under 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) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/doc/html/boost/geometry/index/insert_id322710.html b/doc/html/boost/geometry/index/insert_id322710.html new file mode 100644 index 000000000..cae00e49e --- /dev/null +++ b/doc/html/boost/geometry/index/insert_id322710.html @@ -0,0 +1,84 @@ + + + +Function template insert + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Function template insert

+

boost::geometry::index::insert

+
+

Synopsis

+
// In header: <boost/geometry/extensions/index/rtree/rtree.hpp>
+
+
+template<typename Value, typename Options, typename Translator, 
+         typename Allocator> 
+  void insert(rtree< Value, Options, Translator, Allocator > & tree, 
+              Value const & v);
+
+

Description

+

Description: Insert a value to the index.

+

+

+
++++ + + + + +

Parameters:

++++ + + + + + + + + + + +

tree

The spatial index.

v

The value which will be stored in the index.

+
+
+ + + +
Copyright © 2011, 2012 Adam Wulkiewicz
Copyright © 2008 Federico J. Fernandez

+ Distributed under 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) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/doc/html/boost/geometry/index/insert_id322760.html b/doc/html/boost/geometry/index/insert_id322760.html new file mode 100644 index 000000000..08e77859d --- /dev/null +++ b/doc/html/boost/geometry/index/insert_id322760.html @@ -0,0 +1,88 @@ + + + +Function template insert + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Function template insert

+

boost::geometry::index::insert

+
+

Synopsis

+
// In header: <boost/geometry/extensions/index/rtree/rtree.hpp>
+
+
+template<typename Value, typename Options, typename Translator, 
+         typename Allocator, typename Iterator> 
+  void insert(rtree< Value, Options, Translator, Allocator > & tree, 
+              Iterator first, Iterator last);
+
+

Description

+

Description: Insert a range of values to the index.

+

+

+
++++ + + + + +

Parameters:

++++ + + + + + + + + + + + + + + +

first

The beginning of the range of values.

last

The end of the range of values.

tree

The spatial index.

+
+
+ + + +
Copyright © 2011, 2012 Adam Wulkiewicz
Copyright © 2008 Federico J. Fernandez

+ Distributed under 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) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/doc/html/boost/geometry/index/insert_id322823.html b/doc/html/boost/geometry/index/insert_id322823.html new file mode 100644 index 000000000..9baad1c89 --- /dev/null +++ b/doc/html/boost/geometry/index/insert_id322823.html @@ -0,0 +1,84 @@ + + + +Function template insert + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Function template insert

+

boost::geometry::index::insert

+
+

Synopsis

+
// In header: <boost/geometry/extensions/index/rtree/rtree.hpp>
+
+
+template<typename Value, typename Options, typename Translator, 
+         typename Allocator, typename Range> 
+  void insert(rtree< Value, Options, Translator, Allocator > & tree, 
+              Range const & rng);
+
+

Description

+

Description: Insert a range of values to the index.

+

+

+
++++ + + + + +

Parameters:

++++ + + + + + + + + + + +

rng

The range of values.

tree

The spatial index.

+
+
+ + + +
Copyright © 2011, 2012 Adam Wulkiewicz
Copyright © 2008 Federico J. Fernandez

+ Distributed under 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) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/doc/html/boost/geometry/index/nearest_query_id266086.html b/doc/html/boost/geometry/index/nearest_query_id266086.html new file mode 100644 index 000000000..441928484 --- /dev/null +++ b/doc/html/boost/geometry/index/nearest_query_id266086.html @@ -0,0 +1,95 @@ + + + +Function template nearest_query + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Function template nearest_query

+

boost::geometry::index::nearest_query

+
+

Synopsis

+
// In header: <boost/geometry/extensions/index/rtree/rtree.hpp>
+
+
+template<typename Value, typename Options, typename Translator, 
+         typename Allocator, typename DistancesPredicates> 
+  size_t nearest_query(rtree< Value, Options, Translator, Allocator > const & tree, 
+                       DistancesPredicates const & dpred, Value & v);
+
+

Description

+

Description: Find the value meeting distances predicates.

+

+ +

+
++++ + + + + + + + + + + +

Parameters:

++++ + + + + + + + + + + + + + + +

dpred

The distances predicates.

tree

The spatial index.

v

The result.

Returns:

The number of found values.

+
+
+ + + +
Copyright © 2011, 2012 Adam Wulkiewicz
Copyright © 2008 Federico J. Fernandez

+ Distributed under 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) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/doc/html/boost/geometry/index/nearest_query_id266152.html b/doc/html/boost/geometry/index/nearest_query_id266152.html new file mode 100644 index 000000000..3e6cf22b8 --- /dev/null +++ b/doc/html/boost/geometry/index/nearest_query_id266152.html @@ -0,0 +1,101 @@ + + + +Function template nearest_query + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Function template nearest_query

+

boost::geometry::index::nearest_query

+
+

Synopsis

+
// In header: <boost/geometry/extensions/index/rtree/rtree.hpp>
+
+
+template<typename Value, typename Options, typename Translator, 
+         typename Allocator, typename DistancesPredicates, 
+         typename Predicates> 
+  size_t nearest_query(rtree< Value, Options, Translator, Allocator > const & tree, 
+                       DistancesPredicates const & dpred, 
+                       Predicates const & pred, Value & v);
+
+

Description

+

Description: Find the value meeting distances and spatial predicates.

+

+ +

+
++++ + + + + + + + + + + +

Parameters:

++++ + + + + + + + + + + + + + + + + + + +

dpred

The distances predicates.

pred

The spatial predicates.

tree

The spatial index.

v

The result.

Returns:

The number of found values.

+
+
+ + + +
Copyright © 2011, 2012 Adam Wulkiewicz
Copyright © 2008 Federico J. Fernandez

+ Distributed under 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) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/doc/html/boost/geometry/index/nearest_query_id266231.html b/doc/html/boost/geometry/index/nearest_query_id266231.html new file mode 100644 index 000000000..6f55c6bb0 --- /dev/null +++ b/doc/html/boost/geometry/index/nearest_query_id266231.html @@ -0,0 +1,100 @@ + + + +Function template nearest_query + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Function template nearest_query

+

boost::geometry::index::nearest_query

+
+

Synopsis

+
// In header: <boost/geometry/extensions/index/rtree/rtree.hpp>
+
+
+template<typename Value, typename Options, typename Translator, 
+         typename Allocator, typename DistancesPredicates, typename OutIter> 
+  size_t nearest_query(rtree< Value, Options, Translator, Allocator > const & tree, 
+                       DistancesPredicates const & dpred, size_t k, 
+                       OutIter out_it);
+
+

Description

+

Description: Find k values meeting distances predicates.

+

+ +

+
++++ + + + + + + + + + + +

Parameters:

++++ + + + + + + + + + + + + + + + + + + +

dpred

The distances predicates.

k

The max number of values.

out_it

The output iterator of the result range.

tree

The spatial index.

Returns:

The number of found values.

+
+
+ + + +
Copyright © 2011, 2012 Adam Wulkiewicz
Copyright © 2008 Federico J. Fernandez

+ Distributed under 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) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/doc/html/boost/geometry/index/nearest_query_id266309.html b/doc/html/boost/geometry/index/nearest_query_id266309.html new file mode 100644 index 000000000..91e32202b --- /dev/null +++ b/doc/html/boost/geometry/index/nearest_query_id266309.html @@ -0,0 +1,105 @@ + + + +Function template nearest_query + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Function template nearest_query

+

boost::geometry::index::nearest_query

+
+

Synopsis

+
// In header: <boost/geometry/extensions/index/rtree/rtree.hpp>
+
+
+template<typename Value, typename Options, typename Translator, 
+         typename Allocator, typename DistancesPredicates, 
+         typename Predicates, typename OutIter> 
+  size_t nearest_query(rtree< Value, Options, Translator, Allocator > const & tree, 
+                       DistancesPredicates const & dpred, size_t k, 
+                       Predicates const & pred, OutIter out_it);
+
+

Description

+

Description: Find k values meeting distances and spatial predicates.

+

+ +

+
++++ + + + + + + + + + + +

Parameters:

++++ + + + + + + + + + + + + + + + + + + + + + + +

dpred

The distances predicates.

k

The max number of values.

out_it

The output iterator of the result range.

pred

The spatial predicates.

tree

The spatial index.

Returns:

The number of found values.

+
+
+ + + +
Copyright © 2011, 2012 Adam Wulkiewicz
Copyright © 2008 Federico J. Fernandez

+ Distributed under 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) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/doc/html/boost/geometry/index/nearest_query_id274824.html b/doc/html/boost/geometry/index/nearest_query_id274824.html new file mode 100644 index 000000000..82b6377eb --- /dev/null +++ b/doc/html/boost/geometry/index/nearest_query_id274824.html @@ -0,0 +1,95 @@ + + + +Function template nearest_query + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Function template nearest_query

+

boost::geometry::index::nearest_query

+
+

Synopsis

+
// In header: <boost/geometry/extensions/index/rtree/rtree.hpp>
+
+
+template<typename Value, typename Options, typename Translator, 
+         typename Allocator, typename DistancesPredicates> 
+  size_t nearest_query(rtree< Value, Options, Translator, Allocator > const & tree, 
+                       DistancesPredicates const & dpred, Value & v);
+
+

Description

+

Description: Find the value meeting distances predicates.

+

+ +

+
++++ + + + + + + + + + + +

Parameters:

++++ + + + + + + + + + + + + + + +

dpred

The distances predicates.

tree

The spatial index.

v

The result.

Returns:

The number of found values.

+
+
+ + + +
Copyright © 2011, 2012 Adam Wulkiewicz
Copyright © 2008 Federico J. Fernandez

+ Distributed under 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) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/doc/html/boost/geometry/index/nearest_query_id274890.html b/doc/html/boost/geometry/index/nearest_query_id274890.html new file mode 100644 index 000000000..858472205 --- /dev/null +++ b/doc/html/boost/geometry/index/nearest_query_id274890.html @@ -0,0 +1,101 @@ + + + +Function template nearest_query + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Function template nearest_query

+

boost::geometry::index::nearest_query

+
+

Synopsis

+
// In header: <boost/geometry/extensions/index/rtree/rtree.hpp>
+
+
+template<typename Value, typename Options, typename Translator, 
+         typename Allocator, typename DistancesPredicates, 
+         typename Predicates> 
+  size_t nearest_query(rtree< Value, Options, Translator, Allocator > const & tree, 
+                       DistancesPredicates const & dpred, 
+                       Predicates const & pred, Value & v);
+
+

Description

+

Description: Find the value meeting distances and spatial predicates.

+

+ +

+
++++ + + + + + + + + + + +

Parameters:

++++ + + + + + + + + + + + + + + + + + + +

dpred

The distances predicates.

pred

The spatial predicates.

tree

The spatial index.

v

The result.

Returns:

The number of found values.

+
+
+ + + +
Copyright © 2011, 2012 Adam Wulkiewicz
Copyright © 2008 Federico J. Fernandez

+ Distributed under 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) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/doc/html/boost/geometry/index/nearest_query_id274969.html b/doc/html/boost/geometry/index/nearest_query_id274969.html new file mode 100644 index 000000000..ba99082f0 --- /dev/null +++ b/doc/html/boost/geometry/index/nearest_query_id274969.html @@ -0,0 +1,100 @@ + + + +Function template nearest_query + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Function template nearest_query

+

boost::geometry::index::nearest_query

+
+

Synopsis

+
// In header: <boost/geometry/extensions/index/rtree/rtree.hpp>
+
+
+template<typename Value, typename Options, typename Translator, 
+         typename Allocator, typename DistancesPredicates, typename OutIter> 
+  size_t nearest_query(rtree< Value, Options, Translator, Allocator > const & tree, 
+                       DistancesPredicates const & dpred, size_t k, 
+                       OutIter out_it);
+
+

Description

+

Description: Find k values meeting distances predicates.

+

+ +

+
++++ + + + + + + + + + + +

Parameters:

++++ + + + + + + + + + + + + + + + + + + +

dpred

The distances predicates.

k

The max number of values.

out_it

The output iterator of the result range.

tree

The spatial index.

Returns:

The number of found values.

+
+
+ + + +
Copyright © 2011, 2012 Adam Wulkiewicz
Copyright © 2008 Federico J. Fernandez

+ Distributed under 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) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/doc/html/boost/geometry/index/nearest_query_id275047.html b/doc/html/boost/geometry/index/nearest_query_id275047.html new file mode 100644 index 000000000..4d1773475 --- /dev/null +++ b/doc/html/boost/geometry/index/nearest_query_id275047.html @@ -0,0 +1,105 @@ + + + +Function template nearest_query + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Function template nearest_query

+

boost::geometry::index::nearest_query

+
+

Synopsis

+
// In header: <boost/geometry/extensions/index/rtree/rtree.hpp>
+
+
+template<typename Value, typename Options, typename Translator, 
+         typename Allocator, typename DistancesPredicates, 
+         typename Predicates, typename OutIter> 
+  size_t nearest_query(rtree< Value, Options, Translator, Allocator > const & tree, 
+                       DistancesPredicates const & dpred, size_t k, 
+                       Predicates const & pred, OutIter out_it);
+
+

Description

+

Description: Find k values meeting distances and spatial predicates.

+

+ +

+
++++ + + + + + + + + + + +

Parameters:

++++ + + + + + + + + + + + + + + + + + + + + + + +

dpred

The distances predicates.

k

The max number of values.

out_it

The output iterator of the result range.

pred

The spatial predicates.

tree

The spatial index.

Returns:

The number of found values.

+
+
+ + + +
Copyright © 2011, 2012 Adam Wulkiewicz
Copyright © 2008 Federico J. Fernandez

+ Distributed under 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) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/doc/html/boost/geometry/index/nearest_query_id279402.html b/doc/html/boost/geometry/index/nearest_query_id279402.html new file mode 100644 index 000000000..23c8db313 --- /dev/null +++ b/doc/html/boost/geometry/index/nearest_query_id279402.html @@ -0,0 +1,95 @@ + + + +Function template nearest_query + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Function template nearest_query

+

boost::geometry::index::nearest_query

+
+

Synopsis

+
// In header: <boost/geometry/extensions/index/rtree/rtree.hpp>
+
+
+template<typename Value, typename Options, typename Translator, 
+         typename Allocator, typename DistancesPredicates> 
+  size_t nearest_query(rtree< Value, Options, Translator, Allocator > const & tree, 
+                       DistancesPredicates const & dpred, Value & v);
+
+

Description

+

Description: Find the value meeting distances predicates.

+

+ +

+
++++ + + + + + + + + + + +

Parameters:

++++ + + + + + + + + + + + + + + +

dpred

The distances predicates.

tree

The spatial index.

v

The result.

Returns:

The number of found values.

+
+
+ + + +
Copyright © 2011, 2012 Adam Wulkiewicz
Copyright © 2008 Federico J. Fernandez

+ Distributed under 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) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/doc/html/boost/geometry/index/nearest_query_id279468.html b/doc/html/boost/geometry/index/nearest_query_id279468.html new file mode 100644 index 000000000..25dca712e --- /dev/null +++ b/doc/html/boost/geometry/index/nearest_query_id279468.html @@ -0,0 +1,101 @@ + + + +Function template nearest_query + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Function template nearest_query

+

boost::geometry::index::nearest_query

+
+

Synopsis

+
// In header: <boost/geometry/extensions/index/rtree/rtree.hpp>
+
+
+template<typename Value, typename Options, typename Translator, 
+         typename Allocator, typename DistancesPredicates, 
+         typename Predicates> 
+  size_t nearest_query(rtree< Value, Options, Translator, Allocator > const & tree, 
+                       DistancesPredicates const & dpred, 
+                       Predicates const & pred, Value & v);
+
+

Description

+

Description: Find the value meeting distances and spatial predicates.

+

+ +

+
++++ + + + + + + + + + + +

Parameters:

++++ + + + + + + + + + + + + + + + + + + +

dpred

The distances predicates.

pred

The spatial predicates.

tree

The spatial index.

v

The result.

Returns:

The number of found values.

+
+
+ + + +
Copyright © 2011, 2012 Adam Wulkiewicz
Copyright © 2008 Federico J. Fernandez

+ Distributed under 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) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/doc/html/boost/geometry/index/nearest_query_id279547.html b/doc/html/boost/geometry/index/nearest_query_id279547.html new file mode 100644 index 000000000..a4140c00e --- /dev/null +++ b/doc/html/boost/geometry/index/nearest_query_id279547.html @@ -0,0 +1,100 @@ + + + +Function template nearest_query + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Function template nearest_query

+

boost::geometry::index::nearest_query

+
+

Synopsis

+
// In header: <boost/geometry/extensions/index/rtree/rtree.hpp>
+
+
+template<typename Value, typename Options, typename Translator, 
+         typename Allocator, typename DistancesPredicates, typename OutIter> 
+  size_t nearest_query(rtree< Value, Options, Translator, Allocator > const & tree, 
+                       DistancesPredicates const & dpred, size_t k, 
+                       OutIter out_it);
+
+

Description

+

Description: Find k values meeting distances predicates.

+

+ +

+
++++ + + + + + + + + + + +

Parameters:

++++ + + + + + + + + + + + + + + + + + + +

dpred

The distances predicates.

k

The max number of values.

out_it

The output iterator of the result range.

tree

The spatial index.

Returns:

The number of found values.

+
+
+ + + +
Copyright © 2011, 2012 Adam Wulkiewicz
Copyright © 2008 Federico J. Fernandez

+ Distributed under 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) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/doc/html/boost/geometry/index/nearest_query_id279625.html b/doc/html/boost/geometry/index/nearest_query_id279625.html new file mode 100644 index 000000000..95752f7be --- /dev/null +++ b/doc/html/boost/geometry/index/nearest_query_id279625.html @@ -0,0 +1,105 @@ + + + +Function template nearest_query + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Function template nearest_query

+

boost::geometry::index::nearest_query

+
+

Synopsis

+
// In header: <boost/geometry/extensions/index/rtree/rtree.hpp>
+
+
+template<typename Value, typename Options, typename Translator, 
+         typename Allocator, typename DistancesPredicates, 
+         typename Predicates, typename OutIter> 
+  size_t nearest_query(rtree< Value, Options, Translator, Allocator > const & tree, 
+                       DistancesPredicates const & dpred, size_t k, 
+                       Predicates const & pred, OutIter out_it);
+
+

Description

+

Description: Find k values meeting distances and spatial predicates.

+

+ +

+
++++ + + + + + + + + + + +

Parameters:

++++ + + + + + + + + + + + + + + + + + + + + + + +

dpred

The distances predicates.

k

The max number of values.

out_it

The output iterator of the result range.

pred

The spatial predicates.

tree

The spatial index.

Returns:

The number of found values.

+
+
+ + + +
Copyright © 2011, 2012 Adam Wulkiewicz
Copyright © 2008 Federico J. Fernandez

+ Distributed under 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) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/doc/html/boost/geometry/index/nearest_query_id323131.html b/doc/html/boost/geometry/index/nearest_query_id323131.html new file mode 100644 index 000000000..12f91686b --- /dev/null +++ b/doc/html/boost/geometry/index/nearest_query_id323131.html @@ -0,0 +1,95 @@ + + + +Function template nearest_query + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Function template nearest_query

+

boost::geometry::index::nearest_query

+
+

Synopsis

+
// In header: <boost/geometry/extensions/index/rtree/rtree.hpp>
+
+
+template<typename Value, typename Options, typename Translator, 
+         typename Allocator, typename DistancesPredicates> 
+  size_t nearest_query(rtree< Value, Options, Translator, Allocator > const & tree, 
+                       DistancesPredicates const & dpred, Value & v);
+
+

Description

+

Description: Find the value meeting distances predicates.

+

+ +

+
++++ + + + + + + + + + + +

Parameters:

++++ + + + + + + + + + + + + + + +

dpred

The distances predicates.

tree

The spatial index.

v

The result.

Returns:

The number of found values.

+
+
+ + + +
Copyright © 2011, 2012 Adam Wulkiewicz
Copyright © 2008 Federico J. Fernandez

+ Distributed under 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) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/doc/html/boost/geometry/index/nearest_query_id323197.html b/doc/html/boost/geometry/index/nearest_query_id323197.html new file mode 100644 index 000000000..16abce230 --- /dev/null +++ b/doc/html/boost/geometry/index/nearest_query_id323197.html @@ -0,0 +1,101 @@ + + + +Function template nearest_query + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Function template nearest_query

+

boost::geometry::index::nearest_query

+
+

Synopsis

+
// In header: <boost/geometry/extensions/index/rtree/rtree.hpp>
+
+
+template<typename Value, typename Options, typename Translator, 
+         typename Allocator, typename DistancesPredicates, 
+         typename Predicates> 
+  size_t nearest_query(rtree< Value, Options, Translator, Allocator > const & tree, 
+                       DistancesPredicates const & dpred, 
+                       Predicates const & pred, Value & v);
+
+

Description

+

Description: Find the value meeting distances and spatial predicates.

+

+ +

+
++++ + + + + + + + + + + +

Parameters:

++++ + + + + + + + + + + + + + + + + + + +

dpred

The distances predicates.

pred

The spatial predicates.

tree

The spatial index.

v

The result.

Returns:

The number of found values.

+
+
+ + + +
Copyright © 2011, 2012 Adam Wulkiewicz
Copyright © 2008 Federico J. Fernandez

+ Distributed under 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) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/doc/html/boost/geometry/index/nearest_query_id323276.html b/doc/html/boost/geometry/index/nearest_query_id323276.html new file mode 100644 index 000000000..cdb396b7b --- /dev/null +++ b/doc/html/boost/geometry/index/nearest_query_id323276.html @@ -0,0 +1,100 @@ + + + +Function template nearest_query + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Function template nearest_query

+

boost::geometry::index::nearest_query

+
+

Synopsis

+
// In header: <boost/geometry/extensions/index/rtree/rtree.hpp>
+
+
+template<typename Value, typename Options, typename Translator, 
+         typename Allocator, typename DistancesPredicates, typename OutIter> 
+  size_t nearest_query(rtree< Value, Options, Translator, Allocator > const & tree, 
+                       DistancesPredicates const & dpred, size_t k, 
+                       OutIter out_it);
+
+

Description

+

Description: Find k values meeting distances predicates.

+

+ +

+
++++ + + + + + + + + + + +

Parameters:

++++ + + + + + + + + + + + + + + + + + + +

dpred

The distances predicates.

k

The max number of values.

out_it

The output iterator of the result range.

tree

The spatial index.

Returns:

The number of found values.

+
+
+ + + +
Copyright © 2011, 2012 Adam Wulkiewicz
Copyright © 2008 Federico J. Fernandez

+ Distributed under 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) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/doc/html/boost/geometry/index/nearest_query_id323354.html b/doc/html/boost/geometry/index/nearest_query_id323354.html new file mode 100644 index 000000000..ac96d5fca --- /dev/null +++ b/doc/html/boost/geometry/index/nearest_query_id323354.html @@ -0,0 +1,105 @@ + + + +Function template nearest_query + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Function template nearest_query

+

boost::geometry::index::nearest_query

+
+

Synopsis

+
// In header: <boost/geometry/extensions/index/rtree/rtree.hpp>
+
+
+template<typename Value, typename Options, typename Translator, 
+         typename Allocator, typename DistancesPredicates, 
+         typename Predicates, typename OutIter> 
+  size_t nearest_query(rtree< Value, Options, Translator, Allocator > const & tree, 
+                       DistancesPredicates const & dpred, size_t k, 
+                       Predicates const & pred, OutIter out_it);
+
+

Description

+

Description: Find k values meeting distances and spatial predicates.

+

+ +

+
++++ + + + + + + + + + + +

Parameters:

++++ + + + + + + + + + + + + + + + + + + + + + + +

dpred

The distances predicates.

k

The max number of values.

out_it

The output iterator of the result range.

pred

The spatial predicates.

tree

The spatial index.

Returns:

The number of found values.

+
+
+ + + +
Copyright © 2011, 2012 Adam Wulkiewicz
Copyright © 2008 Federico J. Fernandez

+ Distributed under 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) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/doc/html/boost/geometry/index/remove_id265832.html b/doc/html/boost/geometry/index/remove_id265832.html new file mode 100644 index 000000000..06ec821a5 --- /dev/null +++ b/doc/html/boost/geometry/index/remove_id265832.html @@ -0,0 +1,92 @@ + + + +Function template remove + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Function template remove

+

boost::geometry::index::remove

+
+

Synopsis

+
// In header: <boost/geometry/extensions/index/rtree/rtree.hpp>
+
+
+template<typename Value, typename Options, typename Translator, 
+         typename Allocator> 
+  rtree< Value, Options, Translator, Allocator >::size_type 
+  remove(rtree< Value, Options, Translator, Allocator > & tree, 
+         Value const & v);
+
+

Description

+

Description: Remove a value from the container. In contrast to the STL set/map erase() method this function removes only one value from the container.

+

+ +

+
++++ + + + + + + + + + + +

Parameters:

++++ + + + + + + + + + + +

tree

The spatial index.

v

The value which will be removed from the index.

Returns:

1 if value was removed, 0 otherwise.

+
+
+ + + +
Copyright © 2011, 2012 Adam Wulkiewicz
Copyright © 2008 Federico J. Fernandez

+ Distributed under 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) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/doc/html/boost/geometry/index/remove_id265888.html b/doc/html/boost/geometry/index/remove_id265888.html new file mode 100644 index 000000000..a4123ae4c --- /dev/null +++ b/doc/html/boost/geometry/index/remove_id265888.html @@ -0,0 +1,96 @@ + + + +Function template remove + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Function template remove

+

boost::geometry::index::remove

+
+

Synopsis

+
// In header: <boost/geometry/extensions/index/rtree/rtree.hpp>
+
+
+template<typename Value, typename Options, typename Translator, 
+         typename Allocator, typename Iterator> 
+  rtree< Value, Options, Translator, Allocator >::size_type 
+  remove(rtree< Value, Options, Translator, Allocator > & tree, 
+         Iterator first, Iterator last);
+
+

Description

+

Description: Remove a range of values from the container. In contrast to the STL set/map erase() method it doesn't take iterators pointing to values stored in this container. It removes values equal to these passed as a range. Furthermore this function removes only one value for each one passed in the range, not all equal values.

+

+ +

+
++++ + + + + + + + + + + +

Parameters:

++++ + + + + + + + + + + + + + + +

first

The beginning of the range of values.

last

The end of the range of values.

tree

The spatial index.

Returns:

The number of removed values.

+
+
+ + + +
Copyright © 2011, 2012 Adam Wulkiewicz
Copyright © 2008 Federico J. Fernandez

+ Distributed under 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) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/doc/html/boost/geometry/index/remove_id265956.html b/doc/html/boost/geometry/index/remove_id265956.html new file mode 100644 index 000000000..d470b3a05 --- /dev/null +++ b/doc/html/boost/geometry/index/remove_id265956.html @@ -0,0 +1,92 @@ + + + +Function template remove + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Function template remove

+

boost::geometry::index::remove

+
+

Synopsis

+
// In header: <boost/geometry/extensions/index/rtree/rtree.hpp>
+
+
+template<typename Value, typename Options, typename Translator, 
+         typename Allocator, typename Range> 
+  rtree< Value, Options, Translator, Allocator >::size_type 
+  remove(rtree< Value, Options, Translator, Allocator > & tree, 
+         Range const & rng);
+
+

Description

+

Description: Remove a range of values from the container. In contrast to the STL set/map erase() method it removes values equal to these passed as a range. Furthermore this method removes only one value for each one passed in the range, not all equal values.

+

+ +

+
++++ + + + + + + + + + + +

Parameters:

++++ + + + + + + + + + + +

rng

The range of values.

tree

The spatial index.

Returns:

The number of removed values.

+
+
+ + + +
Copyright © 2011, 2012 Adam Wulkiewicz
Copyright © 2008 Federico J. Fernandez

+ Distributed under 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) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/doc/html/boost/geometry/index/remove_id274570.html b/doc/html/boost/geometry/index/remove_id274570.html new file mode 100644 index 000000000..d995e2ee2 --- /dev/null +++ b/doc/html/boost/geometry/index/remove_id274570.html @@ -0,0 +1,92 @@ + + + +Function template remove + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Function template remove

+

boost::geometry::index::remove

+
+

Synopsis

+
// In header: <boost/geometry/extensions/index/rtree/rtree.hpp>
+
+
+template<typename Value, typename Options, typename Translator, 
+         typename Allocator> 
+  rtree< Value, Options, Translator, Allocator >::size_type 
+  remove(rtree< Value, Options, Translator, Allocator > & tree, 
+         Value const & v);
+
+

Description

+

Description: Remove a value from the container. In contrast to the STL set/map erase() method this function removes only one value from the container.

+

+ +

+
++++ + + + + + + + + + + +

Parameters:

++++ + + + + + + + + + + +

tree

The spatial index.

v

The value which will be removed from the index.

Returns:

1 if value was removed, 0 otherwise.

+
+
+ + + +
Copyright © 2011, 2012 Adam Wulkiewicz
Copyright © 2008 Federico J. Fernandez

+ Distributed under 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) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/doc/html/boost/geometry/index/remove_id274626.html b/doc/html/boost/geometry/index/remove_id274626.html new file mode 100644 index 000000000..e0eb6c289 --- /dev/null +++ b/doc/html/boost/geometry/index/remove_id274626.html @@ -0,0 +1,96 @@ + + + +Function template remove + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Function template remove

+

boost::geometry::index::remove

+
+

Synopsis

+
// In header: <boost/geometry/extensions/index/rtree/rtree.hpp>
+
+
+template<typename Value, typename Options, typename Translator, 
+         typename Allocator, typename Iterator> 
+  rtree< Value, Options, Translator, Allocator >::size_type 
+  remove(rtree< Value, Options, Translator, Allocator > & tree, 
+         Iterator first, Iterator last);
+
+

Description

+

Description: Remove a range of values from the container. In contrast to the STL set/map erase() method it doesn't take iterators pointing to values stored in this container. It removes values equal to these passed as a range. Furthermore this function removes only one value for each one passed in the range, not all equal values.

+

+ +

+
++++ + + + + + + + + + + +

Parameters:

++++ + + + + + + + + + + + + + + +

first

The beginning of the range of values.

last

The end of the range of values.

tree

The spatial index.

Returns:

The number of removed values.

+
+
+ + + +
Copyright © 2011, 2012 Adam Wulkiewicz
Copyright © 2008 Federico J. Fernandez

+ Distributed under 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) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/doc/html/boost/geometry/index/remove_id274694.html b/doc/html/boost/geometry/index/remove_id274694.html new file mode 100644 index 000000000..4940b5ff6 --- /dev/null +++ b/doc/html/boost/geometry/index/remove_id274694.html @@ -0,0 +1,92 @@ + + + +Function template remove + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Function template remove

+

boost::geometry::index::remove

+
+

Synopsis

+
// In header: <boost/geometry/extensions/index/rtree/rtree.hpp>
+
+
+template<typename Value, typename Options, typename Translator, 
+         typename Allocator, typename Range> 
+  rtree< Value, Options, Translator, Allocator >::size_type 
+  remove(rtree< Value, Options, Translator, Allocator > & tree, 
+         Range const & rng);
+
+

Description

+

Description: Remove a range of values from the container. In contrast to the STL set/map erase() method it removes values equal to these passed as a range. Furthermore this method removes only one value for each one passed in the range, not all equal values.

+

+ +

+
++++ + + + + + + + + + + +

Parameters:

++++ + + + + + + + + + + +

rng

The range of values.

tree

The spatial index.

Returns:

The number of removed values.

+
+
+ + + +
Copyright © 2011, 2012 Adam Wulkiewicz
Copyright © 2008 Federico J. Fernandez

+ Distributed under 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) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/doc/html/boost/geometry/index/remove_id279148.html b/doc/html/boost/geometry/index/remove_id279148.html new file mode 100644 index 000000000..5a5006716 --- /dev/null +++ b/doc/html/boost/geometry/index/remove_id279148.html @@ -0,0 +1,92 @@ + + + +Function template remove + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Function template remove

+

boost::geometry::index::remove

+
+

Synopsis

+
// In header: <boost/geometry/extensions/index/rtree/rtree.hpp>
+
+
+template<typename Value, typename Options, typename Translator, 
+         typename Allocator> 
+  rtree< Value, Options, Translator, Allocator >::size_type 
+  remove(rtree< Value, Options, Translator, Allocator > & tree, 
+         Value const & v);
+
+

Description

+

Description: Remove a value from the container. In contrast to the STL set/map erase() method this function removes only one value from the container.

+

+ +

+
++++ + + + + + + + + + + +

Parameters:

++++ + + + + + + + + + + +

tree

The spatial index.

v

The value which will be removed from the index.

Returns:

1 if value was removed, 0 otherwise.

+
+
+ + + +
Copyright © 2011, 2012 Adam Wulkiewicz
Copyright © 2008 Federico J. Fernandez

+ Distributed under 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) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/doc/html/boost/geometry/index/remove_id279204.html b/doc/html/boost/geometry/index/remove_id279204.html new file mode 100644 index 000000000..f29defa19 --- /dev/null +++ b/doc/html/boost/geometry/index/remove_id279204.html @@ -0,0 +1,96 @@ + + + +Function template remove + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Function template remove

+

boost::geometry::index::remove

+
+

Synopsis

+
// In header: <boost/geometry/extensions/index/rtree/rtree.hpp>
+
+
+template<typename Value, typename Options, typename Translator, 
+         typename Allocator, typename Iterator> 
+  rtree< Value, Options, Translator, Allocator >::size_type 
+  remove(rtree< Value, Options, Translator, Allocator > & tree, 
+         Iterator first, Iterator last);
+
+

Description

+

Description: Remove a range of values from the container. In contrast to the STL set/map erase() method it doesn't take iterators pointing to values stored in this container. It removes values equal to these passed as a range. Furthermore this function removes only one value for each one passed in the range, not all equal values.

+

+ +

+
++++ + + + + + + + + + + +

Parameters:

++++ + + + + + + + + + + + + + + +

first

The beginning of the range of values.

last

The end of the range of values.

tree

The spatial index.

Returns:

The number of removed values.

+
+
+ + + +
Copyright © 2011, 2012 Adam Wulkiewicz
Copyright © 2008 Federico J. Fernandez

+ Distributed under 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) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/doc/html/boost/geometry/index/remove_id279272.html b/doc/html/boost/geometry/index/remove_id279272.html new file mode 100644 index 000000000..2c87e10d2 --- /dev/null +++ b/doc/html/boost/geometry/index/remove_id279272.html @@ -0,0 +1,92 @@ + + + +Function template remove + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Function template remove

+

boost::geometry::index::remove

+
+

Synopsis

+
// In header: <boost/geometry/extensions/index/rtree/rtree.hpp>
+
+
+template<typename Value, typename Options, typename Translator, 
+         typename Allocator, typename Range> 
+  rtree< Value, Options, Translator, Allocator >::size_type 
+  remove(rtree< Value, Options, Translator, Allocator > & tree, 
+         Range const & rng);
+
+

Description

+

Description: Remove a range of values from the container. In contrast to the STL set/map erase() method it removes values equal to these passed as a range. Furthermore this method removes only one value for each one passed in the range, not all equal values.

+

+ +

+
++++ + + + + + + + + + + +

Parameters:

++++ + + + + + + + + + + +

rng

The range of values.

tree

The spatial index.

Returns:

The number of removed values.

+
+
+ + + +
Copyright © 2011, 2012 Adam Wulkiewicz
Copyright © 2008 Federico J. Fernandez

+ Distributed under 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) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/doc/html/boost/geometry/index/remove_id322877.html b/doc/html/boost/geometry/index/remove_id322877.html new file mode 100644 index 000000000..14c0c65c3 --- /dev/null +++ b/doc/html/boost/geometry/index/remove_id322877.html @@ -0,0 +1,92 @@ + + + +Function template remove + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Function template remove

+

boost::geometry::index::remove

+
+

Synopsis

+
// In header: <boost/geometry/extensions/index/rtree/rtree.hpp>
+
+
+template<typename Value, typename Options, typename Translator, 
+         typename Allocator> 
+  rtree< Value, Options, Translator, Allocator >::size_type 
+  remove(rtree< Value, Options, Translator, Allocator > & tree, 
+         Value const & v);
+
+

Description

+

Description: Remove a value from the container. In contrast to the STL set/map erase() method this function removes only one value from the container.

+

+ +

+
++++ + + + + + + + + + + +

Parameters:

++++ + + + + + + + + + + +

tree

The spatial index.

v

The value which will be removed from the index.

Returns:

1 if value was removed, 0 otherwise.

+
+
+ + + +
Copyright © 2011, 2012 Adam Wulkiewicz
Copyright © 2008 Federico J. Fernandez

+ Distributed under 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) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/doc/html/boost/geometry/index/remove_id322933.html b/doc/html/boost/geometry/index/remove_id322933.html new file mode 100644 index 000000000..8ffa40f33 --- /dev/null +++ b/doc/html/boost/geometry/index/remove_id322933.html @@ -0,0 +1,96 @@ + + + +Function template remove + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Function template remove

+

boost::geometry::index::remove

+
+

Synopsis

+
// In header: <boost/geometry/extensions/index/rtree/rtree.hpp>
+
+
+template<typename Value, typename Options, typename Translator, 
+         typename Allocator, typename Iterator> 
+  rtree< Value, Options, Translator, Allocator >::size_type 
+  remove(rtree< Value, Options, Translator, Allocator > & tree, 
+         Iterator first, Iterator last);
+
+

Description

+

Description: Remove a range of values from the container. In contrast to the STL set/map erase() method it doesn't take iterators pointing to values stored in this container. It removes values equal to these passed as a range. Furthermore this function removes only one value for each one passed in the range, not all equal values.

+

+ +

+
++++ + + + + + + + + + + +

Parameters:

++++ + + + + + + + + + + + + + + +

first

The beginning of the range of values.

last

The end of the range of values.

tree

The spatial index.

Returns:

The number of removed values.

+
+
+ + + +
Copyright © 2011, 2012 Adam Wulkiewicz
Copyright © 2008 Federico J. Fernandez

+ Distributed under 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) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/doc/html/boost/geometry/index/remove_id323001.html b/doc/html/boost/geometry/index/remove_id323001.html new file mode 100644 index 000000000..91f526b02 --- /dev/null +++ b/doc/html/boost/geometry/index/remove_id323001.html @@ -0,0 +1,92 @@ + + + +Function template remove + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Function template remove

+

boost::geometry::index::remove

+
+

Synopsis

+
// In header: <boost/geometry/extensions/index/rtree/rtree.hpp>
+
+
+template<typename Value, typename Options, typename Translator, 
+         typename Allocator, typename Range> 
+  rtree< Value, Options, Translator, Allocator >::size_type 
+  remove(rtree< Value, Options, Translator, Allocator > & tree, 
+         Range const & rng);
+
+

Description

+

Description: Remove a range of values from the container. In contrast to the STL set/map erase() method it removes values equal to these passed as a range. Furthermore this method removes only one value for each one passed in the range, not all equal values.

+

+ +

+
++++ + + + + + + + + + + +

Parameters:

++++ + + + + + + + + + + +

rng

The range of values.

tree

The spatial index.

Returns:

The number of removed values.

+
+
+ + + +
Copyright © 2011, 2012 Adam Wulkiewicz
Copyright © 2008 Federico J. Fernandez

+ Distributed under 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) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/doc/html/boost/geometry/index/rtree.html b/doc/html/boost/geometry/index/rtree.html new file mode 100644 index 000000000..72105ae76 --- /dev/null +++ b/doc/html/boost/geometry/index/rtree.html @@ -0,0 +1,1083 @@ + + + +Class template rtree + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Class template rtree

+

boost::geometry::index::rtree

+
+

Synopsis

+
// In header: <boost/geometry/extensions/index/rtree/rtree.hpp>
+
+template<typename Value, typename Parameters, 
+         typename Translator = translator::def<Value>, 
+         typename Allocator = std::allocator<Value> > 
+class rtree {
+public:
+  // types
+  typedef Value                                           value_type;     
+  typedef Parameters                                      parameters_type;
+  typedef Translator                                      translator_type;
+  typedef Allocator                                       allocator_type; 
+  typedef allocator_type::size_type                       size_type;      
+  typedef translator::indexable_type< Translator >::type  indexable_type; 
+  typedef index::default_box_type< indexable_type >::type box_type;       
+
+  // construct/copy/destruct
+  explicit rtree(Parameters = Parameters(), 
+                 translator_type const & = translator_type(), 
+                 Allocator = Allocator());
+  template<typename Iterator> 
+    rtree(Iterator, Iterator, Parameters = Parameters(), 
+          translator_type const & = translator_type(), 
+          Allocator = std::allocator< value_type >());
+  template<typename Range> 
+    rtree(Range const &, Parameters = Parameters(), 
+          translator_type const & = translator_type(), 
+          Allocator = std::allocator< value_type >());
+  rtree(rtree const &);
+  rtree(rtree const &, Allocator const &);
+  rtree(rtree &&);
+  rtree& operator=(const rtree &);
+  rtree& operator=(rtree &&);
+  ~rtree();
+
+  // public member functions
+  void swap(rtree &);
+  void insert(value_type const &);
+  template<typename Iterator> void insert(Iterator, Iterator);
+  template<typename Range> void insert(Range const &);
+  size_type remove(value_type const &);
+  template<typename Iterator> size_type remove(Iterator, Iterator);
+  template<typename Range> size_type remove(Range const &);
+  template<typename Predicates, typename OutIter> 
+    size_type spatial_query(Predicates const &, OutIter) const;
+  template<typename DistancesPredicates> 
+    size_type nearest_query(DistancesPredicates const &, value_type &) const;
+  template<typename DistancesPredicates, typename Predicates> 
+    size_type nearest_query(DistancesPredicates const &, Predicates const &, 
+                            value_type &) const;
+  template<typename DistancesPredicates, typename OutIter> 
+    size_type nearest_query(DistancesPredicates const &, size_t, OutIter) const;
+  template<typename DistancesPredicates, typename Predicates, 
+           typename OutIter> 
+    size_type nearest_query(DistancesPredicates const &, size_t, 
+                            Predicates const &, OutIter) const;
+  size_type size() const;
+  bool empty() const;
+  void clear();
+  box_type box() const;
+  template<typename ValueOrIndexable> 
+    size_type count(ValueOrIndexable const &) const;
+  parameters_type const & parameters() const;
+  translator_type const & translator() const;
+  allocator_type get_allocator() const;
+
+  // private member functions
+  template<typename Visitor> void apply_visitor(Visitor &) const;
+  size_type values_count() const;
+  size_type depth() const;
+  void raw_insert(value_type const &);
+  size_type raw_remove(value_type const &);
+  void raw_create();
+  void raw_destroy(rtree &);
+  void raw_copy(rtree const &, rtree &, bool) const;
+  template<typename DistancesPredicates, typename Predicates> 
+    size_type raw_nearest_one(DistancesPredicates const &, Predicates const &, 
+                              value_type &) const;
+  template<typename DistancesPredicates, typename Predicates, 
+           typename OutIter> 
+    size_type raw_nearest_k(DistancesPredicates const &, size_t, 
+                            Predicates const &, OutIter) const;
+};
+
+

Description

+

The R-tree spatial index. This is self-balancing spatial index capable to store various types of Values and balancing algorithms.

+

+

+
+

Template Parameters

+
    +
  1. +
    typename Value
    +

    The type of objects stored in the container.

    +
    2. +
  2. +
    typename Parameters
    +

    Compile-time parameters. The user must pass a type defining the Parameters which will be used in rtree creation process. This type is used e.g. to specify balancing algorithm with compile-time parameters like min and max number of elements in node. Predefined Algorithms/Parameters are: bgi::linear<MinElements, MaxElements>, bgi::quadratic<MinElements, MaxElements>, bgi::rstar<MinElements, MaxElements, OverlapCostThreshold = 0, ReinsertedElements = MaxElements * 0.3>.

    +
    3. +
  3. +
    typename Translator = translator::def<Value>
    +

    The type of the translator which translates from Value to Indexable. This translation is done each time the r-tree wants to know Value's Indexable. Default translator can translate all types adapted to Point or Box concepts (which are Indexables). It also handles std::pair<Indexable, T>, pointers, smart pointers, and iterators. E.g. If std::pair<Box, int> is stored, the default translator translates from std::pair<Box, int> const& to Box const&.

    +
    4. +
  4. +
    typename Allocator = std::allocator<Value>
    +

    The allocator.

    +
    5. +
+
+
+

+rtree + public + construct/copy/destruct

+
    +
  1. +
    explicit rtree(Parameters parameters = Parameters(), 
+               translator_type const & translator = translator_type(), 
+               Allocator allocator = Allocator());
    +

    Description: The constructor.

    +

    Exception-safety: nothrow

    +

    +

    +
    ++++ + + + + +

    Parameters:

    ++++ + + + + + + + + + + + + + + +

    allocator

    The allocator object.

    parameters

    The parameters object.

    translator

    The translator object.

    +
    2. +
  2. +
    template<typename Iterator> 
+  rtree(Iterator first, Iterator last, Parameters parameters = Parameters(), 
+        translator_type const & translator = translator_type(), 
+        Allocator allocator = std::allocator< value_type >());
    +

    Description: The constructor.

    +

    Exception-safety: strong

    +

    +

    +
    ++++ + + + + +

    Parameters:

    ++++ + + + + + + + + + + + + + + + + + + + + + + +

    allocator

    The allocator object.

    first

    The beginning of the range of Values.

    last

    The end of the range of Values.

    parameters

    The parameters object.

    translator

    The translator object.

    +
    3. +
  3. +
    template<typename Range> 
+  rtree(Range const & rng, Parameters parameters = Parameters(), 
+        translator_type const & translator = translator_type(), 
+        Allocator allocator = std::allocator< value_type >());
    +

    Description: The constructor.

    +

    Exception-safety: strong

    +

    +

    +
    ++++ + + + + +

    Parameters:

    ++++ + + + + + + + + + + + + + + + + + + +

    allocator

    The allocator object.

    parameters

    The parameters object.

    rng

    The range of Values.

    translator

    The translator object.

    +
    4. +
  4. +
    rtree(rtree const & src);
    +

    Description: The copy constructor.

    +

    Exception-safety: strong

    +
    5. +
  5. +
    rtree(rtree const & src, Allocator const & allocator);
    +

    Description: The copy constructor.

    +

    Exception-safety: strong

    +
    6. +
  6. +
    rtree(rtree && src);
    +

    Description: The moving constructor.

    +

    Exception-safety: nothrow

    +
    7. +
  7. +
    rtree& operator=(const rtree & src);
    +

    Description: The assignment operator.

    +

    Exception-safety: strong

    +
    8. +
  8. +
    rtree& operator=(rtree && src);
    +

    Description: The moving assignment.

    +

    Exception-safety: nothrow (if allocators are equal), strong (if allocators aren't equal)

    +
    9. +
  9. +
    ~rtree();
    +

    Description: The destructor.

    +

    Exception-safety: nothrow

    +
    10. +
+
+
+

+rtree public member functions

+
    +
  1. +
    void swap(rtree & other);
    +

    Description: Swaps two rtrees.

    +

    Exception-safety: nothrow

    +

    +

    +
    ++++ + + + + +

    Parameters:

    ++++ + + + + +

    other

    The other rtree.

    +
    2. +
  2. +
    void insert(value_type const & value);
    +

    Description: Insert a value to the index.

    +

    Exception-safety: not safe - if this operation throws, the R-tree may be left in an inconsistent state, elements must not be inserted or removed, methods may return invalid data.

    +

    +

    +
    ++++ + + + + +

    Parameters:

    ++++ + + + + +

    value

    The value which will be stored in the container.

    +
    3. +
  3. +
    template<typename Iterator> void insert(Iterator first, Iterator last);
    +

    Description: Insert a range of values to the index.

    +

    Exception-safety: not safe - if this operation throws, the R-tree may be left in an inconsistent state, elements must not be inserted or removed, methods may return invalid data.

    +

    +

    +
    ++++ + + + + +

    Parameters:

    ++++ + + + + + + + + + + +

    first

    The beginning of the range of values.

    last

    The end of the range of values.

    +
    4. +
  4. +
    template<typename Range> void insert(Range const & rng);
    +

    Description: Insert a range of values to the index.

    +

    Exception-safety: not safe - if this operation throws, the R-tree may be left in an inconsistent state, elements must not be inserted or removed, methods may return invalid data.

    +

    +

    +
    ++++ + + + + +

    Parameters:

    ++++ + + + + +

    rng

    The range of values.

    +
    5. +
  5. +
    size_type remove(value_type const & value);
    +

    Description: Remove a value from the container. In contrast to the STL set/map erase() method this method removes only one value from the container.

    +

    Exception-safety: not safe - if this operation throws, the R-tree may be left in an inconsistent state, elements must not be inserted or removed, methods may return invalid data.

    +

    + +

    +
    ++++ + + + + + + + + + + +

    Parameters:

    ++++ + + + + +

    value

    The value which will be removed from the container.

    Returns:

    1 if the value was removed, 0 otherwise.

    +
    6. +
  6. +
    template<typename Iterator> size_type remove(Iterator first, Iterator last);
    +

    Description: Remove a range of values from the container. In contrast to the STL set/map erase() method it doesn't take iterators pointing to values stored in this container. It removes values equal to these passed as a range. Furthermore this method removes only one value for each one passed in the range, not all equal values.

    +

    Exception-safety: not safe - if this operation throws, the R-tree may be left in an inconsistent state, elements must not be inserted or removed, methods may return invalid data.

    +

    + +

    +
    ++++ + + + + + + + + + + +

    Parameters:

    ++++ + + + + + + + + + + +

    first

    The beginning of the range of values.

    last

    The end of the range of values.

    Returns:

    The number of removed values.

    +
    7. +
  7. +
    template<typename Range> size_type remove(Range const & rng);
    +

    Description: Remove a range of values from the container. In contrast to the STL set/map erase() method it removes values equal to these passed as a range. Furthermore, this method removes only one value for each one passed in the range, not all equal values.

    +

    Exception-safety: not safe - if this operation throws, the R-tree may be left in an inconsistent state, elements must not be inserted or removed, methods may return invalid data.

    +

    + +

    +
    ++++ + + + + + + + + + + +

    Parameters:

    ++++ + + + + +

    rng

    The range of values.

    Returns:

    The number of removed values.

    +
    8. +
  8. +
    template<typename Predicates, typename OutIter> 
+  size_type spatial_query(Predicates const & pred, OutIter out_it) const;
    +

    Description: Finds values meeting spatial predicates, e.g. intersecting some box.

    +

    Exception-safety: strong

    +

    + +

    +
    ++++ + + + + + + + + + + +

    Parameters:

    ++++ + + + + + + + + + + +

    out_it

    The output iterator of the result range. E.g. an iterator generated by std::back_inserter(container)

    pred

    The spatial predicates. May be a Geometry (in this case default predicate - intersects is used) or generated by bgi::covered_by(geometry), bgi::disjoint(geometry), bgi::intersects(geometry), bgi::overlaps(geometry), bgi::within(geometry), !bgi::covered_by(geometry), !bgi::disjoint(geometry), !bgi::intersects(geometry), !bgi::overlaps(geometry), !bgi::within(geometry) or bgi::value(func). Those predicates may be passed together in std::pair or boost::tuple.

    Returns:

    The number of values found.

    +
    9. +
  9. +
    template<typename DistancesPredicates> 
+  size_type nearest_query(DistancesPredicates const & dpred, value_type & v) const;
    +

    Description: Finds one value meeting distances predicates, e.g. nearest to some point.

    +

    Exception-safety: strong

    +

    + +

    +
    ++++ + + + + + + + + + + +

    Parameters:

    ++++ + + + + + + + + + + +

    dpred

    The distances predicates. May be a Point. This is default case where Value which nearest point is closest to Point is returned. May be a PointRelation which define how distance to Value is calculated. This may be generated by bgi::to_nearest(Point), bgi::to_centroid(Point) or bgi::to_furthest(Point). DistancesPredicates may also define distances bounds. E.g. that some distance must be between min_distance and max_distance. This may be generated by bgi::unbounded(PointRelation) - default case, bgi::min_bounded(PointRelation, MinRelation), bgi::max_bounded(PointRelation, MaxRelation), bgi::bounded(PointRelation, MinRelation, MaxRelation). MinRelation and MaxRelation describes bounds and may be generated by bgi::to_nearest(dist_bound), bgi::to_centroid(dist_bound) or bgi::to_furthest(dist_bound).

    v

    The reference to the object which will contain the result.

    Returns:

    The number of values found.

    +
    10. +
  10. +
    template<typename DistancesPredicates, typename Predicates> 
+  size_type nearest_query(DistancesPredicates const & dpred, 
+                          Predicates const & pred, value_type & v) const;
    +

    Description: Finds one value meeting distances predicates and spatial predicates, e.g. nearest to some point and intersecting some box.

    +

    Exception-safety: strong

    +

    + +

    +
    ++++ + + + + + + + + + + +

    Parameters:

    ++++ + + + + + + + + + + + + + + +

    dpred

    The distances predicates. May be a Point. This is default case where Value which nearest point is closest to Point is returned. May be a PointRelation which define how distance to Value is calculated. This may be generated by bgi::to_nearest(Point), bgi::to_centroid(Point) or bgi::to_furthest(Point). DistancesPredicates may also define distances bounds. E.g. that some distance must be between min_distance and max_distance. This may be generated by bgi::unbounded(PointRelation) - default case, bgi::min_bounded(PointRelation, MinRelation), bgi::max_bounded(PointRelation, MaxRelation), bgi::bounded(PointRelation, MinRelation, MaxRelation). MinRelation and MaxRelation describes bounds and may be generated by bgi::to_nearest(dist_bound), bgi::to_centroid(dist_bound) or bgi::to_furthest(dist_bound).

    pred

    The spatial predicates. May be a Geometry (in this case default predicate - intersects is used) or generated by bgi::covered_by(geometry), bgi::disjoint(geometry), bgi::intersects(geometry), bgi::overlaps(geometry), bgi::within(geometry), !bgi::covered_by(geometry), !bgi::disjoint(geometry), !bgi::intersects(geometry), !bgi::overlaps(geometry), !bgi::within(geometry) or bgi::value(func). Those predicates may be passed together in std::pair or boost::tuple.

    v

    The reference to the object which will contain the result.

    Returns:

    The number of values found.

    +
    11. +
  11. +
    template<typename DistancesPredicates, typename OutIter> 
+  size_type nearest_query(DistancesPredicates const & dpred, size_t k, 
+                          OutIter out_it) const;
    +

    Description: Finds k values meeting distances predicates, e.g. k nearest values to some point.

    +

    Exception-safety: strong

    +

    + +

    +
    ++++ + + + + + + + + + + +

    Parameters:

    ++++ + + + + + + + + + + + + + + +

    dpred

    The distances predicates. May be a Point. This is default case where Value which nearest point is closest to Point is returned. May be a PointRelation which define how distance to Value is calculated. This may be generated by bgi::to_nearest(Point), bgi::to_centroid(Point) or bgi::to_furthest(Point). DistancesPredicates may also define distances bounds. E.g. that some distance must be between min_distance and max_distance. This may be generated by bgi::unbounded(PointRelation) - default case, bgi::min_bounded(PointRelation, MinRelation), bgi::max_bounded(PointRelation, MaxRelation), bgi::bounded(PointRelation, MinRelation, MaxRelation). MinRelation and MaxRelation describes bounds and may be generated by bgi::to_nearest(dist_bound), bgi::to_centroid(dist_bound) or bgi::to_furthest(dist_bound).

    k

    The max number of values.

    out_it

    The output iterator of the result range. E.g. a back_insert_iterator.

    Returns:

    The number of values found.

    +
    12. +
  12. +
    template<typename DistancesPredicates, typename Predicates, typename OutIter> 
+  size_type nearest_query(DistancesPredicates const & dpred, size_t k, 
+                          Predicates const & pred, OutIter out_it) const;
    +

    Description: Finds k values meeting distances predicates and spatial predicates, e.g. k nearest values to some point and intersecting some box.

    +

    Exception-safety: strong

    +

    + +

    +
    ++++ + + + + + + + + + + +

    Parameters:

    ++++ + + + + + + + + + + + + + + + + + + +

    dpred

    The distances predicates. May be a Point. This is default case where Value which nearest point is closest to Point is returned. May be a PointRelation which define how distance to Value is calculated. This may be generated by bgi::to_nearest(Point), bgi::to_centroid(Point) or bgi::to_furthest(Point). DistancesPredicates may also define distances bounds. E.g. that some distance must be between min_distance and max_distance. This may be generated by bgi::unbounded(PointRelation) - default case, bgi::min_bounded(PointRelation, MinRelation), bgi::max_bounded(PointRelation, MaxRelation), bgi::bounded(PointRelation, MinRelation, MaxRelation). MinRelation and MaxRelation describes bounds and may be generated by bgi::to_nearest(dist_bound), bgi::to_centroid(dist_bound) or bgi::to_furthest(dist_bound).

    k

    The max number of values.

    out_it

    The output iterator of the result range. E.g. a back_insert_iterator.

    pred

    The spatial predicates. May be a Geometry (in this case default predicate - intersects is used) or generated by bgi::covered_by(geometry), bgi::disjoint(geometry), bgi::intersects(geometry), bgi::overlaps(geometry), bgi::within(geometry), !bgi::covered_by(geometry), !bgi::disjoint(geometry), !bgi::intersects(geometry), !bgi::overlaps(geometry), !bgi::within(geometry) or bgi::value(func). Those predicates may be passed together in std::pair or boost::tuple.

    Returns:

    The number of values found.

    +
    13. +
  13. +
    size_type size() const;
    +

    Description: Returns the number of stored values.

    +

    Exception-safety: nothrow

    +

    +

    +
    ++++ + + + + +

    Returns:

    The number of stored values.

    +
    14. +
  14. +
    bool empty() const;
    +

    Description: Query if the container is empty.

    +

    Exception-safety: nothrow

    +

    +

    +
    ++++ + + + + +

    Returns:

    true if the container is empty.

    +
    15. +
  15. +
    void clear();
    +

    Description: Removes all values stored in the container.

    +

    Exception-safety: nothrow.

    +
    16. +
  16. +
    box_type box() const;
    +

    Description: Returns the box containing all values stored in the container. If the container is empty the result of geometry::assign_inverse() is returned.

    +

    Exception-safety: nothrow (if Indexable's CoordinateType copy assignment doesn't throw), strong (if Indexable's CoordinateType copy assignment throws).

    +

    +

    +
    ++++ + + + + +

    Returns:

    The box containing all values stored in the container or an invalid box if there are no values in the container.

    +
    17. +
  17. +
    template<typename ValueOrIndexable> 
+  size_type count(ValueOrIndexable const & vori) const;
    +

    Description: For indexable_type it returns the number of values which indexables equals the parameter. For value_type it returns the number of values which equals the parameter.

    +

    Exception-safety: nothrow.

    +

    + +

    +
    ++++ + + + + +

    Returns:

    The number of values found.

    +
    18. +
  18. +
    parameters_type const & parameters() const;
    +

    Description: Returns parameters.

    +

    Exception-safety: nothrow.

    +

    +

    +
    ++++ + + + + +

    Returns:

    The parameters object.

    +
    19. +
  19. +
    translator_type const & translator() const;
    +

    Description: Returns the translator object.

    +

    Exception-safety: nothrow.

    +

    +

    +
    ++++ + + + + +

    Returns:

    The translator object.

    +
    20. +
  20. +
    allocator_type get_allocator() const;
    +

    Description: Returns allocator used by the rtree.

    +

    Exception-safety: nothrow

    +

    +

    +
    ++++ + + + + +

    Returns:

    The allocator.

    +
    21. +
+
+
+

+rtree private member functions

+
    +
  1. +
    template<typename Visitor> void apply_visitor(Visitor & visitor) const;
    +

    Description: Apply a visitor to the nodes structure in order to perform some operator. This function is not a part of the 'official' interface. However it makes possible e.g. to pass a visitor drawing the tree structure.

    +

    Exception-safety: the same as Visitor::operator().

    +

    +

    +
    ++++ + + + + +

    Parameters:

    ++++ + + + + +

    visitor

    The visitor object.

    +
    2. +
  2. +
    size_type values_count() const;
    +

    Description: Returns the number of stored objects. Same as size() This function is not a part of the 'official' interface.

    +

    Exception-safety: nothrow

    +

    +

    +
    ++++ + + + + +

    Returns:

    The number of stored objects.

    +
    3. +
  3. +
    size_type depth() const;
    +

    Description: Returns the depth of the R-tree. This function is not a part of the 'official' interface.

    +

    Exception-safety: nothrow.

    +

    +

    +
    ++++ + + + + +

    Returns:

    The depth of the R-tree.

    +
    4. +
  4. +
    void raw_insert(value_type const & value);
    +

    Description: Insert a value to the index. Root node must exist.

    +

    Exception-safety: basic

    +

    +

    +
    ++++ + + + + +

    Parameters:

    ++++ + + + + +

    value

    The value which will be stored in the container.

    +
    5. +
  5. +
    size_type raw_remove(value_type const & value);
    +

    Description: Remove the value from the container.

    +

    Exception-safety: basic

    +

    +

    +
    ++++ + + + + +

    Parameters:

    ++++ + + + + +

    value

    The value which will be removed from the container.

    +
    6. +
  6. +
    void raw_create();
    +

    Description: Create an empty R-tree i.e. new empty root node and clear other attributes.

    +

    Exception-safety: strong.

    +
    7. +
  7. +
    void raw_destroy(rtree & t);
    +

    Description: Destroy the R-tree i.e. all nodes and clear attributes.

    +

    Exception-safety: nothrow.

    +

    +

    +
    ++++ + + + + +

    Parameters:

    ++++ + + + + +

    t

    The container which is going to be destroyed.

    +
    8. +
  8. +
    void raw_copy(rtree const & src, rtree & dst, bool copy_all_internals) const;
    +

    Description: Copy the R-tree i.e. whole nodes structure, values and other attributes. It uses destination's allocators to create the new structure.

    +

    Exception-safety: strong.

    +

    +

    +
    ++++ + + + + +

    Parameters:

    ++++ + + + + + + + + + + +

    dst

    The destination R-tree.

    src

    The source R-tree.

    +
    9. +
  9. +
    template<typename DistancesPredicates, typename Predicates> 
+  size_type raw_nearest_one(DistancesPredicates const & dpred, 
+                            Predicates const & pred, value_type & v) const;
    +

    Description: Find one value meeting distances and spatial predicates.

    +

    Exception-safety: strong.

    +
    10. +
  10. +
    template<typename DistancesPredicates, typename Predicates, typename OutIter> 
+  size_type raw_nearest_k(DistancesPredicates const & dpred, size_t k, 
+                          Predicates const & pred, OutIter out_it) const;
    +

    Description: Find k values meeting distances and spatial predicates.

    +

    Exception-safety: strong.

    +
    11. +
+
+
+
+ + + +
Copyright © 2011, 2012 Adam Wulkiewicz
Copyright © 2008 Federico J. Fernandez

+ Distributed under 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) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/doc/html/boost/geometry/index/size.html b/doc/html/boost/geometry/index/size.html new file mode 100644 index 000000000..438fb4196 --- /dev/null +++ b/doc/html/boost/geometry/index/size.html @@ -0,0 +1,84 @@ + + + +Function template size + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Function template size

+

boost::geometry::index::size

+
+

Synopsis

+
// In header: <boost/geometry/extensions/index/rtree/rtree.hpp>
+
+
+template<typename Value, typename Options, typename Translator, 
+         typename Allocator> 
+  size_t size(rtree< Value, Options, Translator, Allocator > const & tree);
+
+

Description

+

Description: Get the number of values stored in the index.

+

+ +

+
++++ + + + + + + + + + + +

Parameters:

++++ + + + + +

tree

The spatial index.

Returns:

The number of values stored in the index.

+
+
+ + + +
Copyright © 2011, 2012 Adam Wulkiewicz
Copyright © 2008 Federico J. Fernandez

+ Distributed under 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) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/doc/html/boost/geometry/index/spatial_query.html b/doc/html/boost/geometry/index/spatial_query.html new file mode 100644 index 000000000..08cc2392e --- /dev/null +++ b/doc/html/boost/geometry/index/spatial_query.html @@ -0,0 +1,95 @@ + + + +Function template spatial_query + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Function template spatial_query

+

boost::geometry::index::spatial_query

+
+

Synopsis

+
// In header: <boost/geometry/extensions/index/rtree/rtree.hpp>
+
+
+template<typename Value, typename Options, typename Translator, 
+         typename Allocator, typename Predicates, typename OutIter> 
+  size_t spatial_query(rtree< Value, Options, Translator, Allocator > const & tree, 
+                       Predicates const & pred, OutIter out_it);
+
+

Description

+

Description: Find values meeting spatial predicates.

+

+ +

+
++++ + + + + + + + + + + +

Parameters:

++++ + + + + + + + + + + + + + + +

out_it

The output iterator of the result range.

pred

The spatial predicates.

tree

The spatial index.

Returns:

The number of found values.

+
+
+ + + +
Copyright © 2011, 2012 Adam Wulkiewicz
Copyright © 2008 Federico J. Fernandez

+ Distributed under 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) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/doc/html/geometry_index/r_tree.html b/doc/html/geometry_index/r_tree.html index 42ae4edb7..0583a142b 100644 --- a/doc/html/geometry_index/r_tree.html +++ b/doc/html/geometry_index/r_tree.html @@ -75,6 +75,13 @@ spatial predicates
Exception safety
+
Reference
+
+
Class Index
+
Typedef Index
+
Function Index
+
Header Reference
+
diff --git a/doc/html/geometry_index/r_tree/exception_safety.html b/doc/html/geometry_index/r_tree/exception_safety.html index 62cfa5669..fd669c9c6 100644 --- a/doc/html/geometry_index/r_tree/exception_safety.html +++ b/doc/html/geometry_index/r_tree/exception_safety.html @@ -7,6 +7,7 @@ +
@@ -19,7 +20,7 @@
-PrevUpHome +PrevUpHomeNext

@@ -417,7 +418,7 @@
-PrevUpHome +PrevUpHomeNext
diff --git a/doc/html/geometry_index/r_tree/index.html b/doc/html/geometry_index/r_tree/index.html new file mode 100644 index 000000000..71f7a654b --- /dev/null +++ b/doc/html/geometry_index/r_tree/index.html @@ -0,0 +1,342 @@ + + + +Reference + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+
Class Index
+
Typedef Index
+
Function Index
+
Header Reference
+
+
+

+Class Index

+

R

+
+
+R +
+
+
+
+
+

+Typedef Index

+

A B I P S T V

+
+
+A +
+
+
+B +
+
+
+I +
+
+
+P +
+
+
+S +
+
+
+T +
+
+
+V +
+
+
+
+
+

+Function Index

+

B C E I N R S

+
+
+B +
+
+
+C +
+
+
+E +
+
+
+I +
+
+
+N +
+
+
+R +
+
+
+S +
+
+
+
+
+

+Header Reference

+
Header <boost/geometry/extensions/index/rtree/rtree.hpp>
+
+
+
namespace boost {
+  namespace geometry {
+    namespace index {
+      template<typename Value, typename Parameters, 
+               typename Translator = translator::def<Value>, 
+               typename Allocator = std::allocator<Value> > 
+        class rtree;
+      template<typename Value, typename Options, typename Translator, 
+               typename Allocator> 
+        void insert(rtree< Value, Options, Translator, Allocator > &, 
+                    Value const &);
+      template<typename Value, typename Options, typename Translator, 
+               typename Allocator, typename Iterator> 
+        void insert(rtree< Value, Options, Translator, Allocator > &, 
+                    Iterator, Iterator);
+      template<typename Value, typename Options, typename Translator, 
+               typename Allocator, typename Range> 
+        void insert(rtree< Value, Options, Translator, Allocator > &, 
+                    Range const &);
+      template<typename Value, typename Options, typename Translator, 
+               typename Allocator> 
+        rtree< Value, Options, Translator, Allocator >::size_type 
+        remove(rtree< Value, Options, Translator, Allocator > &, 
+               Value const &);
+      template<typename Value, typename Options, typename Translator, 
+               typename Allocator, typename Iterator> 
+        rtree< Value, Options, Translator, Allocator >::size_type 
+        remove(rtree< Value, Options, Translator, Allocator > &, Iterator, 
+               Iterator);
+      template<typename Value, typename Options, typename Translator, 
+               typename Allocator, typename Range> 
+        rtree< Value, Options, Translator, Allocator >::size_type 
+        remove(rtree< Value, Options, Translator, Allocator > &, 
+               Range const &);
+      template<typename Value, typename Options, typename Translator, 
+               typename Allocator, typename Predicates, typename OutIter> 
+        size_t spatial_query(rtree< Value, Options, Translator, Allocator > const &, 
+                             Predicates const &, OutIter);
+      template<typename Value, typename Options, typename Translator, 
+               typename Allocator, typename DistancesPredicates> 
+        size_t nearest_query(rtree< Value, Options, Translator, Allocator > const &, 
+                             DistancesPredicates const &, Value &);
+      template<typename Value, typename Options, typename Translator, 
+               typename Allocator, typename DistancesPredicates, 
+               typename Predicates> 
+        size_t nearest_query(rtree< Value, Options, Translator, Allocator > const &, 
+                             DistancesPredicates const &, Predicates const &, 
+                             Value &);
+      template<typename Value, typename Options, typename Translator, 
+               typename Allocator, typename DistancesPredicates, 
+               typename OutIter> 
+        size_t nearest_query(rtree< Value, Options, Translator, Allocator > const &, 
+                             DistancesPredicates const &, size_t, OutIter);
+      template<typename Value, typename Options, typename Translator, 
+               typename Allocator, typename DistancesPredicates, 
+               typename Predicates, typename OutIter> 
+        size_t nearest_query(rtree< Value, Options, Translator, Allocator > const &, 
+                             DistancesPredicates const &, size_t, 
+                             Predicates const &, OutIter);
+      template<typename Value, typename Options, typename Translator, 
+               typename Allocator> 
+        void clear(rtree< Value, Options, Translator, Allocator > &);
+      template<typename Value, typename Options, typename Translator, 
+               typename Allocator> 
+        size_t size(rtree< Value, Options, Translator, Allocator > const &);
+      template<typename Value, typename Options, typename Translator, 
+               typename Allocator> 
+        bool empty(rtree< Value, Options, Translator, Allocator > const &);
+      template<typename Value, typename Options, typename Translator, 
+               typename Allocator> 
+        rtree< Value, Options, Translator, Allocator >::box_type 
+        box(rtree< Value, Options, Translator, Allocator > const &);
+    }
+  }
+}
+
+
+
+ + + +
Copyright © 2011, 2012 Adam Wulkiewicz
Copyright © 2008 Federico J. Fernandez

+ Distributed under 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) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/doc/html/index.html b/doc/html/index.html index 2db321f3a..4f963ee4f 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -51,12 +51,13 @@
Nearest neighbours queries
Exception safety
+
Reference

- +

Last revised: December 30, 2012 at 01:43:03 GMT

Last revised: January 04, 2013 at 20:20:05 GMT
diff --git a/doc/index.idx b/doc/index.idx new file mode 100644 index 000000000..b0cffe44e --- /dev/null +++ b/doc/index.idx @@ -0,0 +1,8 @@ +!scan "boost/geometry/extensions/index/rtree/rtree.hpp" +!scan "boost/geometry/extensions/index/predicates.hpp" +!scan "boost/geometry/extensions/index/distance_predicates.hpp" +!scan "boost/geometry/extensions/index/inserter.hpp" +!scan "boost/geometry/extensions/index/adaptors/nearest_query.hpp" +!scan "boost/geometry/extensions/index/adaptors/spatial_query.hpp" +!scan "boost/geometry/extensions/index/translator/def.hpp" +!scan "boost/geometry/extensions/index/translator/index.hpp" diff --git a/doc/rtree.qbk b/doc/rtree.qbk index 4fe958312..a837ee4e2 100644 --- a/doc/rtree.qbk +++ b/doc/rtree.qbk @@ -17,4 +17,17 @@ [include rtree/nearest_query.qbk] [include rtree/exception_safety.qbk] +[include auto_index_helpers.qbk] + +[section:index Reference] + +[named_index class_name Class Index] +[named_index typedef_name Typedef Index] +[named_index function_name Function Index] +[/named_index macro_name Macro Index] +[/index] +[xinclude autodoc.xml] + +[endsect] + [endsect] diff --git a/include/boost/geometry/extensions/index/rtree/rtree.hpp b/include/boost/geometry/extensions/index/rtree/rtree.hpp index 201c7dcad..b39c1fa63 100644 --- a/include/boost/geometry/extensions/index/rtree/rtree.hpp +++ b/include/boost/geometry/extensions/index/rtree/rtree.hpp @@ -104,9 +104,9 @@ private: public: /*! - The constructor. + Description: The constructor. - \note Exception-safety: nothrow + Exception-safety: nothrow \param parameters The parameters object. \param translator The translator object. @@ -122,9 +122,9 @@ public: {} /*! - The constructor. + Description: The constructor. - \note Exception-safety: strong + Exception-safety: strong \param first The beginning of the range of Values. \param last The end of the range of Values. @@ -153,9 +153,9 @@ public: } /*! - The constructor. + Description: The constructor. - \note Exception-safety: strong + Exception-safety: strong \param rng The range of Values. \param parameters The parameters object. @@ -183,9 +183,9 @@ public: } /*! - The destructor. + Description: The destructor. - \note Exception-safety: nothrow + Exception-safety: nothrow */ inline ~rtree() { @@ -193,9 +193,9 @@ public: } /*! - The copy constructor. + Description: The copy constructor. - \note Exception-safety: strong + Exception-safety: strong */ inline rtree(rtree const& src) : m_translator(src.m_translator) // SHOULDN'T THROW @@ -211,9 +211,9 @@ public: } /*! - The copy constructor. + Description: The copy constructor. - \note Exception-safety: strong + Exception-safety: strong */ inline rtree(rtree const& src, Allocator const& allocator) : m_translator(src.m_translator) // SHOULDN'T THROW @@ -227,9 +227,9 @@ public: } /*! - The moving constructor. + Description: The moving constructor. - \note Exception-safety: nothrow + Exception-safety: nothrow */ inline rtree(BOOST_RV_REF(rtree) src) : m_translator(src.m_translator) // SHOULDN'T THROW @@ -245,9 +245,9 @@ public: } /*! - The assignment operator. + Description: The assignment operator. - \note Exception-safety: strong + Exception-safety: strong */ inline rtree & operator=(BOOST_COPY_ASSIGN_REF(rtree) src) { @@ -263,9 +263,9 @@ public: } /*! - The moving assignment. + Description: The moving assignment. - \note Exception-safety: nothrow (if allocators are equal), + Exception-safety: nothrow (if allocators are equal), strong (if allocators aren't equal) */ inline rtree & operator=(BOOST_RV_REF(rtree) src) @@ -299,9 +299,9 @@ public: } /*! - Swaps two rtrees. + Description: Swaps two rtrees. - \note Exception-safety: nothrow + Exception-safety: nothrow \param other The other rtree. */ @@ -317,9 +317,9 @@ public: } /*! - Insert a value to the index. + Description: Insert a value to the index. - \note Exception-safety: not safe - if this operation throws, the R-tree may be left in + Exception-safety: not safe - if this operation throws, the R-tree may be left in an inconsistent state, elements must not be inserted or removed, methods may return invalid data. \param value The value which will be stored in the container. @@ -333,9 +333,9 @@ public: } /*! - Insert a range of values to the index. + Description: Insert a range of values to the index. - \note Exception-safety: not safe - if this operation throws, the R-tree may be left in + Exception-safety: not safe - if this operation throws, the R-tree may be left in an inconsistent state, elements must not be inserted or removed, methods may return invalid data. \param first The beginning of the range of values. @@ -352,9 +352,9 @@ public: } /*! - Insert a range of values to the index. + Description: Insert a range of values to the index. - \note Exception-safety: not safe - if this operation throws, the R-tree may be left in + Exception-safety: not safe - if this operation throws, the R-tree may be left in an inconsistent state, elements must not be inserted or removed, methods may return invalid data. \param rng The range of values. @@ -371,10 +371,10 @@ public: } /*! - Remove a value from the container. In contrast to the STL set/map erase() method + Description: Remove a value from the container. In contrast to the STL set/map erase() method this method removes only one value from the container. - \note Exception-safety: not safe - if this operation throws, the R-tree may be left in + Exception-safety: not safe - if this operation throws, the R-tree may be left in an inconsistent state, elements must not be inserted or removed, methods may return invalid data. \param value The value which will be removed from the container. @@ -387,12 +387,12 @@ public: } /*! - Remove a range of values from the container. In contrast to the STL set/map erase() method + Description: Remove a range of values from the container. In contrast to the STL set/map erase() method it doesn't take iterators pointing to values stored in this container. It removes values equal to these passed as a range. Furthermore this method removes only one value for each one passed in the range, not all equal values. - \note Exception-safety: not safe - if this operation throws, the R-tree may be left in + Exception-safety: not safe - if this operation throws, the R-tree may be left in an inconsistent state, elements must not be inserted or removed, methods may return invalid data. \param first The beginning of the range of values. @@ -410,11 +410,11 @@ public: } /*! - Remove a range of values from the container. In contrast to the STL set/map erase() method + Description: Remove a range of values from the container. In contrast to the STL set/map erase() method it removes values equal to these passed as a range. Furthermore, this method removes only one value for each one passed in the range, not all equal values. - \note Exception-safety: not safe - if this operation throws, the R-tree may be left in + Exception-safety: not safe - if this operation throws, the R-tree may be left in an inconsistent state, elements must not be inserted or removed, methods may return invalid data. \param rng The range of values. @@ -431,10 +431,10 @@ public: return result; } - /*! + /* Assign new elements to the rtree. This method replaces the content of the rtree. - \note Exception-safety: strong + Exception-safety: strong \param first The beginning of the range of values. \param last The end of the range of values. @@ -446,10 +446,10 @@ public: this->swap(foo); }*/ - /*! + /* Assign new elements to the rtree. This method replaces the content of the rtree. - \note Exception-safety: strong + Exception-safety: strong \param rng The range of values. */ @@ -461,9 +461,9 @@ public: }*/ /*! - Find values meeting spatial predicates, e.g. intersecting some box. + Description: Finds values meeting spatial predicates, e.g. intersecting some box. - \note Exception-safety: strong + Exception-safety: strong \param pred The spatial predicates. May be a Geometry (in this case default predicate - intersects is used) or generated by bgi::covered_by(geometry), @@ -493,9 +493,9 @@ public: } /*! - Find one value meeting distances predicates, e.g. nearest to some point. + Description: Finds one value meeting distances predicates, e.g. nearest to some point. - \note Exception-safety: strong + Exception-safety: strong \param dpred The distances predicates. May be a Point. This is default case where Value which nearest point is closest to Point is returned. May be a PointRelation which define @@ -518,10 +518,10 @@ public: } /*! - Find one value meeting distances predicates and spatial predicates, + Description: Finds one value meeting distances predicates and spatial predicates, e.g. nearest to some point and intersecting some box. - \note Exception-safety: strong + Exception-safety: strong \param dpred The distances predicates. May be a Point. This is default case where Value which nearest point is closest to Point is returned. May be a PointRelation which define @@ -550,9 +550,9 @@ public: } /*! - Find k values meeting distances predicates, e.g. k nearest values to some point. + Description: Finds k values meeting distances predicates, e.g. k nearest values to some point. - \note Exception-safety: strong + Exception-safety: strong \param dpred The distances predicates. May be a Point. This is default case where Value which nearest point is closest to Point is returned. May be a PointRelation which define @@ -575,10 +575,10 @@ public: } /*! - Find k values meeting distances predicates and spatial predicates, + Description: Finds k values meeting distances predicates and spatial predicates, e.g. k nearest values to some point and intersecting some box. - \note Exception-safety: strong + Exception-safety: strong \param dpred The distances predicates. May be a Point. This is default case where Value which nearest point is closest to Point is returned. May be a PointRelation which define @@ -608,9 +608,9 @@ public: } /*! - Returns the number of stored values. + Description: Returns the number of stored values. - \note Exception-safety: nothrow + Exception-safety: nothrow \return The number of stored values. */ @@ -620,9 +620,9 @@ public: } /*! - Query if the container is empty. + Description: Query if the container is empty. - \note Exception-safety: nothrow + Exception-safety: nothrow \return true if the container is empty. */ @@ -632,9 +632,9 @@ public: } /*! - Removes all values stored in the container. + Description: Removes all values stored in the container. - \note Exception-safety: nothrow. + Exception-safety: nothrow. */ inline void clear() { @@ -642,10 +642,10 @@ public: } /*! - Returns the box containing all values stored in the container. + Description: Returns the box containing all values stored in the container. If the container is empty the result of geometry::assign_inverse() is returned. - \note Exception-safety: nothrow (if Indexable's CoordinateType copy assignment doesn't throw), + Exception-safety: nothrow (if Indexable's CoordinateType copy assignment doesn't throw), strong (if Indexable's CoordinateType copy assignment throws). \return The box containing all values stored in the container or an invalid box if @@ -669,10 +669,10 @@ public: } /*! - For indexable_type it returns the number of values which indexables equals the parameter. + Description: For indexable_type it returns the number of values which indexables equals the parameter. For value_type it returns the number of values which equals the parameter. - \note Exception-safety: nothrow. + Exception-safety: nothrow. \param The value or indexable which will be counted. @@ -693,9 +693,9 @@ public: } /*! - Returns parameters. + Description: Returns parameters. - \note Exception-safety: nothrow. + Exception-safety: nothrow. \return The parameters object. */ @@ -705,9 +705,9 @@ public: } /*! - Returns the translator object. + Description: Returns the translator object. - \note Exception-safety: nothrow. + Exception-safety: nothrow. \return The translator object. */ @@ -717,9 +717,9 @@ public: } /*! - Returns allocator used by the rtree. + Description: Returns allocator used by the rtree. - \note Exception-safety: nothrow + Exception-safety: nothrow \return The allocator. */ @@ -732,11 +732,11 @@ public: private: #endif /*! - Apply a visitor to the nodes structure in order to perform some operator. + Description: Apply a visitor to the nodes structure in order to perform some operator. This function is not a part of the 'official' interface. However it makes possible e.g. to pass a visitor drawing the tree structure. - \note Exception-safety: the same as Visitor::operator(). + Exception-safety: the same as Visitor::operator(). \param visitor The visitor object. */ @@ -748,10 +748,10 @@ private: } /*! - Returns the number of stored objects. Same as size() + Description: Returns the number of stored objects. Same as size() This function is not a part of the 'official' interface. - \note Exception-safety: nothrow + Exception-safety: nothrow \return The number of stored objects. */ @@ -761,10 +761,10 @@ private: } /*! - Returns the depth of the R-tree. + Description: Returns the depth of the R-tree. This function is not a part of the 'official' interface. - \note Exception-safety: nothrow. + Exception-safety: nothrow. \return The depth of the R-tree. */ @@ -775,9 +775,9 @@ private: private: /*! - Insert a value to the index. Root node must exist. + Description: Insert a value to the index. Root node must exist. - \note Exception-safety: basic + Exception-safety: basic \param value The value which will be stored in the container. */ @@ -804,9 +804,9 @@ private: } /*! - Remove the value from the container. + Description: Remove the value from the container. - \note Exception-safety: basic + Exception-safety: basic \param value The value which will be removed from the container. */ @@ -834,9 +834,9 @@ private: } /*! - Create an empty R-tree i.e. new empty root node and clear other attributes. + Description: Create an empty R-tree i.e. new empty root node and clear other attributes. - \note Exception-safety: strong. + Exception-safety: strong. */ inline void raw_create() { @@ -848,9 +848,9 @@ private: } /*! - Destroy the R-tree i.e. all nodes and clear attributes. + Description: Destroy the R-tree i.e. all nodes and clear attributes. - \note Exception-safety: nothrow. + Exception-safety: nothrow. \param t The container which is going to be destroyed. */ @@ -868,10 +868,10 @@ private: } /*! - Copy the R-tree i.e. whole nodes structure, values and other attributes. + Description: Copy the R-tree i.e. whole nodes structure, values and other attributes. It uses destination's allocators to create the new structure. - \note Exception-safety: strong. + Exception-safety: strong. \param src The source R-tree. \param dst The destination R-tree. @@ -904,9 +904,9 @@ private: } /*! - Find one value meeting distances and spatial predicates. + Description: Find one value meeting distances and spatial predicates. - \note Exception-safety: strong. + Exception-safety: strong. */ template inline size_type raw_nearest_one(DistancesPredicates const& dpred, Predicates const& pred, value_type & v) const @@ -942,9 +942,9 @@ private: } /*! - Find k values meeting distances and spatial predicates. + Description: Find k values meeting distances and spatial predicates. - \note Exception-safety: strong. + Exception-safety: strong. */ template inline size_type raw_nearest_k(DistancesPredicates const& dpred, size_t k, Predicates const& pred, OutIter out_it) const @@ -989,7 +989,7 @@ private: }; /*! -Insert a value to the index. +Description: Insert a value to the index. \param tree The spatial index. \param v The value which will be stored in the index. @@ -1001,7 +1001,7 @@ inline void insert(rtree & tree, Value co } /*! -Insert a range of values to the index. +Description: Insert a range of values to the index. \param tree The spatial index. \param first The beginning of the range of values. @@ -1014,7 +1014,7 @@ inline void insert(rtree & tree, Iterator } /*! -Insert a range of values to the index. +Description: Insert a range of values to the index. \param tree The spatial index. \param rng The range of values. @@ -1026,7 +1026,7 @@ inline void insert(rtree & tree, Range co } /*! -Remove a value from the container. In contrast to the STL set/map erase() method +Description: Remove a value from the container. In contrast to the STL set/map erase() method this function removes only one value from the container. \param tree The spatial index. @@ -1042,7 +1042,7 @@ remove(rtree & tree, Value const& v) } /*! -Remove a range of values from the container. In contrast to the STL set/map erase() method +Description: Remove a range of values from the container. In contrast to the STL set/map erase() method it doesn't take iterators pointing to values stored in this container. It removes values equal to these passed as a range. Furthermore this function removes only one value for each one passed in the range, not all equal values. @@ -1061,7 +1061,7 @@ remove(rtree & tree, Iterator first, Iter } /*! -Remove a range of values from the container. In contrast to the STL set/map erase() method +Description: Remove a range of values from the container. In contrast to the STL set/map erase() method it removes values equal to these passed as a range. Furthermore this method removes only one value for each one passed in the range, not all equal values. @@ -1078,7 +1078,7 @@ remove(rtree & tree, Range const& rng) } /*! -Find values meeting spatial predicates. +Description: Find values meeting spatial predicates. \param tree The spatial index. \param pred The spatial predicates. @@ -1093,7 +1093,7 @@ inline size_t spatial_query(rtree const& } /*! -Find the value meeting distances predicates. +Description: Find the value meeting distances predicates. \param tree The spatial index. \param dpred The distances predicates. @@ -1108,7 +1108,7 @@ inline size_t nearest_query(rtree const& } /*! -Find the value meeting distances and spatial predicates. +Description: Find the value meeting distances and spatial predicates. \param tree The spatial index. \param dpred The distances predicates. @@ -1124,7 +1124,7 @@ inline size_t nearest_query(rtree const& } /*! -Find k values meeting distances predicates. +Description: Find k values meeting distances predicates. \param tree The spatial index. \param dpred The distances predicates. @@ -1140,7 +1140,7 @@ inline size_t nearest_query(rtree const& } /*! -Find k values meeting distances and spatial predicates. +Description: Find k values meeting distances and spatial predicates. \param tree The spatial index. \param dpred The distances predicates. @@ -1157,7 +1157,7 @@ inline size_t nearest_query(rtree const& } /*! -Remove all values from the index. +Description: Remove all values from the index. \param tree The spatial index. */ @@ -1168,7 +1168,7 @@ inline void clear(rtree & tree) } /*! -Get the number of values stored in the index. +Description: Get the number of values stored in the index. \param tree The spatial index. @@ -1181,7 +1181,7 @@ inline size_t size(rtree const& tree) } /*! -Query if there are no values stored in the index. +Description: Query if there are no values stored in the index. \param tree The spatial index. @@ -1194,7 +1194,7 @@ inline bool empty(rtree const& tree) } /*! -Get the box containing all stored values or an invalid box if the index has no values. +Description: Get the box containing all stored values or an invalid box if the index has no values. \param tree The spatial index.