Detailed Description

This class manages pointers to Points in a std::vector along with a name. It also handles the deleting of points. Additionally, each vector of points is identified by a unique name from class GEOObject. For this reason PointVec should have a name.

Definition at line 38 of file PointVec.h.

#include <PointVec.h>

Inheritance diagram for GeoLib::PointVec:

[legend]

Collaboration diagram for GeoLib::PointVec:

[legend]

Public Types
enum class	PointType { POINT = 0 , STATION = 1 }
	Signals if the vector contains object of type Point or Station. More...

Public Member Functions
	PointVec (const std::string &name, std::unique_ptr< std::vector< Point * >> points, std::unique_ptr< std::map< std::string, std::size_t >> name_id_map=nullptr, PointType type=PointVec::PointType::POINT, double rel_eps=std::numeric_limits< double >::epsilon())

std::size_t	push_back (Point *pnt)

void	push_back (Point pnt, std::string const const name) override

PointType	getType () const

const std::vector< std::size_t > &	getIDMap () const

const GeoLib::AABB &	getAABB () const

std::string const &	getItemNameByID (std::size_t id) const

void	setNameForElement (std::size_t id, std::string const &name) override
	Sets the given name for the element of the given ID. More...

void	resetInternalDataStructures ()

Public Member Functions inherited from GeoLib::TemplateVec< Point >
	TemplateVec (std::string name, std::unique_ptr< std::vector< Point * >> data_vec, std::unique_ptr< NameIdMap > elem_name_map=nullptr)

virtual	~TemplateVec ()

void	setName (const std::string &n)

std::string	getName () const

NameIdMap::const_iterator	getNameIDMapBegin () const
	Returns the begin of the name id mapping structure. More...

NameIdMap::const_iterator	getNameIDMapEnd () const
	Returns the end of the name id mapping structure. More...

std::size_t	size () const

const std::vector< Point * > *	getVector () const

bool	getElementIDByName (const std::string &name, std::size_t &id) const

const Point *	getElementByName (const std::string &name) const
	Returns an element with the given name. More...

bool	getNameOfElementByID (std::size_t id, std::string &element_name) const

void	setNameOfElementByID (std::size_t id, std::string const &element_name)
	Return the name of an element based on its ID. More...

bool	getNameOfElement (const Point *data, std::string &name) const

Private Member Functions
void	correctNameIDMapping ()

	PointVec (const PointVec &)

	PointVec ()

PointVec &	operator= (const PointVec &rhs)

std::size_t	uniqueInsert (Point *pnt)

Private Attributes
PointType	_type

std::vector< std::size_t >	_pnt_id_map

std::vector< std::string >	_id_to_name_map

AABB	_aabb

double	_rel_eps

std::unique_ptr< GeoLib::OctTree< GeoLib::Point, 16 > >	_oct_tree

Additional Inherited Members
Protected Types inherited from GeoLib::TemplateVec< Point >
using	NameIdPair = std::pair< std::string, std::size_t >

using	NameIdMap = std::map< std::string, std::size_t >

Protected Member Functions inherited from GeoLib::TemplateVec< Point >
	TemplateVec (const TemplateVec &)

TemplateVec &	operator= (const TemplateVec &rhs)

Protected Attributes inherited from GeoLib::TemplateVec< Point >
std::string	_name

std::unique_ptr< std::vector< Point * > >	_data_vec

std::unique_ptr< NameIdMap >	_name_id_map

Member Enumeration Documentation

◆ PointType

enum GeoLib::PointVec::PointType

strong

Signals if the vector contains object of type Point or Station.

Enumerator
POINT
STATION

Definition at line 42 of file PointVec.h.

     {
         POINT    = 0,
         STATION  = 1
     };

Constructor & Destructor Documentation

◆ PointVec() [1/3]

GeoLib::PointVec::PointVec	(	const std::string &	name,
		std::unique_ptr< std::vector< Point * >>	points,
		std::unique_ptr< std::map< std::string, std::size_t >>	name_id_map = `nullptr`,
		PointType	type = `PointVec::PointType::POINT`,
		double	rel_eps = `std::numeric_limits<double>::epsilon()`
	)

Constructor initializes the name of the PointVec object, the internal pointer _pnt_vec to the raw points and the internal pointer the vector of names of the points and sets the type of PointVec.

Parameters

