genericmap.h 14 KB
Newer Older
Pierre Kraemer's avatar
Pierre Kraemer committed
1 2 3
/*******************************************************************************
* CGoGN: Combinatorial and Geometric modeling with Generic N-dimensional Maps  *
* version 0.1                                                                  *
4
* Copyright (C) 2009-2011, IGG Team, LSIIT, University of Strasbourg           *
Pierre Kraemer's avatar
Pierre Kraemer committed
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
*                                                                              *
* This library is free software; you can redistribute it and/or modify it      *
* under the terms of the GNU Lesser General Public License as published by the *
* Free Software Foundation; either version 2.1 of the License, or (at your     *
* option) any later version.                                                   *
*                                                                              *
* This library is distributed in the hope that it will be useful, but WITHOUT  *
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or        *
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License  *
* for more details.                                                            *
*                                                                              *
* You should have received a copy of the GNU Lesser General Public License     *
* along with this library; if not, write to the Free Software Foundation,      *
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA.           *
*                                                                              *
20
* Web site: http://cgogn.u-strasbg.fr/                                         *
Pierre Kraemer's avatar
Pierre Kraemer committed
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
* Contact information: cgogn@unistra.fr                                        *
*                                                                              *
*******************************************************************************/

#ifndef __GENERIC_MAP__
#define __GENERIC_MAP__

#include <iostream>
#include <sstream>
#include <fstream>
#include <iomanip>
#include <list>
#include <vector>
#include <map>

36
#include "Container/attributeContainer.h"
Pierre Kraemer's avatar
Pierre Kraemer committed
37

Pierre Kraemer's avatar
Pierre Kraemer committed
38 39 40 41 42 43 44
#include "Topology/generic/dart.h"
#include "Topology/generic/marker.h"
#include "Topology/generic/functor.h"

namespace CGoGN
{

CGoGN GIT Supervisor's avatar
CGoGN GIT Supervisor committed
45 46 47 48 49 50 51 52 53 54 55 56 57 58
/*
const unsigned int EMBNULL = 0xffffffff;

const unsigned int NB_ORBITS = 6;
const unsigned int NB_THREAD = 16;

const unsigned int VERTEX	= 0;
const unsigned int EDGE		= 1;
const unsigned int ORIENTED_FACE= 2;
const unsigned int FACE		= 3;
const unsigned int VOLUME	= 4;
const unsigned int DART		= 5;
*/

Pierre Kraemer's avatar
Pierre Kraemer committed
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
/**
 * Class that allows to browse a map
 * This is a pure virtual class that can be overloaded in:
 * - a map (generic and so on)
 * - a MapBrowserSelector
 * - a MapBrowserLinked (Attr or Auto)
 */
class MapBrowser
{
public:
	virtual Dart begin() = 0;
	virtual Dart end() = 0;
	virtual void next(Dart& d) = 0;
};

74 75
class AttributeHandlerGen ;

Pierre Kraemer's avatar
Pierre Kraemer committed
76 77 78
class GenericMap : public MapBrowser
{

79
	template<typename T> friend class AttributeHandler ;
Pierre Kraemer's avatar
Pierre Kraemer committed
80
	template<typename T> friend class AutoAttributeHandler ;
Sylvain Thery's avatar
Sylvain Thery committed
81
	template <typename T> friend class SelectorNoBoundary ;
Pierre Kraemer's avatar
Pierre Kraemer committed
82 83 84 85 86

protected:
	/**
	 * Attributes Containers
	 */
87
	AttributeContainer m_attribs[NB_ORBITS] ;
Pierre Kraemer's avatar
Pierre Kraemer committed
88

89
	static std::map<std::string, RegisteredBaseAttribute*>* m_attributes_registry_map ;
Pierre Kraemer's avatar
Pierre Kraemer committed
90 91 92 93 94

