genericmap.h 23.1 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 56
#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 map (generic and so on)
 * - a MapBrowserSelector
 * - a MapBrowserLinked (Attr or Auto)
 */
class MapBrowser
{
public:
57 58 59
	virtual Dart begin() const = 0;
	virtual Dart end() const = 0;
	virtual void next(Dart& d) const = 0;
Pierre Kraemer's avatar
Pierre Kraemer committed
60 61
};

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

67
class GenericMap// : public MapBrowser
Pierre Kraemer's avatar
Pierre Kraemer committed
68
{
69
	template<typename T, unsigned int ORBIT> friend class AttributeHandler ;
70 71 72 73 74
	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 ;
75
	friend class DartMarkerGen ;
Sylvain Thery's avatar
Sylvain Thery committed
76
	friend class CellMarkerGen ;
77
	template<unsigned int CELL> friend class CellMarkerBase ;
Pierre Kraemer's avatar
Pierre Kraemer committed
78 79

protected:
80 81 82 83 84 85

	/**
	 * @brief current MapBrowser use to traverse
	 */
	MapBrowser* m_currentBrowser;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

265 266 267
	/**
	 * remove first resolution level (use only in MRMaps)
	 */
untereiner's avatar
untereiner committed
268 269 270 271 272 273 274 275 276 277 278 279 280
	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);

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

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

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

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

301 302 303
	/**
	 * 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
304
	unsigned int copyDartLine(unsigned int index) ;
305

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

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

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

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

Pierre Kraemer's avatar
Pierre Kraemer committed
327 328 329 330 331 332 333 334 335
	/**
	 * 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
336 337 338 339

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

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

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

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

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

	/**
	 * 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
	 */
363 364
	template<unsigned int ORBIT>
	unsigned int getEmbedding(Dart d) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
365 366 367 368

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

372 373 374 375 376 377 378
	/**
	 * 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
379 380 381
	/**
	 * 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
382 383
	 * @param dest the dart to overwrite
	 * @param src the dart to copy
Pierre Kraemer's avatar
Pierre Kraemer committed
384
	 */
385 386
	template <unsigned int ORBIT>
	void copyDartEmbedding(Dart dest, Dart src) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
387 388 389 390 391 392

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

	/**
	* 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
	*/
402
	template <unsigned int ORBIT>
403 404 405 406 407 408 409 410
	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
411 412

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

	/**
	 * 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
427 428

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

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

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

454 455 456 457 458 459 460 461
	/**
	 * 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
462 463 464 465 466 467 468 469
	/****************************************
	 *     QUICK TRAVERSAL MANAGEMENT       *
	 ****************************************/

	template <unsigned int ORBIT>
	void enableQuickTraversal() ;

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

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

	template <unsigned int ORBIT>
	void disableQuickTraversal() ;

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

482 483 484 485 486 487
	/**
	 * 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
488
	/**
489 490
	 * get the attrib container of a given orbit
	 * @param orbit the orbit !!! (bilbo the orbit !)
Pierre Kraemer's avatar
Pierre Kraemer committed
491
	 */
492 493
	template <unsigned int ORBIT>
	AttributeContainer& getAttributeContainer() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
494

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

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

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

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

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

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

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

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

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

538 539
	void printDartsTable();

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	Dart realEnd() const;

	void realNext(Dart& d) const;


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

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

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

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

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

704 705
	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
706 707 708
	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; }
709

Pierre Kraemer's avatar
Pierre Kraemer committed
710 711
	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; }
712

Pierre Kraemer's avatar
Pierre Kraemer committed
713 714 715
	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; }
716

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

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

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

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

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

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

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

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

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

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

	/**
	 * clear all boundary markers
	 */
Thery Sylvain's avatar
Thery Sylvain committed
787
	template<unsigned int DIM>
Pierre Kraemer's avatar
Pierre Kraemer committed
788
	void boundaryUnmarkAll() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
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 822
//
//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 ;
//}
823

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

#include "Topology/generic/genericmap.hpp"

#endif