name	the name of the point group
points	Pointer to a vector of pointers to GeoLib::Points.

Attention: {PointVec will take the ownership of (the pointer to) the vector, i.e. it deletes the vector in the destructor! The class takes also the ownership of the GeoLib::Points the pointers within the vector points at, i.e. it delete the points!}

Parameters

name_id_map A std::map that stores the relation name to point.

Attention: {PointVec will take the ownership of the vector, i.e. it deletes the names.}

Parameters

type	the type of the point,

See also: enum PointType

Parameters

rel_eps This is a relative error tolerance value for the test of identical points. The size of the axis aligned bounding box multiplied with the value of rel_eps gives the real tolerance \(tol\). Two points \(p_0, p_1 \) are identical iff \(|p_1 - p_0| \le tol.\)

Definition at line 22 of file PointVec.cpp.

     : TemplateVec<Point>(name, std::move(points), std::move(name_id_map)),
       _type(type),
       _aabb(_data_vec->begin(), _data_vec->end()),
       _rel_eps(rel_eps * (_aabb.getMaxPoint() - _aabb.getMinPoint()).norm()),
       _oct_tree(OctTree<GeoLib::Point, 16>::createOctTree(
           _aabb.getMinPoint(), _aabb.getMaxPoint(), _rel_eps))
 {
     assert(_data_vec);
     std::size_t const number_of_all_input_pnts(_data_vec->size());
  
     // correct the ids if necessary
     for (std::size_t k(0); k < _data_vec->size(); ++k)
     {
         if ((*_data_vec)[k]->getID() == std::numeric_limits<std::size_t>::max())
         {
             (*_data_vec)[k]->setID(k);
         }
     }
  
     std::vector<std::size_t> rm_pos;
     // add all points in the oct tree in order to make them unique
     _pnt_id_map.resize(number_of_all_input_pnts);
     std::iota(_pnt_id_map.begin(), _pnt_id_map.end(), 0);
     GeoLib::Point* ret_pnt(nullptr);
     for (std::size_t k(0); k < _data_vec->size(); ++k)
     {
         GeoLib::Point* const pnt((*_data_vec)[k]);
         if (!_oct_tree->addPoint(pnt, ret_pnt))
         {
             assert(ret_pnt != nullptr);
             _pnt_id_map[pnt->getID()] = ret_pnt->getID();
             rm_pos.push_back(k);
             delete (*_data_vec)[k];
             (*_data_vec)[k] = nullptr;
         }
         else
         {
             _pnt_id_map[k] = pnt->getID();
         }
     }
  
     auto const data_vec_end =
         std::remove(_data_vec->begin(), _data_vec->end(), nullptr);
     _data_vec->erase(data_vec_end, _data_vec->end());
  
     // decrement the ids according to the number of removed points (==k) before
     // the j-th point (positions of removed points are stored in the vector
     // rm_pos)
     for (std::size_t k(1); k < rm_pos.size(); ++k)
     {
         // decrement the ids in the interval [rm_pos[k-1]+1, rm_pos[k])
         for (std::size_t j(rm_pos[k - 1] + 1); j < rm_pos[k]; ++j)
         {
             _pnt_id_map[j] -= k;
         }
     }
     // decrement the ids from rm_pos.back()+1 until the end of _pnt_id_map
     if (!rm_pos.empty())
     {
         for (std::size_t j(rm_pos.back() + 1); j < _pnt_id_map.size(); ++j)
         {
             _pnt_id_map[j] -= rm_pos.size();
         }
     }
     // decrement the ids within the _pnt_id_map at positions of the removed
     // points
     for (std::size_t k(1); k < rm_pos.size(); ++k)
     {
         std::size_t cnt(0);
         for (cnt = 0;
              cnt < rm_pos.size() && _pnt_id_map[rm_pos[k]] > rm_pos[cnt];)
         {
             cnt++;
         }
         _pnt_id_map[rm_pos[k]] -= cnt;
     }
  
     // set value of the point id to the position of the point within _data_vec
     for (std::size_t k(0); k < _data_vec->size(); ++k)
     {
         (*_data_vec)[k]->setID(k);
     }
  
     if (number_of_all_input_pnts > _data_vec->size())
     {
         WARN("PointVec::PointVec(): there are {:d} double points.",
              number_of_all_input_pnts - _data_vec->size());
     }
  
     correctNameIDMapping();
     // create the inverse mapping
     _id_to_name_map.resize(_data_vec->size());
     // fetch the names from the name id map
     for (auto p : *_name_id_map)
     {
         if (p.second >= _id_to_name_map.size())
         {
             continue;
         }
         _id_to_name_map[p.second] = p.first;
     }
 }