	/**
	 * Direct access to the Dart attributes that store the orbits embeddings
	 * (only initialized when necessary)
	 */
95
	AttributeMultiVector<unsigned int>* m_embeddings[NB_ORBITS] ;
Pierre Kraemer's avatar
Pierre Kraemer committed
96 97

	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
98
	 * Marks manager
Pierre Kraemer's avatar
Pierre Kraemer committed
99
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
100
	MarkSet m_marksets[NB_ORBITS][NB_THREAD] ;
Pierre Kraemer's avatar
Pierre Kraemer committed
101 102 103 104

	/**
	 * Direct access to the attributes that store Marks
	 */
105 106 107
	AttributeMultiVector<Mark>* m_markTables[NB_ORBITS][NB_THREAD] ;

	unsigned int m_nbThreads ;
Sylvain Thery's avatar
Sylvain Thery committed
108

109
	std::multimap<AttributeMultiVectorGen*, AttributeHandlerGen*> attributeHandlers ;
Pierre Kraemer's avatar
Pierre Kraemer committed
110 111

public:
112
	static const unsigned int UNKNOWN_ATTRIB = AttributeContainer::UNKNOWN ;
Pierre Kraemer's avatar
Pierre Kraemer committed
113

114
	GenericMap() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
115

116
	~GenericMap() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
117

118 119 120 121 122 123 124 125 126
	virtual std::string mapTypeName() = 0 ;

	/**
	 * Clear the map
	 * @param removeAttrib
	 *   if false -> data is deleted but all attributes remain (all AttributeHandlers are still valid)
	 *   if true -> data and attributes are deleted (AttributeHandlers are invalid)
	 */
	virtual void clear(bool removeAttrib) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
127

Sylvain Thery's avatar
Sylvain Thery committed
128 129 130 131 132
	/**
	 * get the marker_set of an orbit and thread (used for Cell & Dart Marker)
	 */
	MarkSet& getMarkerSet(unsigned int orbit, unsigned int thread) { return m_marksets[orbit][thread]; }

Pierre Kraemer's avatar
Pierre Kraemer committed
133 134 135 136 137 138 139
	/****************************************
	 *           DARTS MANAGEMENT           *
	 ****************************************/
protected:
	/**
	 * Add a dart to the map
	 */
140
	virtual Dart newDart() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
141 142 143 144

	/**
	 * Erase a dart of the map
	 */
145
	void deleteDart(Dart d) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
146 147 148 149 150 151 152 153 154 155

public:
	/**
	 * return true if the dart d refers to a valid index
	 */
	bool isDartValid(Dart d) ;

	/**
	 * @return the number of darts in the map
	 */
156
	unsigned int getNbDarts() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
157 158 159 160 161 162 163 164

	/****************************************
	 *         EMBEDDING MANAGEMENT         *
	 ****************************************/

	/**
	 * tell if an orbit is embedded or not
	 */
165
	bool isOrbitEmbedded(unsigned int orbit) const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
166 167

	/**
168
	 * return the number of embedded orbits (including DART)
Pierre Kraemer's avatar
Pierre Kraemer committed
169
	 */
170
	unsigned int nbEmbeddings() const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
171 172 173 174 175 176

	/**
	 * get the cell index of the given dimension associated to dart d
	 * (can go through the whole orbit due to lazy embedding)
	 * @return EMBNULL if the orbit of d is not attached to any cell
	 */
177
	unsigned int getEmbedding(unsigned int orbit, Dart d) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
178 179 180 181

	/**
	 * Set the cell index of the given dimension associated to dart d
	 */
182
	void setDartEmbedding(unsigned int orbit, Dart d, unsigned int emb) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
183 184 185 186 187 188 189

	/**
	 * Copy the index of the cell associated to a dart over an other dart
	 * @param d the dart to overwrite (dest)
	 * @param e the dart to copy (src)
	 * @param orbit the id of orbit embedding
	 */
190
	void copyDartEmbedding(unsigned int orbit, Dart d, Dart e) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
191 192 193 194 195 196

	/**
	 * Allocation of some place in attrib table
	 * @param orbit the orbit of embedding
	 * @return the index to use as embedding
	 */
197
	unsigned int newCell(unsigned int orbit) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
198 199 200 201 202 203 204

