FMT 1.2.0
Forest management tools for forest planning
Loading...
Searching...
No Matches
FMTEventContainer.h
Go to the documentation of this file.
1/*
2Copyright (c) 2019 Gouvernement du Québec
3
4SPDX-License-Identifier: LiLiQ-R-1.1
5License-Filename: LICENSES/EN/LiLiQ-R11unicode.txt
6*/
7
8#ifndef FMTeventCONTAINER_H
9#define FMTeventCONTAINER_H
10
11#include "FMTEvent.h"
12#include <boost/serialization/serialization.hpp>
13#include <boost/serialization/nvp.hpp>
14#include <boost/serialization/set.hpp>
15#include <unordered_set>
16#include <boost/unordered_set.hpp>
17#include "FMTObject.h"
18
19
20namespace Spatial
21{
22
23class FMTBindingSpatialAction;
24class FMTSpatialGraphs;
25
26// DocString: FMTEventContainer
31class FMTEXPORT FMTEventContainer : public Core::FMTObject
32{
33 public:
34 typedef typename std::set<FMTEvent>::value_type value_type;
35 typedef typename std::set<FMTEvent>::iterator iterator;
36 typedef typename std::set<FMTEvent>::const_iterator const_iterator;
37 typedef typename std::set<FMTEvent>::const_reverse_iterator const_reverse_iterator;
38 // DocString: FMTEventContainer()
42 FMTEventContainer()=default;
43 // DocString: ~FMTEventContainer()
47 ~FMTEventContainer()=default;
48 // DocString: FMTEventContainer(const FMTEventContainer&)
53 FMTEventContainer(const FMTEventContainer& rhs)=default;
54 // DocString: FMTEventContainer::operator=
60 FMTEventContainer& operator=(const FMTEventContainer& rhs)=default;
61 // DocString: FMTEventContainer::operator==
67 bool operator==(const FMTEventContainer& rhs) const;
68 // DocString: FMTEventContainer::swap
73 void swap(FMTEventContainer& rhs);
74 // DocString: FMTEventContainer::begin
79 const_iterator begin() const;
80 // DocString: FMTEventContainer::end
85 const_iterator end() const;
86 // DocString: FMTEventContainer::empty
91 bool empty() const;
92 // DocString: FMTEventContainer::size
97 size_t size() const;
98 // DocString: FMTEventContainer::find
105 const_iterator find(const int& period, const FMTCoordinate& coord) const;
106 // DocString: FMTEventContainer::find
112 const_iterator find(const FMTEvent& event) const;
113 // DocString: FMTEventContainer::insert
118 void insert(const FMTEvent& event);
119 // DocString: FMTEventContainer::merge
124 void merge(const FMTEventContainer& levents);
125 // DocString: FMTEventContainer::erase(const FMTEvent&)
130 void erase(const FMTEvent& event);
131 // DocString: FMTEventContainer::erase(const const_iterator)
137 const_iterator erase (const const_iterator event);
138 // DocString: FMTEventContainer::clear
142 void clear();
143 // DocString: FMTEventContainer::lasperiod
148 int lastPeriod()const;
149 // DocString: FMTEventContainer::firstPeriod
154 int firstPeriod()const;
155 // DocString: FMTEventContainer::eraseCoordinate
162 void eraseCoordinate(const FMTCoordinate& p_coord,
163 const int& p_periodStart,const std::vector<std::vector<bool>>& p_actionstarget);
164 // DocString: FMTEventContainer::getBounds(const int&)
170 std::pair<const_iterator,const_iterator> getBounds(const int& period) const;
171 // DocString: FMTEventContainer::addAction(const FMTCoordinate&, const int&, const int&,const FMTBindingSpatialAction&)
180 void addAction (const FMTCoordinate& coord, const int& period,
181 const int& actionid,const FMTBindingSpatialAction& binding, size_t p_GraphFamily);
182 // DocString: FMTEventContainer::addActions()
192 void addActions(const FMTCoordinate& coord, const int& period,
193 const std::vector<int>& actionids, const std::vector<FMTBindingSpatialAction>& bindings, size_t p_GraphFamily);
194 // DocString: FMTEventContainer::getEvents(const int&, const int&)
201 std::vector<const_iterator> getEvents(const int& period, const int& action_id) const;
202 // DocString: FMTEventContainer::getEvents(const int&, const int&,const FMTCoordinate&,const FMTCoordinate&)
211 std::vector<const_iterator> getEvents(const int& period, const int& action_id,
212 const FMTCoordinate& minimalcoordinate, const FMTCoordinate& maximalcoordinate) const;
213 // DocString: FMTEventContainer::getMultipleEvents()
222 std::vector<std::vector<const_iterator>> getMultipleEvents(const int& period, const std::vector<int>& action_ids,
223 const FMTCoordinate& minimalcoordinate, const FMTCoordinate& maximalcoordinate) const;
224 // DocString: FMTEventContainer::getEvents(const int&, const std::vector<int>&)
231 std::vector<const_iterator> getEvents(const int& period, const std::vector<int>& actions_id) const;
232 // DocString: FMTEventContainer::getEvents(const int&, const std::vector<bool>&)
239 std::vector<const_iterator> getEvents(const int& period, const std::vector<bool>& actions_used) const;
240 // DocString: FMTEventContainer::getEvents(const int&, const std::vector<bool>&,const FMTCoordinate&, const FMTCoordinate&)
249 std::vector<const_iterator> getEvents(const int& period, const std::vector<bool>& actions_used,
250 const FMTCoordinate& minimalcoordinate, const FMTCoordinate& maximalcoordinate) const;
251 // DocString: FMTEventContainer::getEvents(const int&, const FMTCoordinate&)
258 std::vector<const_iterator> getEvents(const int& period, const FMTCoordinate& coord) const;
259 // DocString: FMTEventContainer::getEventsToErase
269 FMTEventContainer getEventsToErase(const int& fromperiod, const std::vector<std::vector<bool>>& actionstarget,
270 const FMTCoordinate& coord,const size_t& buffer,FMTEventContainer& newevents) const;
271 // DocString: FMTEventContainer::getEventsToAdd
282 FMTEventContainer getEventsToAdd(const FMTCoordinate& coord, const int& period, const int& actionid,
283 const FMTBindingSpatialAction& binding, FMTEventContainer& newevents,
284 size_t p_GraphFamily) const;
285 // DocString: FMTEventContainer::getContainer
294 FMTEventContainer getContainer(std::vector<FMTCoordinate> coordinates, const int& minperiod, const int& maxperiod, const size_t& buffer) const;
295
296 // DocString: FMTEventContainer::addUpdate
303 FMTEventContainer addUpdate(const FMTEventContainer& newevents,const FMTEventContainer& eventstoremove);
304
305 // DocString: FMTEventContainer::getEvents(const int&, const std::set<FMTCoordinate>&)
312 std::vector<const_iterator> getEvents(const int& period, const std::set<FMTCoordinate>& territory) const;
313 // DocString: FMTEventContainer::minimalDistance
323 double minimalDistance(const FMTEvent& p_event,const unsigned int& p_distancel,
324 const int& p_period, const std::vector<int>& p_actionsid) const;
325 // DocString: FMTEventContainer::evaluateDistance
336 double evaluateDistance(const FMTEvent& p_event,
337 const double& p_lowerdistancetoevent,
338 const double& p_upperdistancetoevent,
339 const int& p_period, const std::vector<bool>& p_actionsused,
340 boost::unordered_set<FMTEventRelation>& p_relations) const;
341
342 // DocString: FMTEventContainer::evaluateSize
352 double evaluateSize(const std::vector<bool>& p_actions,
353 int p_period,size_t p_lowerBound, size_t p_upperBound, bool p_testLower) const;
354
355 // DocString: FMTEventContainer::getDispersion(const std::vector<bool>&,const FMTSpatialGraphs&,int,int,int,int)
366 double getDispersion(const std::vector<bool>& p_actions,
367 const FMTSpatialGraphs& p_Graphs,
368 int p_themeId,int p_FirstPeriod,
369 int p_LastPeriod, int p_bound) const;
370
371 // DocString: FMTEventContainer::getDispersion(int,const FMTSpatialGraphs&,int,int,int,int)
382 double getDispersion(int p_RuleId,
383 const FMTSpatialGraphs& p_Graphs,
384 int p_themeId, int p_FirstPeriod,
385 int p_LastPeriod, int p_bound) const;
386
387 // DocString: FMTEventContainer::getDispersionConflicts(const std::vector<bool>&,const FMTSpatialGraphs&,int,int,int,int)
398 std::vector<FMTEventContainer::const_iterator> getDispersionConflicts(const std::vector<bool>& p_actions,
399 const FMTSpatialGraphs& p_Graphs,
400 int p_themeId,int p_FirstPeriod,
401 int p_LastPeriod, int p_bound) const;
402 // DocString: FMTEventContainer::getDispersionConflicts(int,const FMTSpatialGraphs&,int,int,int,int)
413 std::vector<FMTEventContainer::const_iterator> getDispersionConflicts(int p_RuleId,
414 const FMTSpatialGraphs& p_Graphs,
415 int p_themeId, int p_FirstPeriod,
416 int p_LastPeriod, int p_bound) const;
417 // DocString: FMTEventContainer::getEventsOf
425 std::vector<FMTEventContainer::const_iterator>getEventsOf(int p_RuleId,
426 int p_MinimalPeriod, int p_MaximalPeriod) const;
427
428 private:
429 class BoundingBox
430 {
431 public:
432 BoundingBox();
433 void add(FMTEventContainer::const_iterator p_event);
434 double evaluateUpperBound(int p_UpperBound) const;
435 std::vector<FMTEventContainer::const_iterator> getEvents() const;
436 private:
437 FMTCoordinate m_bottomLeft;
438 uint16_t m_Width;
439 uint16_t m_Height;
440 FMTEventContainer::const_iterator m_Top;
441 FMTEventContainer::const_iterator m_Bottom;
442 FMTEventContainer::const_iterator m_Left;
443 FMTEventContainer::const_iterator m_Right;
444 bool _isNull() const;
445 double _getSize() const;
446 };
447 friend class boost::serialization::access;
448 // DocString: FMTEventContainer::serialize
455 template<class Archive>
456 void serialize(Archive& ar, const unsigned int version)
457 {
458 ar& boost::serialization::make_nvp("FMTobject", boost::serialization::base_object<FMTObject>(*this));
459 ar& BOOST_SERIALIZATION_NVP(m_events);
460 }
462 std::set<FMTEvent> m_events;
463 //Actually not needed
465 const_iterator _upperBound(const int& period) const;
467 const_iterator _upperBound(const int& period,const FMTCoordinate& maxxycoord) const;
470 const_iterator _lowerBound(const int& period) const;
473 const_iterator _lowerBound(const int& period, const FMTCoordinate& minxycoord) const;
477 void erase(const FMTCoordinate& coord, const std::vector<const_iterator>& iterators);
478 // DocString: FMTEventContainer::pushAction
488 void pushAction(const std::vector<FMTEventContainer::const_iterator>& iterators,
489 const FMTCoordinate& coord, const int& period, const int& actionid,
490 size_t neighborsize, size_t p_GraphFamily);
491 // DocString: FMTEventContainer::getAroundEvents()
499 std::vector<FMTEventContainer::const_iterator> getAroundEvents(const std::vector<FMTEventContainer::const_iterator>& iterators,
500 const FMTCoordinate& coord, const size_t& neighborsize) const;
501 // DocString: FMTEventContainer::fastsort
508 void nthElements(std::vector<FMTEventContainer::const_iterator>& iterators,const FMTCoordinate& coord,const size_t& nelement) const;
509
510
511 std::vector<BoundingBox> _getBoundingBoxes(const std::vector<bool>& p_actions,
512 const FMTSpatialGraphs& p_Graphs, int p_themeId,
513 int p_FirstPeriod, int p_LastPeriod) const;
514
515 std::vector<BoundingBox> _getBoundingBoxes(int p_RuleId,
516 const FMTSpatialGraphs& p_Graphs, int p_themeId,
517 int p_FirstPeriod, int p_LastPeriod) const;
518
519 class FMTEventIteratorSorter
520 {
521 public:
522 FMTEventIteratorSorter(const FMTCoordinate& coordinate);
523 bool operator() (const FMTEventContainer::const_iterator& eventit1, const FMTEventContainer::const_iterator& eventit2) const;
524 private:
525 FMTCoordinate m_basecoordinate;
526 };
527
528
529};
530
531
532}
533#endif // FMTeventCONTAINER_H
FMTEXPORT
#define FMTEXPORT
Definition: FMTutility.h:125
Core::FMTObject
Base class of multiple FMT classes holding a shared exception handler pointer and logger.
Definition: FMTObject.h:49
Spatial::FMTBindingSpatialAction
Spatial binding of an action, holding the green up, adjacency, size and neighbors constraints used to...
Definition: FMTBindingSpatialAction.h:23
Spatial::FMTCoordinate
Spatially referenced coordinate holding an x and y position on a raster grid.
Definition: FMTCoordinate.h:29
Spatial::FMTEventContainer
Container of FMTEvent handling event comparison and distance calculation efficiently,...
Definition: FMTEventContainer.h:32
Spatial::FMTEventContainer::addAction
void addAction(const FMTCoordinate &coord, const int &period, const int &actionid, const FMTBindingSpatialAction &binding, size_t p_GraphFamily)
Add an action at a coordinate, adding to an existing event if possible or aggregating events based on...
Spatial::FMTEventContainer::evaluateDistance
double evaluateDistance(const FMTEvent &p_event, const double &p_lowerdistancetoevent, const double &p_upperdistancetoevent, const int &p_period, const std::vector< bool > &p_actionsused, boost::unordered_set< FMTEventRelation > &p_relations) const
Add up the distances of the events that are within (or not within) a distance range for a period.
Spatial::FMTEventContainer::getBounds
std::pair< const_iterator, const_iterator > getBounds(const int &period) const
Return a pair of iterators pointing to the first and the last elements of a period.
Spatial::FMTEventContainer::getEventsOf
std::vector< FMTEventContainer::const_iterator > getEventsOf(int p_RuleId, int p_MinimalPeriod, int p_MaximalPeriod) const
Return the events of a rule for a period range.
Spatial::FMTEventContainer::lastPeriod
int lastPeriod() const
Return the period of the last event in the container.
Spatial::FMTEventContainer::FMTEventContainer
FMTEventContainer()=default
Default constructor for FMTEventContainer.
Spatial::FMTEventContainer::begin
const_iterator begin() const
Return a const iterator to the first event.
Spatial::FMTEventContainer::find
const_iterator find(const FMTEvent &event) const
Return a const iterator to an event.
Spatial::FMTEventContainer::getEvents
std::vector< const_iterator > getEvents(const int &period, const std::set< FMTCoordinate > &territory) const
Return the events at a period for multiple coordinates.
Spatial::FMTEventContainer::getDispersionConflicts
std::vector< FMTEventContainer::const_iterator > getDispersionConflicts(int p_RuleId, const FMTSpatialGraphs &p_Graphs, int p_themeId, int p_FirstPeriod, int p_LastPeriod, int p_bound) const
Return the events in dispersion conflict for a rule, a theme and a period range.
Spatial::FMTEventContainer::find
const_iterator find(const int &period, const FMTCoordinate &coord) const
Return a const iterator to the first event found with a coordinate at a period.
Spatial::FMTEventContainer::getEventsToAdd
FMTEventContainer getEventsToAdd(const FMTCoordinate &coord, const int &period, const int &actionid, const FMTBindingSpatialAction &binding, FMTEventContainer &newevents, size_t p_GraphFamily) const
Add an action to a coordinate and return the modified events whose infeasibility needs to be recalcul...
Spatial::FMTEventContainer::getEvents
std::vector< const_iterator > getEvents(const int &period, const std::vector< int > &actions_id) const
Return the events at a period for multiple action ids.
Spatial::FMTEventContainer::getDispersionConflicts
std::vector< FMTEventContainer::const_iterator > getDispersionConflicts(const std::vector< bool > &p_actions, const FMTSpatialGraphs &p_Graphs, int p_themeId, int p_FirstPeriod, int p_LastPeriod, int p_bound) const
Return the events in dispersion conflict for a theme and a period range.
Spatial::FMTEventContainer::firstPeriod
int firstPeriod() const
Return the period of the first event in the container.
Spatial::FMTEventContainer::const_reverse_iterator
std::set< FMTEvent >::const_reverse_iterator const_reverse_iterator
Definition: FMTEventContainer.h:37
Spatial::FMTEventContainer::iterator
std::set< FMTEvent >::iterator iterator
Definition: FMTEventContainer.h:35
Spatial::FMTEventContainer::eraseCoordinate
void eraseCoordinate(const FMTCoordinate &p_coord, const int &p_periodStart, const std::vector< std::vector< bool > > &p_actionstarget)
Erase all the coordinates corresponding to a coordinate in the events from a period.
Spatial::FMTEventContainer::getEvents
std::vector< const_iterator > getEvents(const int &period, const FMTCoordinate &coord) const
Return the events at a period for a coordinate.
Spatial::FMTEventContainer::getContainer
FMTEventContainer getContainer(std::vector< FMTCoordinate > coordinates, const int &minperiod, const int &maxperiod, const size_t &buffer) const
Return a subset of the container on the coordinates of interest.
Spatial::FMTEventContainer::getEvents
std::vector< const_iterator > getEvents(const int &period, const int &action_id, const FMTCoordinate &minimalcoordinate, const FMTCoordinate &maximalcoordinate) const
Return the events at a period for an action between a minimal and a maximal coordinate.
Spatial::FMTEventContainer::end
const_iterator end() const
Return a const iterator past the last event.
Spatial::FMTEventContainer::erase
void erase(const FMTEvent &event)
Erase an event from the container.
Spatial::FMTEventContainer::swap
void swap(FMTEventContainer &rhs)
Swap the events of this container with another one.
Spatial::FMTEventContainer::getDispersion
double getDispersion(const std::vector< bool > &p_actions, const FMTSpatialGraphs &p_Graphs, int p_themeId, int p_FirstPeriod, int p_LastPeriod, int p_bound) const
Evaluate the dispersion infeasibility of the events for a theme and a period range.
Spatial::FMTEventContainer::getMultipleEvents
std::vector< std::vector< const_iterator > > getMultipleEvents(const int &period, const std::vector< int > &action_ids, const FMTCoordinate &minimalcoordinate, const FMTCoordinate &maximalcoordinate) const
Return the events at a period for multiple actions between a minimal and a maximal coordinate.
Spatial::FMTEventContainer::empty
bool empty() const
Test whether the container is empty.
Spatial::FMTEventContainer::addActions
void addActions(const FMTCoordinate &coord, const int &period, const std::vector< int > &actionids, const std::vector< FMTBindingSpatialAction > &bindings, size_t p_GraphFamily)
Add actions at a coordinate, adding to an existing event if possible or aggregating events based on t...
Spatial::FMTEventContainer::value_type
std::set< FMTEvent >::value_type value_type
Definition: FMTEventContainer.h:34
Spatial::FMTEventContainer::getEvents
std::vector< const_iterator > getEvents(const int &period, const std::vector< bool > &actions_used) const
Return the events at a period for the used actions.
Spatial::FMTEventContainer::getDispersion
double getDispersion(int p_RuleId, const FMTSpatialGraphs &p_Graphs, int p_themeId, int p_FirstPeriod, int p_LastPeriod, int p_bound) const
Evaluate the dispersion infeasibility of the events for a rule, a theme and a period range.
Spatial::FMTEventContainer::operator=
FMTEventContainer & operator=(const FMTEventContainer &rhs)=default
Copy assignment operator for FMTEventContainer.
Spatial::FMTEventContainer::size
size_t size() const
Return the number of events in the container.
Spatial::FMTEventContainer::minimalDistance
double minimalDistance(const FMTEvent &p_event, const unsigned int &p_distancel, const int &p_period, const std::vector< int > &p_actionsid) const
Return the minimal distance between an event and the other events for a period, or the distance plus ...
Spatial::FMTEventContainer::merge
void merge(const FMTEventContainer &levents)
Merge another FMTEventContainer into this one.
Spatial::FMTEventContainer::getEvents
std::vector< const_iterator > getEvents(const int &period, const std::vector< bool > &actions_used, const FMTCoordinate &minimalcoordinate, const FMTCoordinate &maximalcoordinate) const
Return the events at a period for the used actions between a minimal and a maximal coordinate.
Spatial::FMTEventContainer::getEventsToErase
FMTEventContainer getEventsToErase(const int &fromperiod, const std::vector< std::vector< bool > > &actionstarget, const FMTCoordinate &coord, const size_t &buffer, FMTEventContainer &newevents) const
Return the events to erase when removing a coordinate, starting from a period based on a buffer aroun...
Spatial::FMTEventContainer::evaluateSize
double evaluateSize(const std::vector< bool > &p_actions, int p_period, size_t p_lowerBound, size_t p_upperBound, bool p_testLower) const
Evaluate the size infeasibility of the events for a period against a size range.
Spatial::FMTEventContainer::insert
void insert(const FMTEvent &event)
Insert an event in the container.
Spatial::FMTEventContainer::getEvents
std::vector< const_iterator > getEvents(const int &period, const int &action_id) const
Return the events at a period for an action.
Spatial::FMTEventContainer::erase
const_iterator erase(const const_iterator event)
Erase an event from the container and return the next iterator.
Spatial::FMTEventContainer::operator==
bool operator==(const FMTEventContainer &rhs) const
Comparison operator for FMTEventContainer.
Spatial::FMTEventContainer::FMTEventContainer
FMTEventContainer(const FMTEventContainer &rhs)=default
Copy constructor for FMTEventContainer.
Spatial::FMTEventContainer::clear
void clear()
Clear the content of the container.
Spatial::FMTEventContainer::~FMTEventContainer
~FMTEventContainer()=default
Default destructor for FMTEventContainer.
Spatial::FMTEventContainer::const_iterator
std::set< FMTEvent >::const_iterator const_iterator
Definition: FMTEventContainer.h:36
Spatial::FMTEventContainer::addUpdate
FMTEventContainer addUpdate(const FMTEventContainer &newevents, const FMTEventContainer &eventstoremove)
Update the container by adding the new events and removing the events to remove, used to compute the ...
Spatial::FMTEvent
Base class for a spatial event (FMTsaevent or FMTsesevent): a set of FMTCoordinate corresponding to t...
Definition: FMTEvent.h:28
Spatial::FMTSpatialGraphs
Container of the line graphs of a spatially explicit model, organized by constraint family,...
Definition: FMTSpatialGraphs.h:52
Spatial
Definition: FMTAreaParser.h:40
Generated by doxygen 1.9.6