References GeoLib::TemplateVec< Point >::_data_vec, _id_to_name_map, GeoLib::TemplateVec< Point >::_name_id_map, _oct_tree, _pnt_id_map, correctNameIDMapping(), MathLib::Point3dWithID::getID(), and WARN().

◆ PointVec() [2/3]

GeoLib::PointVec::PointVec ( const PointVec & )

private

copy constructor doesn't have an implementation

◆ PointVec() [3/3]

GeoLib::PointVec::PointVec ( )

private

standard constructor doesn't have an implementation

Member Function Documentation

◆ correctNameIDMapping()

void GeoLib::PointVec::correctNameIDMapping ( )

private

After the point set is modified (for example by makePntsUnique()) the mapping has to be corrected.

Definition at line 201 of file PointVec.cpp.

 {
     // create mapping id -> name using the std::vector id_names
     std::vector<std::string> id_names(_pnt_id_map.size(), std::string(""));
     for (auto& id_name_pair : *_name_id_map)
     {
         id_names[id_name_pair.second] = id_name_pair.first;
     }
  
     for (auto it = _name_id_map->begin(); it != _name_id_map->end();)
     {
         // extract the id associated with the name
         const std::size_t id(it->second);
  
         if (_pnt_id_map[id] == id)
         {
             ++it;
             continue;
         }
  
         if (_pnt_id_map[_pnt_id_map[id]] == _pnt_id_map[id])
         {
             if (id_names[_pnt_id_map[id]].length() != 0)
             {
                 // point has already a name, erase the second occurrence
                 it = _name_id_map->erase(it);
             }
             else
             {
                 // until now the point has not a name assign the second
                 // occurrence the correct id
                 it->second = _pnt_id_map[id];
                 ++it;
             }
         }
         else
         {
             it->second = _pnt_id_map[id];  // update id associated to the name
             ++it;
         }
     }
 }

References GeoLib::TemplateVec< Point >::_name_id_map, and _pnt_id_map.

Referenced by PointVec().

◆ getAABB()

const GeoLib::AABB& GeoLib::PointVec::getAABB ( ) const

◆ getIDMap()

const std::vector<std::size_t>& GeoLib::PointVec::getIDMap ( ) const

inline

Definition at line 97 of file PointVec.h.

97 { return _pnt_id_map; }

References _pnt_id_map.

Referenced by MeshLib::convertMeshToGeo(), FileIO::SwmmInterface::convertSwmmInputToGeometry(), GeoLib::IO::XmlGmlInterface::readFile(), GeoLib::IO::BoostXmlGmlInterface::readFile(), FileIO::Legacy::readGLIFileV4(), FileIO::SHPInterface::readPolylines(), and FileIO::TetGenInterface::readTetGenGeometry().

◆ getItemNameByID()

std::string const & GeoLib::PointVec::getItemNameByID ( std::size_t id ) const

Definition at line 244 of file PointVec.cpp.

 {
     return _id_to_name_map[id];
 }

References _id_to_name_map.

Referenced by GeoLib::geoPointsToStations(), GeoLib::GEOObjects::mergePoints(), GeoLib::IO::BoostXmlGmlInterface::write(), GeoLib::IO::XmlGmlInterface::write(), FileIO::Legacy::writeAllDataToGLIFileV4(), writeBCsAndGeometry(), and FileIO::Legacy::writeGLIFileV4().

◆ getType()

PointType GeoLib::PointVec::getType ( ) const

inline

get the type of Point, this can be either POINT or STATION

Definition at line 95 of file PointVec.h.

95 { return _type; }

References _type.

◆ operator=()

PointVec& GeoLib::PointVec::operator= ( const PointVec & rhs )

private

assignment operator doesn't have an implementation

◆ push_back() [1/2]

std::size_t GeoLib::PointVec::push_back ( Point * pnt )

Method adds a Point to the (internal) standard vector and takes the ownership. If the given point is already included in the vector, the point will be destroyed and the id of the existing point will be returned.