	/**
	* Set the index of the associated cell to all the darts of an orbit
	* @param orbit orbit to embed
	* @param d a dart of the topological vertex
	* @param em index of attribute to store as embedding
	*/
205
	void embedOrbit(unsigned int orbit, Dart d, unsigned int em) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
206 207

	/**
untereiner's avatar
untereiner committed
208
	* Associate an new embedding to all darts of an orbit
Pierre Kraemer's avatar
Pierre Kraemer committed
209 210 211 212
	* @param orbit orbit to embed
	* @param d a dart of the topological cell
	* @return index of the attribute in table
	*/
213
	unsigned int embedNewCell(unsigned int orbit, Dart d) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
214 215

	/**
untereiner's avatar
untereiner committed
216
	 * Copy the cell associated to a dart over an other dart
Pierre Kraemer's avatar
Pierre Kraemer committed
217
	 * @param orbit attribute orbit to use
untereiner's avatar
untereiner committed
218 219
	 * @param d the dart to overwrite (dest)
	 * @param e the dart to copy (src)
Pierre Kraemer's avatar
Pierre Kraemer committed
220
	 */
221
	void copyCell(unsigned int orbit, Dart d, Dart e) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
222 223 224 225 226 227 228

	/**
	 * Line of attributes i is overwritten with line j
	 * @param orbit attribute orbit to use
	 * @param i line destination of copy
	 * @param j line source of copy
	 */
229
	void copyCell(unsigned int orbit, unsigned int i, unsigned int j) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
230 231 232 233 234 235

	/**
	 * Line of attributes i is initialized
	 * @param orbit attribute orbit to use
	 * @param i line to init
	 */
236
	void initCell(unsigned int orbit, unsigned int i) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
237 238 239 240 241 242

	/****************************************
	 *        ATTRIBUTES MANAGEMENT         *
	 ****************************************/

	/**
243 244
	 * get the attrib container of a given orbit
	 * @param orbit the orbit !!! (bilbo the orbit !)
Pierre Kraemer's avatar
Pierre Kraemer committed
245
	 */
246
	AttributeContainer& getAttributeContainer(unsigned int orbit) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
247 248

	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
249
	 * get a multi vector of mark attribute (direct access with [i])
Pierre Kraemer's avatar
Pierre Kraemer committed
250 251
	 * @param orbit code
	 */
252
	AttributeMultiVector<Mark>* getMarkVector(unsigned int orbit, unsigned int thread = 0) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
253 254

	/**
255 256
	 * return a pointer to the Dart attribute vector that store the embedding of the given orbit
	 * (may be NULL if the orbit is not embedded)
Pierre Kraemer's avatar
Pierre Kraemer committed
257
	 */
258
	AttributeMultiVector<unsigned int>* getEmbeddingAttributeVector(unsigned int orbit) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
259 260

	/**
261
	 * swap two attribute containers
Pierre Kraemer's avatar
Pierre Kraemer committed
262
	 */
263
	void swapEmbeddingContainers(unsigned int orbit1, unsigned int orbit2) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
264 265 266 267 268 269 270

	/**
	 * static function for type registration
	 */
	template <typename R>
	static bool registerAttribute(const std::string &nameType) ;

271 272 273 274
	/**
	 * Traverse the map and embed all orbits of the given dimension with a new cell
	 * @param realloc if true -> all the orbits are embedded on new cells, if false -> already embedded orbits are not impacted
	 */
275
	void initOrbitEmbedding(unsigned int orbit, bool realloc = false) ;
Sylvain Thery's avatar
Sylvain Thery committed
276 277

	/****************************************
278
	 *          THREAD MANAGEMENT           *
Sylvain Thery's avatar
Sylvain Thery committed
279 280 281 282 283 284 285
	 ****************************************/
public:
	/**
	 * add  threads (a table of Marker per orbit for each thread)
	 * to allow MT
	 * @param nb thread to add
	 */
286
	void addThreadMarker(unsigned int nb) ;
Sylvain Thery's avatar
Sylvain Thery committed
287 288 289 290 291

