genericmap.h 23 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-2012, 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.unistra.fr/                                           *
Pierre Kraemer's avatar
Pierre Kraemer committed
21 22 23 24 25 26 27 28
* Contact information: cgogn@unistra.fr                                        *
*                                                                              *
*******************************************************************************/

#ifndef __GENERIC_MAP__
#define __GENERIC_MAP__

#include <iostream>
Sylvain Thery's avatar
Sylvain Thery committed
29
#include <string>
Pierre Kraemer's avatar
Pierre Kraemer committed
30 31 32 33 34 35
#include <sstream>
#include <fstream>
#include <iomanip>
#include <list>
#include <vector>
#include <map>
36 37
#include <boost/thread/mutex.hpp>

38
#include "Container/attributeContainer.h"
Pierre Kraemer's avatar
Pierre Kraemer committed
39

Pierre Kraemer's avatar
Pierre Kraemer committed
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
#include "Topology/generic/dart.h"
#include "Topology/generic/marker.h"
#include "Topology/generic/functor.h"

namespace CGoGN
{

/**
 * Class that allows to browse a map
 * This is a pure virtual class that can be overloaded in:
 * - a MapBrowserSelector
 * - a MapBrowserLinked (Attr or Auto)
 */
class MapBrowser
{
public:
56 57 58
	virtual Dart begin() const = 0;
	virtual Dart end() const = 0;
	virtual void next(Dart& d) const = 0;
Pierre Kraemer's avatar
Pierre Kraemer committed
59 60
};

61
class AttributeHandlerGen ;
62 63
class DartMarkerGen ;
class CellMarkerGen ;
64
template<unsigned int CELL> class CellMarkerBase ;
65

66
class GenericMap
Pierre Kraemer's avatar
Pierre Kraemer committed
67
{
68
	template<typename T, unsigned int ORBIT> friend class AttributeHandler ;
69 70 71 72 73
	template<typename T> friend class DartAutoAttribute ;
	template<typename T> friend class VertexAutoAttribute ;
	template<typename T> friend class EdgeAutoAttribute ;
	template<typename T> friend class FaceAutoAttribute ;
	template<typename T> friend class VolumeAutoAttribute ;
74
	friend class DartMarkerGen ;
Sylvain Thery's avatar
Sylvain Thery committed
75
	friend class CellMarkerGen ;
76
	template<unsigned int CELL> friend class CellMarkerBase ;
Pierre Kraemer's avatar
Pierre Kraemer committed
77 78

protected:
79 80

	/**
81
	 * @brief current MapBrowser used to traverse the map
82 83 84
	 */
	MapBrowser* m_currentBrowser;

Pierre Kraemer's avatar
Pierre Kraemer committed
85 86 87
	/**
	 * Attributes Containers
	 */
88
	AttributeContainer m_attribs[NB_ORBITS] ;
Pierre Kraemer's avatar
Pierre Kraemer committed
89

90
	static std::map<std::string, RegisteredBaseAttribute*>* m_attributes_registry_map ;
91 92
	static int m_nbInstances;

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

Pierre Kraemer's avatar
Pierre Kraemer committed
99 100 101 102 103 104
	/**
	 * Direct access to quick traversal attributes
	 * (initialized by enableQuickTraversal function)
	 */
	AttributeMultiVector<Dart>* m_quickTraversal[NB_ORBITS] ;

Pierre Kraemer's avatar
Pierre Kraemer committed
105
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
106
	 * Marks manager
Pierre Kraemer's avatar
Pierre Kraemer committed
107
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
108
	MarkSet m_marksets[NB_ORBITS][NB_THREAD] ;
Pierre Kraemer's avatar
Pierre Kraemer committed
109 110 111 112

	/**
	 * Direct access to the attributes that store Marks
	 */
113 114 115
	AttributeMultiVector<Mark>* m_markTables[NB_ORBITS][NB_THREAD] ;

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

117 118 119
	/**
	 * Store links to created AttributeHandlers, DartMarkers and CellMarkers
	 */
120
	std::multimap<AttributeMultiVectorGen*, AttributeHandlerGen*> attributeHandlers ; // TODO think of MT (AttributeHandler creation & release are not thread safe!)
121 122
	boost::mutex attributeHandlersMutex;

123 124 125
	std::vector<DartMarkerGen*> dartMarkers[NB_THREAD] ;
	std::vector<CellMarkerGen*> cellMarkers[NB_THREAD] ;

126 127 128 129
	/**
	 * is map a multiresolution map
	 */
#ifndef CGoGN_FORCE_MR
Pierre Kraemer's avatar
Pierre Kraemer committed
130
	static const bool m_isMultiRes = false ;
131 132
#else
	static const bool m_isMultiRes = true ;
133 134
#endif

135
	/**
136
	 * container for multiresolution darts
137
	 */
138 139
	AttributeContainer m_mrattribs ;

140
	/**
141
	 * pointers to attributes of m_mrattribs that store indices in m_attribs[DART] (one for each level)
142
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
143
	std::vector< AttributeMultiVector<unsigned int>* > m_mrDarts ;
144 145

	/**
146
	 * pointer to attribute of m_mrattribs that stores darts insertion levels
147
	 */
148
	AttributeMultiVector<unsigned int>* m_mrLevels ;
149

Pierre Kraemer's avatar
Pierre Kraemer committed
150 151 152 153 154
	/**
	 * vector that stores the number of darts inserted on each resolution level
	 */
	std::vector<unsigned int> m_mrNbDarts ;

155
	/**
156
	 * current level in multiresolution map
157
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
158
	unsigned int m_mrCurrentLevel ;
159

160 161 162
	/**
	 * stack for current level temporary storage
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
163
	std::vector<unsigned int> m_mrLevelStack ;
164

Pierre Kraemer's avatar
Pierre Kraemer committed
165
public:
166
	static const unsigned int UNKNOWN_ATTRIB = AttributeContainer::UNKNOWN ;
Pierre Kraemer's avatar
Pierre Kraemer committed
167

168
	GenericMap() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
169

170
	~GenericMap() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
171

172
	virtual std::string mapTypeName() const = 0 ;
173

174 175
	virtual unsigned int dimension() const = 0 ;

176
//	static const unsigned int DIMENSION = 0 ;
177 178 179 180 181 182 183
	/**
	 * 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
184

Sylvain Thery's avatar
Sylvain Thery committed
185 186 187
	/**
	 * get the marker_set of an orbit and thread (used for Cell & Dart Marker)
	 */
188 189
	template <unsigned int ORBIT>
	MarkSet& getMarkerSet(unsigned int thread = 0) { return m_marksets[ORBIT][thread]; }
Sylvain Thery's avatar
Sylvain Thery committed
190

191 192
	/**
	 * @brief set the current MapBrowser
193
	 * @param mb pointer on MapBrowser to use (default is map itself)
194 195 196
	 */
	void setBrowser(MapBrowser* mb) { m_currentBrowser = mb; }

Pierre Kraemer's avatar
Pierre Kraemer committed
197
	/****************************************
Pierre Kraemer's avatar
Pierre Kraemer committed
198
	 *     RESOLUTION LEVELS MANAGEMENT     *
Pierre Kraemer's avatar
Pierre Kraemer committed
199 200
	 ****************************************/

Pierre Kraemer's avatar
Pierre Kraemer committed
201 202 203 204 205 206 207
	void printMR() ;

	/**
	 * initialize the multiresolution attribute container
	 */
	void initMR() ;

208
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
209
	 * get the current resolution level (use only in MRMaps)
210
	 */
211 212
	unsigned int getCurrentLevel() ;

213
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
214
	 * set the current resolution level (use only in MRMaps)
215
	 */
216 217
	void setCurrentLevel(unsigned int l) ;

Pierre Kraemer's avatar
Pierre Kraemer committed
218 219 220 221 222 223 224 225 226 227
	/**
	 * increment the current resolution level (use only in MRMaps)
	 */
	void incCurrentLevel() ;

	/**
	 * decrement the current resolution level (use only in MRMaps)
	 */
	void decCurrentLevel() ;

228
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
229
	 * store current resolution level on a stack (use only in MRMaps)
230
	 */
231 232
	void pushLevel() ;

233
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
234
	 * set as current the resolution level of the top of the stack (use only in MRMaps)
235
	 */
236 237
	void popLevel() ;

238
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
239
	 * get the maximum resolution level (use only in MRMaps)
240
	 */
241 242
	unsigned int getMaxLevel() ;

243 244 245 246 247
//private:
//	/*
//	 * add a resolution level
//	 */
//	AttributeMultiVector<unsigned int>* addLevel();
untereiner's avatar
untereiner committed
248

249
	/**
untereiner's avatar
untereiner committed
250
	 * add a resolution level in the back of the level table (use only in MRMaps)
251
	 */
untereiner's avatar
untereiner committed
252
	void addLevelBack() ;
253

254 255 256
	/**
	 * add a resolution level in the front of the level table (use only in MRMaps)
	 */
untereiner's avatar
untereiner committed
257
	void addLevelFront();
258

Pierre Kraemer's avatar
Pierre Kraemer committed
259
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
260
	 * remove last resolution level (use only in MRMaps)
Pierre Kraemer's avatar
Pierre Kraemer committed
261
	 */
untereiner's avatar
untereiner committed
262
	void removeLevelBack() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
263

264 265 266
	/**
	 * remove first resolution level (use only in MRMaps)
	 */
untereiner's avatar
untereiner committed
267 268 269 270 271 272 273 274 275 276 277 278 279
	void removeLevelFront();

	/**
	 * copy MRDarts from level-1 to level
	 */
	void copyLevel(unsigned int level);

	/**
	 * duplicate darts from level-1 to level
	 */
	void duplicateDarts(unsigned int level);

	/**
280
	 * duplicate a dart starting from current level
untereiner's avatar
untereiner committed
281
	 */
282
	void duplicateDart(Dart d) ;
283

untereiner's avatar
untereiner committed
284
	void duplicateDartAtOneLevel(Dart d, unsigned int level) ;
285

Pierre Kraemer's avatar
Pierre Kraemer committed
286 287 288 289 290 291 292
	/****************************************
	 *           DARTS MANAGEMENT           *
	 ****************************************/
protected:
	/**
	 * Add a dart to the map
	 */
293
	virtual Dart newDart() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
294 295 296 297

	/**
	 * Erase a dart of the map
	 */
298
	void deleteDart(Dart d) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
299

300 301 302
	/**
	 * create a copy of a dart (based on its index in m_attribs[DART]) and returns its index
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
303
	unsigned int copyDartLine(unsigned int index) ;
304

Pierre Kraemer's avatar
Pierre Kraemer committed
305 306
	/**
	 * Properly deletes a dart in m_attribs[DART]
Pierre Kraemer's avatar
Pierre Kraemer committed
307 308 309
	 */
	void deleteDartLine(unsigned int index) ;

Pierre Kraemer's avatar
Pierre Kraemer committed
310
public:
311 312 313
	/**
	 * get the index of dart in topological table
	 */
Sylvain Thery's avatar
Sylvain Thery committed
314
	unsigned int dartIndex(Dart d) const;
315

Pierre Kraemer's avatar
Pierre Kraemer committed
316
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
317
	 * get the insertion level of a dart (use only in MRMaps)
Pierre Kraemer's avatar
Pierre Kraemer committed
318
	 */
319
	unsigned int getDartLevel(Dart d) const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
320

321 322 323 324 325
	/**
	 *
	 */
	void incDartLevel(Dart d) const ;

Pierre Kraemer's avatar
Pierre Kraemer committed
326 327 328 329 330 331 332 333 334
	/**
	 * get the number of darts inserted in the given leveldart (use only in MRMaps)
	 */
	unsigned int getNbInsertedDarts(unsigned int level) ;

	/**
	 * get the number of darts that define the map of the given leveldart (use only in MRMaps)
	 */
	unsigned int getNbDarts(unsigned int level) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
335 336 337 338

	/**
	 * @return the number of darts in the map
	 */
339
	unsigned int getNbDarts() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
340

Pierre Kraemer's avatar
Pierre Kraemer committed
341 342 343 344 345
	/**
	 * return true if the dart d refers to a valid index
	 */
	bool isDartValid(Dart d) ;

Pierre Kraemer's avatar
Pierre Kraemer committed
346 347 348 349 350 351 352
	/****************************************
	 *         EMBEDDING MANAGEMENT         *
	 ****************************************/

	/**
	 * tell if an orbit is embedded or not
	 */
353 354
	template <unsigned int ORBIT>
	bool isOrbitEmbedded() const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
355

356
	bool isOrbitEmbedded(unsigned int orbit) const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
357 358 359 360 361

	/**
	 * get the cell index of the given dimension associated to dart d
	 * @return EMBNULL if the orbit of d is not attached to any cell
	 */
362 363
	template<unsigned int ORBIT>
	unsigned int getEmbedding(Dart d) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
364 365 366 367

	/**
	 * Set the cell index of the given dimension associated to dart d
	 */
368 369
	template <unsigned int ORBIT>
	void setDartEmbedding(Dart d, unsigned int emb) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
370

371 372 373 374 375 376 377
	/**
	 * Set the cell index of the given dimension associated to dart d
	 * !!! WARNING !!! use only on freshly inserted darts (no unref is done on old embedding) !!! WARNING !!!
	 */
	template <unsigned int ORBIT>
	void initDartEmbedding(Dart d, unsigned int emb) ;

Pierre Kraemer's avatar
Pierre Kraemer committed
378 379 380
	/**
	 * Copy the index of the cell associated to a dart over an other dart
	 * @param orbit the id of orbit embedding
Pierre Kraemer's avatar
Pierre Kraemer committed
381 382
	 * @param dest the dart to overwrite
	 * @param src the dart to copy
Pierre Kraemer's avatar
Pierre Kraemer committed
383
	 */
384 385
	template <unsigned int ORBIT>
	void copyDartEmbedding(Dart dest, Dart src) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
386 387 388 389 390 391

	/**
	 * Allocation of some place in attrib table
	 * @param orbit the orbit of embedding
	 * @return the index to use as embedding
	 */
392 393
	template <unsigned int ORBIT>
	unsigned int newCell() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
394 395 396 397 398 399 400

	/**
	* 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
	*/
401
	template <unsigned int ORBIT>
402 403 404 405 406 407 408 409
	void setOrbitEmbedding(Dart d, unsigned int em) ;

	/**
	 * Set the index of the associated cell to all the darts of an orbit
	 * !!! WARNING !!! use only on freshly inserted darts (no unref is done on old embedding)!!! WARNING !!!
	 */
	template <unsigned int ORBIT>
	void initOrbitEmbedding(Dart d, unsigned int em) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
410 411

	/**
412
	* Associate an new cell to all darts of an orbit
Pierre Kraemer's avatar
Pierre Kraemer committed
413 414 415 416
	* @param orbit orbit to embed
	* @param d a dart of the topological cell
	* @return index of the attribute in table
	*/
417
	template <unsigned int ORBIT>
418
	unsigned int setOrbitEmbeddingOnNewCell(Dart d) ;
419 420 421 422 423 424 425

	/**
	 * Associate an new cell to all darts of an orbit
	 * !!! WARNING !!! use only on freshly inserted darts (no unref is done on old embedding)!!! WARNING !!!
	 */
	template <unsigned int ORBIT>
	unsigned int initOrbitEmbeddingNewCell(Dart d) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
426 427

	/**
untereiner's avatar
untereiner committed
428
	 * Copy the cell associated to a dart over an other dart
Pierre Kraemer's avatar
Pierre Kraemer committed
429
	 * @param orbit attribute orbit to use
untereiner's avatar
untereiner committed
430 431
	 * @param d the dart to overwrite (dest)
	 * @param e the dart to copy (src)
Pierre Kraemer's avatar
Pierre Kraemer committed
432
	 */
433 434
	template <unsigned int ORBIT>
	void copyCell(Dart d, Dart e) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
435 436 437 438 439 440 441

	/**
	 * 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
	 */
442 443
	template <unsigned int ORBIT>
	void copyCell(unsigned int i, unsigned int j) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
444 445 446 447 448 449

	/**
	 * Line of attributes i is initialized
	 * @param orbit attribute orbit to use
	 * @param i line to init
	 */
450 451
	template <unsigned int ORBIT>
	void initCell(unsigned int i) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
452

453 454 455 456 457 458 459 460
	/**
	 * 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
	 */
	template <unsigned int ORBIT>
	void initAllOrbitsEmbedding(bool realloc = false) ;


Pierre Kraemer's avatar
Pierre Kraemer committed
461 462 463 464 465 466 467 468
	/****************************************
	 *     QUICK TRAVERSAL MANAGEMENT       *
	 ****************************************/

	template <unsigned int ORBIT>
	void enableQuickTraversal() ;

	template <unsigned int ORBIT>
469
	void updateQuickTraversal() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
470 471 472 473 474 475 476

	template <unsigned int ORBIT>
	AttributeMultiVector<Dart>* getQuickTraversal() ;

	template <unsigned int ORBIT>
	void disableQuickTraversal() ;

Pierre Kraemer's avatar
Pierre Kraemer committed
477 478 479 480
	/****************************************
	 *        ATTRIBUTES MANAGEMENT         *
	 ****************************************/

481 482 483 484 485 486
	/**
	 * get the number of cell in the attribute container of an orbit
	 * @param orb the orbit to get number of cells
	 */
	unsigned int getNbCells(unsigned int orbit);

Pierre Kraemer's avatar
Pierre Kraemer committed
487
	/**
488 489
	 * get the attrib container of a given orbit
	 * @param orbit the orbit !!! (bilbo the orbit !)
Pierre Kraemer's avatar
Pierre Kraemer committed
490
	 */
491 492
	template <unsigned int ORBIT>
	AttributeContainer& getAttributeContainer() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
493

Pierre Kraemer's avatar
Pierre Kraemer committed
494 495
	AttributeContainer& getAttributeContainer(unsigned int orbit) ;

Pierre Kraemer's avatar
Pierre Kraemer committed
496
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
497
	 * get a multi vector of mark attribute (direct access with [i])
Pierre Kraemer's avatar
Pierre Kraemer committed
498
	 */
499 500
	template <unsigned int ORBIT>
	AttributeMultiVector<Mark>* getMarkVector(unsigned int thread = 0) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
501 502

	/**
503 504
	 * 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
505
	 */
506 507
	template <unsigned int ORBIT>
	AttributeMultiVector<unsigned int>* getEmbeddingAttributeVector() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
508

509 510 511 512 513 514 515 516 517 518
	/**
	 * get the MR attribute container
	 */
	AttributeContainer& getMRAttributeContainer() ;

	/**
	 * get the MR attribute container
	 */
	AttributeMultiVector<unsigned int>* getMRDartAttributeVector(unsigned int level) ;

untereiner's avatar
untereiner committed
519 520
	AttributeMultiVector<unsigned int>* getMRLevelAttributeVector();

untereiner's avatar
untereiner committed
521 522 523 524
	/**
	 * swap two attribute containers
	 */
	void swapEmbeddingContainers(unsigned int orbit1, unsigned int orbit2) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
525 526 527 528 529 530 531

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

Pierre Kraemer's avatar
Pierre Kraemer committed
532 533 534 535 536
	/**
	 * print attributes name of map in std::cout (for debugging)
	 */
	void viewAttributesTables() ;

537 538
	void printDartsTable();

Sylvain Thery's avatar
Sylvain Thery committed
539 540 541 542 543 544 545
protected:
	/****************************************
	 *   EMBEDDING ATTRIBUTES MANAGEMENT    *
	 ****************************************/
	/**
	 * Create the dart attribute to store the embedding of this orbit (for internal use only)
	 */
546 547
	template <unsigned int ORBIT>
	void addEmbedding() ;
Sylvain Thery's avatar
Sylvain Thery committed
548 549 550 551 552 553

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

	/**
554
	 * Add a topological relation in the map
Sylvain Thery's avatar
Sylvain Thery committed
555 556 557 558
	 * @param name name of relation
	 */
	AttributeMultiVector<Dart>* addRelation(const std::string& name) ;

Sylvain Thery's avatar
Sylvain Thery committed
559
	/**
Pierre Kraemer's avatar
merges  
Pierre Kraemer committed
560 561
	 * Get AttributeMultivector pointer of a relation attribute
	 * @param name name of the relation
Sylvain Thery's avatar
Sylvain Thery committed
562 563
	 * @return the attribute multi-vector pointer
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
564
	AttributeMultiVector<Dart>* getRelation(const std::string& name) ;
Sylvain Thery's avatar
Sylvain Thery committed
565

Sylvain Thery's avatar
Sylvain Thery committed
566
	/****************************************
567
	 *          THREAD MANAGEMENT           *
Sylvain Thery's avatar
Sylvain Thery committed
568 569 570 571 572 573 574
	 ****************************************/
public:
	/**
	 * add  threads (a table of Marker per orbit for each thread)
	 * to allow MT
	 * @param nb thread to add
	 */
575
	void addThreadMarker(unsigned int nb) ;
Sylvain Thery's avatar
Sylvain Thery committed
576 577 578 579 580

	/**
	 * return allowed threads
	 * @return the number of threads (including principal)
	 */
581
	unsigned int getNbThreadMarkers() ;
Sylvain Thery's avatar
Sylvain Thery committed
582 583

	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
584
	 * Remove some added threads
Sylvain Thery's avatar
Sylvain Thery committed
585 586
	 * @return remaining number of threads (including principal)
	 */
587
	void removeThreadMarker(unsigned int nb) ;
Sylvain Thery's avatar
Sylvain Thery committed
588

Pierre Kraemer's avatar
Pierre Kraemer committed
589 590 591 592 593 594 595 596 597 598
	/****************************************
	 *             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
	 */
Sylvain Thery's avatar
Sylvain Thery committed
599
//	bool chechXmlNode(xmlNodePtr node, const std::string& name) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
600 601 602 603 604 605

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

Sylvain Thery's avatar
Sylvain Thery committed
606 607 608 609 610
	/**
	 * update the markTables and recursively from real type the topo shortcut pointers
	 */
	virtual void update_topo_shortcuts();

Pierre Kraemer's avatar
Pierre Kraemer committed
611 612 613 614 615
	/**
	 * Save map in a XML file
	 * @param filename the file name
	 * @return true if OK
	 */
Sylvain Thery's avatar
Sylvain Thery committed
616
//	bool saveMapXml(const std::string& filename, bool compress = false) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
617 618 619 620 621 622

	 /**
	 * Load map from a XML file
	 * @param filename the file name
	 * @return true if OK
	 */
Sylvain Thery's avatar
Sylvain Thery committed
623
//	bool loadMapXml(const std::string& filename, bool compress = false) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
624 625 626 627 628 629

	/**
	 * Save map in a binary file
	 * @param filename the file name
	 * @return true if OK
	 */
630
	bool saveMapBin(const std::string& filename) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
631 632 633 634 635 636

	/**
	 * Load map from a binary file
	 * @param filename the file name
	 * @return true if OK
	 */
637
	bool loadMapBin(const std::string& filename) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
638

639 640 641
	/**
	 * copy from another map (of same type)
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
642
	bool copyFrom(const GenericMap& map) ;
643

Sylvain Thery's avatar
Sylvain Thery committed
644 645 646
	/**
	 * Dump attributes types and names per orbit
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
647
	void dumpAttributesAndMarkers() ;
Sylvain Thery's avatar
Sylvain Thery committed
648

649 650 651
	/**
	 * update topo relation after compacting the container:
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
652
	virtual void compactTopoRelations(const std::vector<unsigned int>& oldnew) = 0 ;
653 654 655 656

	/**
	 * compact the map
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
657
	void compact() ;
658

Pierre Kraemer's avatar
Pierre Kraemer committed
659 660 661 662
	/****************************************
	 *           DARTS TRAVERSALS           *
	 ****************************************/

663 664 665 666 667 668 669
	Dart realBegin() const;

	Dart realEnd() const;

	void realNext(Dart& d) const;


Pierre Kraemer's avatar
Pierre Kraemer committed
670 671 672 673
	/**
	 * Begin of map
	 * @return the first dart of the map
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
674
	Dart begin() const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
675 676 677 678 679

	/**
	 * End of map
	 * @return the end iterator (next of last) of the map
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
680
	Dart end() const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
681 682 683 684 685 686

	/**
	 * allow to go from a dart to the next
	 * in the order of storage
	 * @param d reference to the dart to be modified
	 */
687
	void  next(Dart& d) const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
688 689 690 691 692

	/**
	 * Apply a functor on each dart of the map
	 * @param f a ref to the functor obj
	 */
693
	bool foreach_dart(FunctorType& f) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
694 695 696 697 698 699

	//! 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
	 */
700 701
	template <unsigned int ORBIT>
	bool foreach_dart_of_orbit(Dart d, FunctorType& f, unsigned int thread = 0) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
702

703 704
	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 ;
Pierre Kraemer's avatar
Pierre Kraemer committed
705 706 707
	virtual bool foreach_dart_of_face(Dart d, FunctorType& f, unsigned int thread = 0) { std::cerr << "Not implemented" << std::endl; return false; }
	virtual bool foreach_dart_of_volume(Dart d, FunctorType& f, unsigned int thread = 0) { std::cerr << "Not implemented" << std::endl; return false; }
	virtual bool foreach_dart_of_cc(Dart d, FunctorType& f, unsigned int thread = 0) { std::cerr << "Not implemented" << std::endl; return false; }
708

Pierre Kraemer's avatar
Pierre Kraemer committed
709 710
	virtual bool foreach_dart_of_vertex1(Dart d, FunctorType& f, unsigned int thread = 0) { std::cerr << "Not implemented" << std::endl; return false; }
	virtual bool foreach_dart_of_edge1(Dart d, FunctorType& f, unsigned int thread = 0) { std::cerr << "Not implemented" << std::endl; return false; }
711

Pierre Kraemer's avatar
Pierre Kraemer committed
712 713 714
	virtual bool foreach_dart_of_vertex2(Dart d, FunctorType& f, unsigned int thread = 0) { std::cerr << "Not implemented" << std::endl; return false; }
	virtual bool foreach_dart_of_edge2(Dart d, FunctorType& f, unsigned int thread = 0) { std::cerr << "Not implemented" << std::endl; return false; }
	virtual bool foreach_dart_of_face2(Dart d, FunctorType& f, unsigned int thread = 0) { std::cerr << "Not implemented" << std::endl; return false; }
715

Pierre Kraemer's avatar
Pierre Kraemer committed
716 717 718 719 720
	/**
	* execute functor for each orbit
	* @param dim the dimension of the orbit
	* @param f the functor
	*/
721
	template <unsigned int ORBIT>
722
	bool foreach_orbit(FunctorType& f, unsigned int thread = 0) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
723 724 725 726 727

	//! Count the number of orbits of dimension dim in the map
	/*! @param dim the dimension of the orbit
	 * 	@return the number of orbits
	 */
728
	template <unsigned int ORBIT>
729
	unsigned int getNbOrbits() ;
Sylvain Thery's avatar
Sylvain Thery committed
730

731 732 733
	//! For an orbit of a given dimension, return the number of incident cells of an other given dimension
	/*! @param d a dart
	 */
734
	template <typename MAP, unsigned int ORBIT, unsigned int INCIDENT>
735 736
	unsigned int degree(Dart d);

737
protected:
Thery Sylvain's avatar
Thery Sylvain committed
738 739 740 741
	/// boundary markers
//	Mark m_boundaryMarker2 ;
//	Mark m_boundaryMarker3 ;
	Mark m_boundaryMarkers[2] ; // 0 for dim 2 / 1 for dim 3
742 743 744 745

	/**
	 * mark a dart as  belonging to boundary
	 */
Thery Sylvain's avatar
Thery Sylvain committed
746
	template <unsigned int D>
Pierre Kraemer's avatar
Pierre Kraemer committed
747
	void boundaryMark(Dart d) ;
Thery Sylvain's avatar
Thery Sylvain committed
748 749
	void boundaryMark2(Dart d) ;
	void boundaryMark3(Dart d) ;
750 751 752 753

	/**
	 * unmark a dart from the boundary
	 */
Thery Sylvain's avatar
Thery Sylvain committed
754
	template <unsigned int D>
Pierre Kraemer's avatar
Pierre Kraemer committed
755
	void boundaryUnmark(Dart d) ;
Thery Sylvain's avatar
Thery Sylvain committed
756 757
	void boundaryUnmark2(Dart d) ;
	void boundaryUnmark3(Dart d) ;
758

Pierre Kraemer's avatar
Pierre Kraemer committed
759
public:
760 761 762
	/**
	 * test if a dart belong to the boundary
	 */
Thery Sylvain's avatar
Thery Sylvain committed
763
	template <unsigned int D>
Pierre Kraemer's avatar
Pierre Kraemer committed
764
	bool isBoundaryMarked(Dart d) const ;
765

Thery Sylvain's avatar
Thery Sylvain committed
766 767
	bool isBoundaryMarked2(Dart d) const ;
	bool isBoundaryMarked3(Dart d) const ;
768
	bool isBoundaryMarkedCurrent(Dart d) const ;
Thery Sylvain's avatar
Thery Sylvain committed
769

Pierre Kraemer's avatar
Pierre Kraemer committed
770
protected:
771 772 773
	/**
	 * mark an orbit of dart as belonging to boundary
	 */
Thery Sylvain's avatar
Thery Sylvain committed
774
	template <unsigned int ORBIT, unsigned int DIM>
775
	void boundaryMarkOrbit(Dart d) ;
776 777 778 779

	/**
	 * unmark an orbit of dart from the boundary
	 */
Thery Sylvain's avatar
Thery Sylvain committed
780
	template <unsigned int ORBIT, unsigned int DIM>
781
	void boundaryUnmarkOrbit(Dart d) ;
782 783 784 785

	/**
	 * clear all boundary markers
	 */
Thery Sylvain's avatar
Thery Sylvain committed
786
	template<unsigned int DIM>
Pierre Kraemer's avatar
Pierre Kraemer committed
787
	void boundaryUnmarkAll() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
788 789
} ;

790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821
//
//template <typename MAP>
//bool foreach_dart_of_orbit_in_parent(MAP* ptrMap, unsigned int orbit, Dart d, FunctorType& f, unsigned int thread = 0)
//{
//	switch(orbit)
//	{
//		case  DART: return f(d);
//		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") ;
//	}
//	return false ;
//}
//
//template <typename MAP>
//bool foreach_dart_of_orbit_in_parent2(MAP* ptrMap, unsigned int orbit, Dart d, FunctorType& f, unsigned int thread = 0)
//{
//	switch(orbit)
//	{
//		case  DART: return f(d);
//		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") ;
//	}
//	return false ;
//}
822

Pierre Kraemer's avatar
Pierre Kraemer committed
823 824 825 826 827
} //namespace CGoGN

#include "Topology/generic/genericmap.hpp"

#endif