Parameters

pnt	the pointer to the Point

Returns: the id of the point within the internal vector

Definition at line 129 of file PointVec.cpp.

 {
     _pnt_id_map.push_back(uniqueInsert(pnt));
     _id_to_name_map.emplace_back("");
     return _pnt_id_map[_pnt_id_map.size() - 1];
 }

References _id_to_name_map, _pnt_id_map, and uniqueInsert().

Referenced by FileIO::GMSH::GMSHPolygonTree::checkIntersectionsSegmentExistingPolylines(), GeoLib::computeAndInsertAllIntersectionPoints(), FileIO::GMSH::GMSHPolygonTree::insertPolyline(), MeshGeoToolsLib::insertSubSegments(), and GeoLib::IO::TINInterface::readTIN().

◆ push_back() [2/2]

void GeoLib::PointVec::push_back	(	Point *	pnt,
		std::string const *const	name
	)

overridevirtual

push_back adds new elements at the end of the vector _data_vec.

Parameters

pnt	a pointer to the point, PointVec takes ownership of the point
name	the name of the point

Reimplemented from GeoLib::TemplateVec< Point >.

Definition at line 136 of file PointVec.cpp.

 {
     if (name == nullptr)
     {
         _pnt_id_map.push_back(uniqueInsert(pnt));
         _id_to_name_map.emplace_back("");
         return;
     }
  
     std::map<std::string, std::size_t>::const_iterator it(
         _name_id_map->find(*name));
     if (it != _name_id_map->end())
     {
         _id_to_name_map.emplace_back("");
         WARN("PointVec::push_back(): two points share the name {:s}.",
              name->c_str());
         return;
     }
  
     std::size_t id(uniqueInsert(pnt));
     _pnt_id_map.push_back(id);
     (*_name_id_map)[*name] = id;
     _id_to_name_map.push_back(*name);
 }

References _id_to_name_map, GeoLib::TemplateVec< Point >::_name_id_map, _pnt_id_map, MaterialPropertyLib::name, uniqueInsert(), and WARN().

◆ resetInternalDataStructures()

void GeoLib::PointVec::resetInternalDataStructures ( )

Resets the internal data structures, i.e., the axis aligned bounding box, the relative epsilon for the equality tests and the oct tree data structure.

Note: This method have to be called if the coordinates of a point stored by the PointVec is modified from outside.

Definition at line 255 of file PointVec.cpp.

 {
     auto const& min(_aabb.getMinPoint());
     auto const& max(_aabb.getMaxPoint());
     double const rel_eps(_rel_eps / (max - min).norm());
  
     _aabb = GeoLib::AABB(_data_vec->begin(), _data_vec->end());
  
     _rel_eps = rel_eps * (_aabb.getMaxPoint() - _aabb.getMinPoint()).norm();
  
     _oct_tree.reset(OctTree<GeoLib::Point, 16>::createOctTree(
         _aabb.getMinPoint(), _aabb.getMaxPoint(), _rel_eps));
  
     GeoLib::Point* ret_pnt(nullptr);
     for (auto const p : *_data_vec)
     {
         _oct_tree->addPoint(p, ret_pnt);
     }
 }

References _aabb, GeoLib::TemplateVec< Point >::_data_vec, _oct_tree, _rel_eps, GeoLib::AABB::getMaxPoint(), GeoLib::AABB::getMinPoint(), and MathLib::LinAlg::norm().

Referenced by MeshGeoToolsLib::mapPolylineOnSurfaceMesh().

◆ setNameForElement()

void GeoLib::PointVec::setNameForElement	(	std::size_t	id,
		std::string const &	name
	)

overridevirtual

Sets the given name for the element of the given ID.

Reimplemented from GeoLib::TemplateVec< Point >.

Definition at line 249 of file PointVec.cpp.

 {
     TemplateVec::setNameForElement(id, name);
     _id_to_name_map[id] = name;
 }

References _id_to_name_map, MaterialPropertyLib::name, and GeoLib::TemplateVec< T >::setNameForElement().

Referenced by GEOModels::addNameForElement(), and GEOModels::addNameForObjectPoints().

◆ uniqueInsert()

std::size_t GeoLib::PointVec::uniqueInsert ( Point * pnt )

private