	/**
	 * return allowed threads
	 * @return the number of threads (including principal)
	 */
292
	unsigned int getNbThreadMarkers() ;
Sylvain Thery's avatar
Sylvain Thery committed
293 294

	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
295
	 * Remove some added threads
Sylvain Thery's avatar
Sylvain Thery committed
296 297
	 * @return remaining number of threads (including principal)
	 */
298
	void removeThreadMarker(unsigned int nb) ;
Sylvain Thery's avatar
Sylvain Thery committed
299

Pierre Kraemer's avatar
Pierre Kraemer committed
300 301 302 303 304 305 306 307 308 309
	/****************************************
	 *             SAVE & LOAD              *
	 ****************************************/
public:
	/**
	 * check if an xml node has a given name
	 * @param node the xml node
	 * @param name the name
	 * @ return true if node has the good name
	 */
310
	bool chechXmlNode(xmlNodePtr node, const std::string& name) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
311 312 313 314 315 316 317 318 319 320 321

	/**
	 * update the pointer of embedding vector after loading
	 */
	void update_m_emb_afterLoad();

	/**
	 * Save map in a XML file
	 * @param filename the file name
	 * @return true if OK
	 */
322
	bool saveMapXml(const std::string& filename, bool compress = false) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
323 324 325 326 327 328

	 /**
	 * Load map from a XML file
	 * @param filename the file name
	 * @return true if OK
	 */
329
	bool loadMapXml(const std::string& filename, bool compress = false) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
330 331 332 333 334 335

	/**
	 * Save map in a binary file
	 * @param filename the file name
	 * @return true if OK
	 */
336
	bool saveMapBin(const std::string& filename) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
337 338 339 340 341 342

	/**
	 * Load map from a binary file
	 * @param filename the file name
	 * @return true if OK
	 */
343
	bool loadMapBin(const std::string& filename) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
344 345 346 347 348 349 350 351 352

	/****************************************
	 *           DARTS TRAVERSALS           *
	 ****************************************/

	/**
	 * Begin of map
	 * @return the first dart of the map
	 */
353
	Dart begin() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
354 355 356 357 358

	/**
	 * End of map
	 * @return the end iterator (next of last) of the map
	 */
359
	Dart end() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
360 361 362 363 364 365

	/**
	 * allow to go from a dart to the next
	 * in the order of storage
	 * @param d reference to the dart to be modified
	 */
366
	void next(Dart& d) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
367 368 369 370 371

	/**
	 * Apply a functor on each dart of the map
	 * @param f a ref to the functor obj
	 */
372
	bool foreach_dart(FunctorType& f, const FunctorSelect& good = SelectorTrue()) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
373 374 375 376 377 378

	//! Apply a functor on every dart of an orbit
	/*! @param dim dimension of orbit
	 *  @param d a dart of the orbit
	 *  @param f a functor obj
	 */
379
	bool foreach_dart_of_orbit(unsigned int orbit, Dart d, FunctorType& f, unsigned int thread = 0) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
380

381 382 383 384 385 386
	virtual bool foreach_dart_of_vertex(Dart d, FunctorType& f, unsigned int thread = 0) = 0 ;
	virtual bool foreach_dart_of_edge(Dart d, FunctorType& f, unsigned int thread = 0) = 0 ;
	virtual bool foreach_dart_of_oriented_face(Dart d, FunctorType& f, unsigned int thread = 0) = 0 ;
	virtual bool foreach_dart_of_face(Dart d, FunctorType& f, unsigned int thread = 0) = 0 ;
	virtual bool foreach_dart_of_volume(Dart d, FunctorType& f, unsigned int thread = 0) = 0 ;
	virtual bool foreach_dart_of_cc(Dart d, FunctorType& f, unsigned int thread = 0) = 0 ;
Pierre Kraemer's avatar
Pierre Kraemer committed
387 388 389 390 391 392 393

	/**
	* execute functor for each orbit
	* @param dim the dimension of the orbit
	* @param f the functor
	* @param good the selector of darts
	*/
394
	bool foreach_orbit(unsigned int orbit, FunctorType& f, const FunctorSelect& good = SelectorTrue(), unsigned int thread = 0) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
395 396 397 398 399 400

