1 // Boost.Geometry Index
3 // Copyright (c) 2011-2015 Adam Wulkiewicz, Lodz, Poland.
5 // Use, modification and distribution is subject to the Boost Software License,
6 // Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
7 // http://www.boost.org/LICENSE_1_0.txt)
9 #ifndef BOOST_GEOMETRY_INDEX_DETAIL_SERIALIZATION_HPP
10 #define BOOST_GEOMETRY_INDEX_DETAIL_SERIALIZATION_HPP
12 //#include <boost/serialization/serialization.hpp>
13 #include <boost/serialization/split_member.hpp>
14 #include <boost/serialization/version.hpp>
15 //#include <boost/serialization/nvp.hpp>
18 // how about using the unsigned type capable of storing Max in compile-time versions?
21 // - add wrappers for Point and Box and implement serialize for those wrappers instead of
23 // PROBLEM: after implementing this, how Values would be set?
24 // - store the name of the parameters to know how to load and detect errors
25 // - in the header, once store info about the Indexable and Bounds types (geometry type, point CS, Dim, etc.)
26 // each geometry save without this info
28 // TODO - move to index/detail/serialization.hpp
29 namespace boost { namespace geometry { namespace index { namespace detail {
31 // TODO - use boost::move?
33 class serialization_storage
36 template <typename Archive>
37 serialization_storage(Archive & ar, unsigned int version)
39 boost::serialization::load_construct_data_adl(ar, this->address(), version);
41 ~serialization_storage()
43 this->address()->~T();
47 return static_cast<T*>(m_storage.address());
50 boost::aligned_storage<sizeof(T), boost::alignment_of<T>::value> m_storage;
53 // TODO - save and load item_version? see: collections_load_imp and collections_save_imp
54 // this should be done once for the whole container
55 // versions of all used types should be stored
57 template <typename T, typename Archive> inline
58 T serialization_load(const char * name, Archive & ar)
60 namespace bs = boost::serialization;
61 serialization_storage<T> storage(ar, bs::version<T>::value); // load_construct_data
62 ar >> boost::serialization::make_nvp(name, *storage.address()); // serialize
63 //ar >> *storage.address(); // serialize
64 return *storage.address();
67 template <typename T, typename Archive> inline
68 void serialization_save(T const& t, const char * name, Archive & ar)
70 namespace bs = boost::serialization;
71 bs::save_construct_data_adl(ar, boost::addressof(t), bs::version<T>::value); // save_construct_data
72 ar << boost::serialization::make_nvp(name, t); // serialize
73 //ar << t; // serialize
78 // TODO - move to index/serialization/rtree.hpp
79 namespace boost { namespace serialization {
81 // boost::geometry::index::linear
83 template<class Archive, size_t Max, size_t Min>
84 void save_construct_data(Archive & ar, const boost::geometry::index::linear<Max, Min> * params, unsigned int )
86 size_t max = params->get_max_elements(), min = params->get_min_elements();
87 ar << boost::serialization::make_nvp("max", max);
88 ar << boost::serialization::make_nvp("min", min);
90 template<class Archive, size_t Max, size_t Min>
91 void load_construct_data(Archive & ar, boost::geometry::index::linear<Max, Min> * params, unsigned int )
94 ar >> boost::serialization::make_nvp("max", max);
95 ar >> boost::serialization::make_nvp("min", min);
96 if ( max != params->get_max_elements() || min != params->get_min_elements() )
97 // TODO change exception type
98 BOOST_THROW_EXCEPTION(std::runtime_error("parameters not compatible"));
99 // the constructor musn't be called for this type
100 //::new(params)boost::geometry::index::linear<Max, Min>();
102 template<class Archive, size_t Max, size_t Min> void serialize(Archive &, boost::geometry::index::linear<Max, Min> &, unsigned int) {}
104 // boost::geometry::index::quadratic
106 template<class Archive, size_t Max, size_t Min>
107 void save_construct_data(Archive & ar, const boost::geometry::index::quadratic<Max, Min> * params, unsigned int )
109 size_t max = params->get_max_elements(), min = params->get_min_elements();
110 ar << boost::serialization::make_nvp("max", max);
111 ar << boost::serialization::make_nvp("min", min);
113 template<class Archive, size_t Max, size_t Min>
114 void load_construct_data(Archive & ar, boost::geometry::index::quadratic<Max, Min> * params, unsigned int )
117 ar >> boost::serialization::make_nvp("max", max);
118 ar >> boost::serialization::make_nvp("min", min);
119 if ( max != params->get_max_elements() || min != params->get_min_elements() )
120 // TODO change exception type
121 BOOST_THROW_EXCEPTION(std::runtime_error("parameters not compatible"));
122 // the constructor musn't be called for this type
123 //::new(params)boost::geometry::index::quadratic<Max, Min>();
125 template<class Archive, size_t Max, size_t Min> void serialize(Archive &, boost::geometry::index::quadratic<Max, Min> &, unsigned int) {}
127 // boost::geometry::index::rstar
129 template<class Archive, size_t Max, size_t Min, size_t RE, size_t OCT>
130 void save_construct_data(Archive & ar, const boost::geometry::index::rstar<Max, Min, RE, OCT> * params, unsigned int )
132 size_t max = params->get_max_elements()
133 , min = params->get_min_elements()
134 , re = params->get_reinserted_elements()
135 , oct = params->get_overlap_cost_threshold();
136 ar << boost::serialization::make_nvp("max", max);
137 ar << boost::serialization::make_nvp("min", min);
138 ar << boost::serialization::make_nvp("re", re);
139 ar << boost::serialization::make_nvp("oct", oct);
141 template<class Archive, size_t Max, size_t Min, size_t RE, size_t OCT>
142 void load_construct_data(Archive & ar, boost::geometry::index::rstar<Max, Min, RE, OCT> * params, unsigned int )
144 size_t max, min, re, oct;
145 ar >> boost::serialization::make_nvp("max", max);
146 ar >> boost::serialization::make_nvp("min", min);
147 ar >> boost::serialization::make_nvp("re", re);
148 ar >> boost::serialization::make_nvp("oct", oct);
149 if ( max != params->get_max_elements() || min != params->get_min_elements() ||
150 re != params->get_reinserted_elements() || oct != params->get_overlap_cost_threshold() )
151 // TODO change exception type
152 BOOST_THROW_EXCEPTION(std::runtime_error("parameters not compatible"));
153 // the constructor musn't be called for this type
154 //::new(params)boost::geometry::index::rstar<Max, Min, RE, OCT>();
156 template<class Archive, size_t Max, size_t Min, size_t RE, size_t OCT>
157 void serialize(Archive &, boost::geometry::index::rstar<Max, Min, RE, OCT> &, unsigned int) {}
159 // boost::geometry::index::dynamic_linear
161 template<class Archive>
162 inline void save_construct_data(Archive & ar, const boost::geometry::index::dynamic_linear * params, unsigned int )
164 size_t max = params->get_max_elements(), min = params->get_min_elements();
165 ar << boost::serialization::make_nvp("max", max);
166 ar << boost::serialization::make_nvp("min", min);
168 template<class Archive>
169 inline void load_construct_data(Archive & ar, boost::geometry::index::dynamic_linear * params, unsigned int )
172 ar >> boost::serialization::make_nvp("max", max);
173 ar >> boost::serialization::make_nvp("min", min);
174 ::new(params)boost::geometry::index::dynamic_linear(max, min);
176 template<class Archive> void serialize(Archive &, boost::geometry::index::dynamic_linear &, unsigned int) {}
178 // boost::geometry::index::dynamic_quadratic
180 template<class Archive>
181 inline void save_construct_data(Archive & ar, const boost::geometry::index::dynamic_quadratic * params, unsigned int )
183 size_t max = params->get_max_elements(), min = params->get_min_elements();
184 ar << boost::serialization::make_nvp("max", max);
185 ar << boost::serialization::make_nvp("min", min);
187 template<class Archive>
188 inline void load_construct_data(Archive & ar, boost::geometry::index::dynamic_quadratic * params, unsigned int )
191 ar >> boost::serialization::make_nvp("max", max);
192 ar >> boost::serialization::make_nvp("min", min);
193 ::new(params)boost::geometry::index::dynamic_quadratic(max, min);
195 template<class Archive> void serialize(Archive &, boost::geometry::index::dynamic_quadratic &, unsigned int) {}
197 // boost::geometry::index::dynamic_rstar
199 template<class Archive>
200 inline void save_construct_data(Archive & ar, const boost::geometry::index::dynamic_rstar * params, unsigned int )
202 size_t max = params->get_max_elements()
203 , min = params->get_min_elements()
204 , re = params->get_reinserted_elements()
205 , oct = params->get_overlap_cost_threshold();
206 ar << boost::serialization::make_nvp("max", max);
207 ar << boost::serialization::make_nvp("min", min);
208 ar << boost::serialization::make_nvp("re", re);
209 ar << boost::serialization::make_nvp("oct", oct);
211 template<class Archive>
212 inline void load_construct_data(Archive & ar, boost::geometry::index::dynamic_rstar * params, unsigned int )
214 size_t max, min, re, oct;
215 ar >> boost::serialization::make_nvp("max", max);
216 ar >> boost::serialization::make_nvp("min", min);
217 ar >> boost::serialization::make_nvp("re", re);
218 ar >> boost::serialization::make_nvp("oct", oct);
219 ::new(params)boost::geometry::index::dynamic_rstar(max, min, re, oct);
221 template<class Archive> void serialize(Archive &, boost::geometry::index::dynamic_rstar &, unsigned int) {}
223 }} // boost::serialization
225 // TODO - move to index/detail/serialization.hpp or maybe geometry/serialization.hpp
226 namespace boost { namespace geometry { namespace index { namespace detail {
228 template <typename P, size_t I = 0, size_t D = geometry::dimension<P>::value>
229 struct serialize_point
231 template <typename Archive>
232 static inline void save(Archive & ar, P const& p, unsigned int version)
234 typename coordinate_type<P>::type c = get<I>(p);
235 ar << boost::serialization::make_nvp("c", c);
236 serialize_point<P, I+1, D>::save(ar, p, version);
239 template <typename Archive>
240 static inline void load(Archive & ar, P & p, unsigned int version)
242 typename geometry::coordinate_type<P>::type c;
243 ar >> boost::serialization::make_nvp("c", c);
245 serialize_point<P, I+1, D>::load(ar, p, version);
249 template <typename P, size_t D>
250 struct serialize_point<P, D, D>
252 template <typename Archive> static inline void save(Archive &, P const&, unsigned int) {}
253 template <typename Archive> static inline void load(Archive &, P &, unsigned int) {}
258 // TODO - move to index/detail/serialization.hpp or maybe geometry/serialization.hpp
259 namespace boost { namespace serialization {
261 template<class Archive, typename T, size_t D, typename C>
262 void save(Archive & ar, boost::geometry::model::point<T, D, C> const& p, unsigned int version)
264 boost::geometry::index::detail::serialize_point< boost::geometry::model::point<T, D, C> >::save(ar, p, version);
266 template<class Archive, typename T, size_t D, typename C>
267 void load(Archive & ar, boost::geometry::model::point<T, D, C> & p, unsigned int version)
269 boost::geometry::index::detail::serialize_point< boost::geometry::model::point<T, D, C> >::load(ar, p, version);
271 template<class Archive, typename T, size_t D, typename C>
272 inline void serialize(Archive & ar, boost::geometry::model::point<T, D, C> & o, const unsigned int version) { split_free(ar, o, version); }
274 template<class Archive, typename P>
275 inline void serialize(Archive & ar, boost::geometry::model::box<P> & b, const unsigned int)
277 ar & boost::serialization::make_nvp("min", b.min_corner());
278 ar & boost::serialization::make_nvp("max", b.max_corner());
281 }} // boost::serialization
283 // TODO - move to index/detail/rtree/visitors/save.hpp
284 namespace boost { namespace geometry { namespace index { namespace detail { namespace rtree { namespace visitors {
286 // TODO move saving and loading of the rtree outside the rtree, this will require adding some kind of members_view
288 template <typename Archive, typename Value, typename Options, typename Translator, typename Box, typename Allocators>
290 : public rtree::visitor<Value, typename Options::parameters_type, Box, Allocators, typename Options::node_tag, true>::type
293 typedef typename rtree::node<Value, typename Options::parameters_type, Box, Allocators, typename Options::node_tag>::type node;
294 typedef typename rtree::internal_node<Value, typename Options::parameters_type, Box, Allocators, typename Options::node_tag>::type internal_node;
295 typedef typename rtree::leaf<Value, typename Options::parameters_type, Box, Allocators, typename Options::node_tag>::type leaf;
297 save(Archive & archive, unsigned int version)
298 : m_archive(archive), m_version(version)
301 inline void operator()(internal_node const& n)
303 typedef typename rtree::elements_type<internal_node>::type elements_type;
304 elements_type const& elements = rtree::elements(n);
306 // CONSIDER: change to elements_type::size_type or size_type
307 // or use fixed-size type like uint32 or even uint16?
308 size_t s = elements.size();
309 m_archive << boost::serialization::make_nvp("s", s);
311 for (typename elements_type::const_iterator it = elements.begin() ; it != elements.end() ; ++it)
313 serialization_save(it->first, "b", m_archive);
315 rtree::apply_visitor(*this, *it->second);
319 inline void operator()(leaf const& l)
321 typedef typename rtree::elements_type<leaf>::type elements_type;
322 //typedef typename elements_type::size_type elements_size;
323 elements_type const& elements = rtree::elements(l);
325 // CONSIDER: change to elements_type::size_type or size_type
326 // or use fixed-size type like uint32 or even uint16?
327 size_t s = elements.size();
328 m_archive << boost::serialization::make_nvp("s", s);
330 for (typename elements_type::const_iterator it = elements.begin() ; it != elements.end() ; ++it)
332 serialization_save(*it, "v", m_archive);
338 unsigned int m_version;
341 }}}}}} // boost::geometry::index::detail::rtree::visitors
343 // TODO - move to index/detail/rtree/load.hpp
344 namespace boost { namespace geometry { namespace index { namespace detail { namespace rtree {
346 template <typename Value, typename Options, typename Translator, typename Box, typename Allocators>
349 typedef typename rtree::node<Value, typename Options::parameters_type, Box, Allocators, typename Options::node_tag>::type node;
350 typedef typename rtree::internal_node<Value, typename Options::parameters_type, Box, Allocators, typename Options::node_tag>::type internal_node;
351 typedef typename rtree::leaf<Value, typename Options::parameters_type, Box, Allocators, typename Options::node_tag>::type leaf;
353 typedef typename Options::parameters_type parameters_type;
355 typedef typename Allocators::node_pointer node_pointer;
356 typedef rtree::subtree_destroyer<Value, Options, Translator, Box, Allocators> subtree_destroyer;
357 typedef typename Allocators::size_type size_type;
360 template <typename Archive> inline static
361 node_pointer apply(Archive & ar, unsigned int version, size_type leafs_level, size_type & values_count, parameters_type const& parameters, Translator const& translator, Allocators & allocators)
364 return raw_apply(ar, version, leafs_level, values_count, parameters, translator, allocators);
368 template <typename Archive> inline static
369 node_pointer raw_apply(Archive & ar, unsigned int version, size_type leafs_level, size_type & values_count, parameters_type const& parameters, Translator const& translator, Allocators & allocators, size_type current_level = 0)
371 //BOOST_GEOMETRY_INDEX_ASSERT(current_level <= leafs_level, "invalid parameter");
373 typedef typename rtree::elements_type<internal_node>::type elements_type;
374 typedef typename elements_type::value_type element_type;
375 //typedef typename elements_type::size_type elements_size;
377 // CONSIDER: change to elements_type::size_type or size_type
378 // or use fixed-size type like uint32 or even uint16?
379 size_t elements_count;
380 ar >> boost::serialization::make_nvp("s", elements_count);
382 if ( elements_count < parameters.get_min_elements() || parameters.get_max_elements() < elements_count )
383 BOOST_THROW_EXCEPTION(std::runtime_error("rtree loading error"));
385 if ( current_level < leafs_level )
387 node_pointer n = rtree::create_node<Allocators, internal_node>::apply(allocators); // MAY THROW (A)
388 subtree_destroyer auto_remover(n, allocators);
389 internal_node & in = rtree::get<internal_node>(*n);
391 elements_type & elements = rtree::elements(in);
393 elements.reserve(elements_count); // MAY THROW (A)
395 for ( size_t i = 0 ; i < elements_count ; ++i )
397 typedef typename elements_type::value_type::first_type box_type;
398 box_type b = serialization_load<box_type>("b", ar);
399 node_pointer n = raw_apply(ar, version, leafs_level, values_count, parameters, translator, allocators, current_level+1); // recursive call
400 elements.push_back(element_type(b, n));
403 auto_remover.release();
408 BOOST_GEOMETRY_INDEX_ASSERT(current_level == leafs_level, "unexpected value");
410 node_pointer n = rtree::create_node<Allocators, leaf>::apply(allocators); // MAY THROW (A)
411 subtree_destroyer auto_remover(n, allocators);
412 leaf & l = rtree::get<leaf>(*n);
414 typedef typename rtree::elements_type<leaf>::type elements_type;
415 typedef typename elements_type::value_type element_type;
416 elements_type & elements = rtree::elements(l);
418 values_count += elements_count;
420 elements.reserve(elements_count); // MAY THROW (A)
422 for ( size_t i = 0 ; i < elements_count ; ++i )
424 element_type el = serialization_load<element_type>("v", ar); // MAY THROW (C)
425 elements.push_back(el); // MAY THROW (C)
428 auto_remover.release();
434 }}}}} // boost::geometry::index::detail::rtree
436 // TODO - move to index/detail/rtree/private_view.hpp
437 namespace boost { namespace geometry { namespace index { namespace detail { namespace rtree {
439 template <typename Rtree>
440 class const_private_view
443 typedef typename Rtree::size_type size_type;
445 typedef typename Rtree::translator_type translator_type;
446 typedef typename Rtree::value_type value_type;
447 typedef typename Rtree::options_type options_type;
448 typedef typename Rtree::box_type box_type;
449 typedef typename Rtree::allocators_type allocators_type;
451 const_private_view(Rtree const& rt) : m_rtree(rt) {}
453 typedef typename Rtree::members_holder members_holder;
455 members_holder const& members() const { return m_rtree.m_members; }
458 const_private_view(const_private_view const&);
459 const_private_view & operator=(const_private_view const&);
461 Rtree const& m_rtree;
464 template <typename Rtree>
468 typedef typename Rtree::size_type size_type;
470 typedef typename Rtree::translator_type translator_type;
471 typedef typename Rtree::value_type value_type;
472 typedef typename Rtree::options_type options_type;
473 typedef typename Rtree::box_type box_type;
474 typedef typename Rtree::allocators_type allocators_type;
476 private_view(Rtree & rt) : m_rtree(rt) {}
478 typedef typename Rtree::members_holder members_holder;
480 members_holder & members() { return m_rtree.m_members; }
481 members_holder const& members() const { return m_rtree.m_members; }
484 private_view(private_view const&);
485 private_view & operator=(private_view const&);
490 }}}}} // namespace boost::geometry::index::detail::rtree
492 // TODO - move to index/serialization/rtree.hpp
493 namespace boost { namespace serialization {
495 template<class Archive, typename V, typename P, typename I, typename E, typename A>
496 void save(Archive & ar, boost::geometry::index::rtree<V, P, I, E, A> const& rt, unsigned int version)
498 namespace detail = boost::geometry::index::detail;
500 typedef boost::geometry::index::rtree<V, P, I, E, A> rtree;
501 typedef detail::rtree::const_private_view<rtree> view;
502 typedef typename view::translator_type translator_type;
503 typedef typename view::value_type value_type;
504 typedef typename view::options_type options_type;
505 typedef typename view::box_type box_type;
506 typedef typename view::allocators_type allocators_type;
510 detail::serialization_save(tree.members().parameters(), "parameters", ar);
512 ar << boost::serialization::make_nvp("values_count", tree.members().values_count);
513 ar << boost::serialization::make_nvp("leafs_level", tree.members().leafs_level);
515 if ( tree.members().values_count )
517 BOOST_GEOMETRY_INDEX_ASSERT(tree.members().root, "root shouldn't be null_ptr");
519 detail::rtree::visitors::save<Archive, value_type, options_type, translator_type, box_type, allocators_type> save_v(ar, version);
520 detail::rtree::apply_visitor(save_v, *tree.members().root);
524 template<class Archive, typename V, typename P, typename I, typename E, typename A>
525 void load(Archive & ar, boost::geometry::index::rtree<V, P, I, E, A> & rt, unsigned int version)
527 namespace detail = boost::geometry::index::detail;
529 typedef boost::geometry::index::rtree<V, P, I, E, A> rtree;
530 typedef detail::rtree::private_view<rtree> view;
531 typedef typename view::size_type size_type;
532 typedef typename view::translator_type translator_type;
533 typedef typename view::value_type value_type;
534 typedef typename view::options_type options_type;
535 typedef typename view::box_type box_type;
536 typedef typename view::allocators_type allocators_type;
538 typedef typename options_type::parameters_type parameters_type;
539 typedef typename allocators_type::node_pointer node_pointer;
540 typedef detail::rtree::subtree_destroyer<value_type, options_type, translator_type, box_type, allocators_type> subtree_destroyer;
544 parameters_type params = detail::serialization_load<parameters_type>("parameters", ar);
546 size_type values_count, leafs_level;
547 ar >> boost::serialization::make_nvp("values_count", values_count);
548 ar >> boost::serialization::make_nvp("leafs_level", leafs_level);
551 if ( 0 < values_count )
553 size_type loaded_values_count = 0;
554 n = detail::rtree::load<value_type, options_type, translator_type, box_type, allocators_type>
555 ::apply(ar, version, leafs_level, loaded_values_count, params, tree.members().translator(), tree.members().allocators()); // MAY THROW
557 subtree_destroyer remover(n, tree.members().allocators());
558 if ( loaded_values_count != values_count )
559 BOOST_THROW_EXCEPTION(std::runtime_error("unexpected number of values")); // TODO change exception type
563 tree.members().parameters() = params;
564 tree.members().values_count = values_count;
565 tree.members().leafs_level = leafs_level;
567 subtree_destroyer remover(tree.members().root, tree.members().allocators());
568 tree.members().root = n;
571 template<class Archive, typename V, typename P, typename I, typename E, typename A> inline
572 void serialize(Archive & ar, boost::geometry::index::rtree<V, P, I, E, A> & rt, unsigned int version)
574 split_free(ar, rt, version);
577 template<class Archive, typename V, typename P, typename I, typename E, typename A> inline
578 void serialize(Archive & ar, boost::geometry::index::rtree<V, P, I, E, A> const& rt, unsigned int version)
580 split_free(ar, rt, version);
583 }} // boost::serialization
585 #endif // BOOST_GEOMETRY_INDEX_DETAIL_SERIALIZATION_HPP