Inserts the instance of the Point into internal data structures (

See also: TemplateVec::_data_vec, _pnt_id_map) if and only if there does not exist a point with the same coordinates (up to std::numeric_limits<double>::epsilon()). In case there exists already a point with the same coordinates the given pnt-object will be deleted!

Parameters

pnt	Pointer to GeooLib::Point instance

Returns: either the new id or the id of the existing point with the same coordinates

Definition at line 161 of file PointVec.cpp.

 {
     GeoLib::Point* ret_pnt(nullptr);
     if (_oct_tree->addPoint(pnt, ret_pnt))
     {
         // set value of the point id to the position of the point within
         // _data_vec
         pnt->setID(_data_vec->size());
         _data_vec->push_back(pnt);
         return _data_vec->size() - 1;
     }
  
     // pnt is outside of OctTree object
     if (ret_pnt == nullptr)
     {
         // update the axis aligned bounding box
         _aabb.update(*pnt);
         // recreate the (enlarged) OctTree
         _oct_tree.reset(GeoLib::OctTree<GeoLib::Point, 16>::createOctTree(
             _aabb.getMinPoint(), _aabb.getMaxPoint(), _rel_eps));
         // add all points that are already in the _data_vec
         for (std::size_t k(0); k < _data_vec->size(); ++k)
         {
             GeoLib::Point* const p((*_data_vec)[k]);
             _oct_tree->addPoint(p, ret_pnt);
         }
         // add the new point
         ret_pnt = nullptr;
         _oct_tree->addPoint(pnt, ret_pnt);
         // set value of the point id to the position of the point within
         // _data_vec
         pnt->setID(_data_vec->size());
         _data_vec->push_back(pnt);
         return _data_vec->size() - 1;
     }
  
     delete pnt;
     return ret_pnt->getID();
 }

References _aabb, GeoLib::TemplateVec< Point >::_data_vec, _oct_tree, _rel_eps, MathLib::Point3dWithID::getID(), GeoLib::AABB::getMaxPoint(), GeoLib::AABB::getMinPoint(), MathLib::Point3dWithID::setID(), and GeoLib::AABB::update().

Referenced by push_back().

Member Data Documentation

◆ _aabb

AABB GeoLib::PointVec::_aabb

private

Definition at line 154 of file PointVec.h.

Referenced by resetInternalDataStructures(), and uniqueInsert().

◆ _id_to_name_map

std::vector<std::string> GeoLib::PointVec::_id_to_name_map

private

The reverse map to the name to id map, for fast lookup of the name to a given point id.

Definition at line 152 of file PointVec.h.

Referenced by PointVec(), getItemNameByID(), push_back(), and setNameForElement().

◆ _oct_tree

std::unique_ptr<GeoLib::OctTree<GeoLib::Point, 16> > GeoLib::PointVec::_oct_tree

private

Definition at line 156 of file PointVec.h.

Referenced by PointVec(), resetInternalDataStructures(), and uniqueInsert().

◆ _pnt_id_map

std::vector<std::size_t> GeoLib::PointVec::_pnt_id_map

private

permutation of the geometric elements according to their lexicographical order

Definition at line 148 of file PointVec.h.

Referenced by PointVec(), correctNameIDMapping(), getIDMap(), and push_back().

◆ _rel_eps

double GeoLib::PointVec::_rel_eps

private

Definition at line 155 of file PointVec.h.

Referenced by resetInternalDataStructures(), and uniqueInsert().

◆ _type

PointType GeoLib::PointVec::_type

private

the type of the point (

See also: enum PointType)

Definition at line 142 of file PointVec.h.

Referenced by getType().

The documentation for this class was generated from the following files:

GeoLib/PointVec.h
GeoLib/PointVec.cpp

Detailed Description

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ PointType

Constructor & Destructor Documentation

◆ PointVec() [1/3]

◆ PointVec() [2/3]

◆ PointVec() [3/3]

Member Function Documentation

◆ correctNameIDMapping()

◆ getAABB()

◆ getIDMap()

◆ getItemNameByID()

◆ getType()

◆ operator=()

◆ push_back() [1/2]

◆ push_back() [2/2]

◆ resetInternalDataStructures()

◆ setNameForElement()

◆ uniqueInsert()

Member Data Documentation

◆ _aabb

◆ _id_to_name_map

◆ _oct_tree

◆ _pnt_id_map

◆ _rel_eps

◆ _type