	//! Count the number of orbits of dimension dim in the map
	/*! @param dim the dimension of the orbit
	 *	@param good the selector of darts
	 * 	@return the number of orbits
	 */
401
	unsigned int getNbOrbits(unsigned int orbit, const FunctorSelect& good = SelectorTrue()) ;
Sylvain Thery's avatar
Sylvain Thery committed
402 403 404 405 406

	/**
	 * print attributes name of map in std::cout (for debugging)
	 */
	void viewAttributesTables();
407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440

protected:
	/// boundary marker
	Mark m_boundaryMarker;

	/**
	 * mark a dart as  belonging to boundary
	 */
	void boundaryMark(Dart d);

	/**
	 * unmark a dart from the boundary
	 */
	void boundaryUnmark(Dart d);

	/**
	 * test if a dart belong to the boundary
	 */
	bool isBoundaryMarked(Dart d);

	/**
	 * mark an orbit of dart as belonging to boundary
	 */
	void boundaryMarkOrbit(unsigned int orbit, Dart d);

	/**
	 * unmark an orbit of dart from the boundary
	 */
	void boundaryUnmarkOrbit(unsigned int orbit, Dart d);

	/**
	 * clear all boundary markers
	 */
	void boundaryUnmarkAll();
Sylvain Thery's avatar
Sylvain Thery committed
441

Pierre Kraemer's avatar
Pierre Kraemer committed
442 443
} ;

444 445

template <typename MAP>
Pierre Kraemer's avatar
merge..  
Pierre Kraemer committed
446
bool foreach_dart_of_orbit_in_parent(MAP* ptrMap, unsigned int orbit, Dart d, FunctorType& f, unsigned int thread = 0)
447 448 449
{
	switch(orbit)
	{
450
		case  DART: return f(d);
451 452 453 454 455 456
		case  VERTEX: return ptrMap->MAP::ParentMap::foreach_dart_of_vertex(d, f, thread) ;
		case  EDGE: return ptrMap->MAP::ParentMap::foreach_dart_of_edge(d, f, thread) ;
		case  ORIENTED_FACE: return ptrMap->MAP::ParentMap::foreach_dart_of_oriented_face(d, f, thread) ;
		case  FACE: return ptrMap->MAP::ParentMap::foreach_dart_of_face(d, f, thread) ;
		case  VOLUME: return ptrMap->MAP::ParentMap::foreach_dart_of_volume(d, f, thread) ;
		default: assert(!"Cells of this dimension are not handled") ;
457
	}
458
	return false ;
459 460 461
}

template <typename MAP>
Pierre Kraemer's avatar
merge..  
Pierre Kraemer committed
462
bool foreach_dart_of_orbit_in_parent2(MAP* ptrMap, unsigned int orbit, Dart d, FunctorType& f, unsigned int thread = 0)
463 464 465
{
	switch(orbit)
	{
466
		case  DART: return f(d);
467 468 469 470 471 472
		case  VERTEX: return ptrMap->MAP::ParentMap::ParentMap::foreach_dart_of_vertex(d, f,thread) ;
		case  EDGE: return ptrMap->MAP::ParentMap::ParentMap::foreach_dart_of_edge(d, f, thread) ;
		case  ORIENTED_FACE: return ptrMap->MAP::ParentMap::ParentMap::foreach_dart_of_oriented_face(d, f, thread) ;
		case  FACE: return ptrMap->MAP::ParentMap::ParentMap::foreach_dart_of_face(d, f, thread) ;
		case  VOLUME: return ptrMap->MAP::ParentMap::ParentMap::foreach_dart_of_volume(d, f, thread) ;
		default: assert(!"Cells of this dimension are not handled") ;
473
	}
474
	return false ;
475 476
}

Pierre Kraemer's avatar
Pierre Kraemer committed
477 478 479 480 481
} //namespace CGoGN

#include "Topology/generic/genericmap.hpp"

#endif