genericmap.h 26.5 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"
Sylvain Thery's avatar
Sylvain Thery committed
39
#include "Container/fakeAttribute.h"
Pierre Kraemer's avatar
Pierre Kraemer committed
40

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

Sylvain Thery's avatar
Sylvain Thery committed
45 46


Pierre Kraemer's avatar
Pierre Kraemer committed
47 48 49 50 51 52 53 54 55
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)
 */
56 57 58 59 60 61 62
//class MapBrowser
//{
//public:
//	virtual Dart begin() const = 0;
//	virtual Dart end() const = 0;
//	virtual void next(Dart& d) const = 0;
//};
Pierre Kraemer's avatar
Pierre Kraemer committed
63

64
class AttributeHandlerGen ;
65 66
class DartMarkerGen ;
class CellMarkerGen ;
67
template<unsigned int CELL> class CellMarkerBase ;
68

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

protected:
82 83

	/**
84
	 * @brief current MapBrowser used to traverse the map
85
	 */
86
//	MapBrowser* m_currentBrowser;
87

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

93
	static std::map<std::string, RegisteredBaseAttribute*>* m_attributes_registry_map ;
94 95
	static int m_nbInstances;

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

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

Sylvain Thery's avatar
Sylvain Thery committed
108 109 110 111
	AttributeMultiVector<NoTypeNameAttribute<std::vector<Dart> > >* m_quickLocalIncidentTraversal[NB_ORBITS][NB_ORBITS] ;

	AttributeMultiVector<NoTypeNameAttribute<std::vector<Dart> > >* m_quickLocalAdjacentTraversal[NB_ORBITS][NB_ORBITS] ;

Pierre Kraemer's avatar
Pierre Kraemer committed
112
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
113
	 * Marks manager
Pierre Kraemer's avatar
Pierre Kraemer committed
114
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
115
	MarkSet m_marksets[NB_ORBITS][NB_THREAD] ;
Pierre Kraemer's avatar
Pierre Kraemer committed
116 117 118 119

	/**
	 * Direct access to the attributes that store Marks
	 */
Sylvain Thery's avatar
Sylvain Thery committed
120

121 122 123
	AttributeMultiVector<Mark>* m_markTables[NB_ORBITS][NB_THREAD] ;

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

125 126 127
	/**
	 * Store links to created AttributeHandlers, DartMarkers and CellMarkers
	 */
128
	std::multimap<AttributeMultiVectorGen*, AttributeHandlerGen*> attributeHandlers ; // TODO think of MT (AttributeHandler creation & release are not thread safe!)
129 130
	boost::mutex attributeHandlersMutex;

131 132 133
	std::vector<DartMarkerGen*> dartMarkers[NB_THREAD] ;
	std::vector<CellMarkerGen*> cellMarkers[NB_THREAD] ;

134 135 136 137
	/**
	 * is map a multiresolution map
	 */
#ifndef CGoGN_FORCE_MR
Pierre Kraemer's avatar
Pierre Kraemer committed
138
	static const bool m_isMultiRes = false ;
139 140
#else
	static const bool m_isMultiRes = true ;
141 142
#endif

143
	/**
144
	 * container for multiresolution darts
145
	 */
146 147
	AttributeContainer m_mrattribs ;

148
	/**
149
	 * pointers to attributes of m_mrattribs that store indices in m_attribs[DART] (one for each level)
150
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
151
	std::vector< AttributeMultiVector<unsigned int>* > m_mrDarts ;
152 153

	/**
154
	 * pointer to attribute of m_mrattribs that stores darts insertion levels
155
	 */
156
	AttributeMultiVector<unsigned int>* m_mrLevels ;
157

Pierre Kraemer's avatar
Pierre Kraemer committed
158 159 160 161 162
	/**
	 * vector that stores the number of darts inserted on each resolution level
	 */
	std::vector<unsigned int> m_mrNbDarts ;

163
	/**
164
	 * current level in multiresolution map
165
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
166
	unsigned int m_mrCurrentLevel ;
167

168 169 170
	/**
	 * stack for current level temporary storage
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
171
	std::vector<unsigned int> m_mrLevelStack ;
172

Pierre Kraemer's avatar
Pierre Kraemer committed
173
public:
174
	static const unsigned int UNKNOWN_ATTRIB = AttributeContainer::UNKNOWN ;
Pierre Kraemer's avatar
Pierre Kraemer committed
175

176
	GenericMap() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
177

178
	~GenericMap() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
179

180
	virtual std::string mapTypeName() const = 0 ;
181

182 183
	virtual unsigned int dimension() const = 0 ;

184
//	static const unsigned int DIMENSION = 0 ;
185 186 187 188 189 190 191
	/**
	 * 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
192

Sylvain Thery's avatar
Sylvain Thery committed
193 194 195
	/**
	 * get the marker_set of an orbit and thread (used for Cell & Dart Marker)
	 */
196 197
	template <unsigned int ORBIT>
	MarkSet& getMarkerSet(unsigned int thread = 0) { return m_marksets[ORBIT][thread]; }
Sylvain Thery's avatar
Sylvain Thery committed
198

199 200 201 202 203
//	/**
//	 * @brief set the current MapBrowser
//	 * @param mb pointer on MapBrowser to use (default is map itself)
//	 */
//	void setBrowser(MapBrowser* mb) { m_currentBrowser = mb; }
204

Pierre Kraemer's avatar
Pierre Kraemer committed
205
	/****************************************
Pierre Kraemer's avatar
Pierre Kraemer committed
206
	 *     RESOLUTION LEVELS MANAGEMENT     *
Pierre Kraemer's avatar
Pierre Kraemer committed
207 208
	 ****************************************/

Pierre Kraemer's avatar
Pierre Kraemer committed
209 210 211 212 213 214 215
	void printMR() ;

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

216
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
217
	 * get the current resolution level (use only in MRMaps)
218
	 */
219 220
	unsigned int getCurrentLevel() ;

221
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
222
	 * set the current resolution level (use only in MRMaps)
223
	 */
224 225
	void setCurrentLevel(unsigned int l) ;

Pierre Kraemer's avatar
Pierre Kraemer committed
226 227 228 229 230 231 232 233 234 235
	/**
	 * increment the current resolution level (use only in MRMaps)
	 */
	void incCurrentLevel() ;

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

236
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
237
	 * store current resolution level on a stack (use only in MRMaps)
238
	 */
239 240
	void pushLevel() ;

241
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
242
	 * set as current the resolution level of the top of the stack (use only in MRMaps)
243
	 */
244 245
	void popLevel() ;

246
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
247
	 * get the maximum resolution level (use only in MRMaps)
248
	 */
249 250
	unsigned int getMaxLevel() ;

251 252 253 254 255
//private:
//	/*
//	 * add a resolution level
//	 */
//	AttributeMultiVector<unsigned int>* addLevel();
untereiner's avatar
untereiner committed
256

257
	/**
untereiner's avatar
untereiner committed
258
	 * add a resolution level in the back of the level table (use only in MRMaps)
259
	 */
untereiner's avatar
untereiner committed
260
	void addLevelBack() ;
261

262 263 264
	/**
	 * add a resolution level in the front of the level table (use only in MRMaps)
	 */
untereiner's avatar
untereiner committed
265
	void addLevelFront();
266

Pierre Kraemer's avatar
Pierre Kraemer committed
267
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
268
	 * remove last resolution level (use only in MRMaps)
Pierre Kraemer's avatar
Pierre Kraemer committed
269
	 */
untereiner's avatar
untereiner committed
270
	void removeLevelBack() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
271

272 273 274
	/**
	 * remove first resolution level (use only in MRMaps)
	 */
untereiner's avatar
untereiner committed
275 276 277 278 279 280 281 282 283 284
	void removeLevelFront();

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

	/**
	 * duplicate darts from level-1 to level
	 */
285
	void duplicateDarts(unsigned int newlevel);
untereiner's avatar
untereiner committed
286 287

	/**
288
	 * duplicate a dart starting from current level
untereiner's avatar
untereiner committed
289
	 */
290
	void duplicateDart(Dart d) ;
291

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

Pierre Kraemer's avatar
Pierre Kraemer committed
294 295 296 297 298 299 300
	/****************************************
	 *           DARTS MANAGEMENT           *
	 ****************************************/
protected:
	/**
	 * Add a dart to the map
	 */
301
	virtual Dart newDart() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
302 303 304 305

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

308 309 310
	/**
	 * 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
311
	unsigned int copyDartLine(unsigned int index) ;
312

Pierre Kraemer's avatar
Pierre Kraemer committed
313 314
	/**
	 * Properly deletes a dart in m_attribs[DART]
Pierre Kraemer's avatar
Pierre Kraemer committed
315 316 317
	 */
	void deleteDartLine(unsigned int index) ;

Pierre Kraemer's avatar
Pierre Kraemer committed
318
public:
319 320 321
	/**
	 * get the index of dart in topological table
	 */
Sylvain Thery's avatar
Sylvain Thery committed
322
	unsigned int dartIndex(Dart d) const;
323

324 325 326 327 328 329 330 331 332 333
	/**
	 * get the Dart of index in topological table
	 */
	Dart indexDart(unsigned int index) const;

	/**
	 * @brief are we in MR ?
	 */
	static bool isMultiRes() { return m_isMultiRes; }

Pierre Kraemer's avatar
Pierre Kraemer committed
334
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
335
	 * get the insertion level of a dart (use only in MRMaps)
Pierre Kraemer's avatar
Pierre Kraemer committed
336
	 */
337
	unsigned int getDartLevel(Dart d) const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
338

339 340 341 342 343
	/**
	 *
	 */
	void incDartLevel(Dart d) const ;

Pierre Kraemer's avatar
Pierre Kraemer committed
344 345 346 347 348 349 350 351 352
	/**
	 * 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
353 354 355 356

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

Pierre Kraemer's avatar
Pierre Kraemer committed
359 360 361 362 363
	/**
	 * return true if the dart d refers to a valid index
	 */
	bool isDartValid(Dart d) ;

Pierre Kraemer's avatar
Pierre Kraemer committed
364 365 366 367 368 369 370
	/****************************************
	 *         EMBEDDING MANAGEMENT         *
	 ****************************************/

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

374
	bool isOrbitEmbedded(unsigned int orbit) const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
375 376 377 378 379

	/**
	 * 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
	 */
380
	template<unsigned int ORBIT>
Sylvain Thery's avatar
Sylvain Thery committed
381
	unsigned int getEmbedding(Dart d) const;
Pierre Kraemer's avatar
Pierre Kraemer committed
382 383 384 385

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

389 390 391 392 393 394 395
	/**
	 * 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
396 397 398
	/**
	 * 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
399 400
	 * @param dest the dart to overwrite
	 * @param src the dart to copy
Pierre Kraemer's avatar
Pierre Kraemer committed
401
	 */
402 403
	template <unsigned int ORBIT>
	void copyDartEmbedding(Dart dest, Dart src) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
404 405 406 407 408 409

	/**
	 * Allocation of some place in attrib table
	 * @param orbit the orbit of embedding
	 * @return the index to use as embedding
	 */
410 411
	template <unsigned int ORBIT>
	unsigned int newCell() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
412 413 414 415 416 417 418

	/**
	* 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
	*/
419
	template <unsigned int ORBIT>
420 421 422 423 424 425 426 427
	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
428 429

	/**
430
	* Associate an new cell to all darts of an orbit
Pierre Kraemer's avatar
Pierre Kraemer committed
431 432 433 434
	* @param orbit orbit to embed
	* @param d a dart of the topological cell
	* @return index of the attribute in table
	*/
435
	template <unsigned int ORBIT>
436
	unsigned int setOrbitEmbeddingOnNewCell(Dart d) ;
437 438 439 440 441 442 443

	/**
	 * 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
444 445

	/**
untereiner's avatar
untereiner committed
446
	 * Copy the cell associated to a dart over an other dart
Pierre Kraemer's avatar
Pierre Kraemer committed
447
	 * @param orbit attribute orbit to use
untereiner's avatar
untereiner committed
448 449
	 * @param d the dart to overwrite (dest)
	 * @param e the dart to copy (src)
Pierre Kraemer's avatar
Pierre Kraemer committed
450
	 */
451 452
	template <unsigned int ORBIT>
	void copyCell(Dart d, Dart e) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
453 454 455 456 457 458 459

	/**
	 * 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
	 */
460 461
	template <unsigned int ORBIT>
	void copyCell(unsigned int i, unsigned int j) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
462 463 464 465 466 467

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

471 472 473 474 475 476 477 478
	/**
	 * 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
479 480 481 482 483 484 485 486
	/****************************************
	 *     QUICK TRAVERSAL MANAGEMENT       *
	 ****************************************/

	template <unsigned int ORBIT>
	void enableQuickTraversal() ;

	template <unsigned int ORBIT>
487
	void updateQuickTraversal() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
488 489

	template <unsigned int ORBIT>
Sylvain Thery's avatar
Sylvain Thery committed
490
	const AttributeMultiVector<Dart>* getQuickTraversal() const;
Pierre Kraemer's avatar
Pierre Kraemer committed
491 492 493 494

	template <unsigned int ORBIT>
	void disableQuickTraversal() ;

Sylvain Thery's avatar
Sylvain Thery committed
495 496

	template <typename MAP, unsigned int ORBIT, unsigned int INCI>
Sylvain Thery's avatar
Sylvain Thery committed
497
	void enableQuickIncidentTraversal();
Sylvain Thery's avatar
Sylvain Thery committed
498 499

	template <typename MAP, unsigned int ORBIT, unsigned int INCI>
Sylvain Thery's avatar
Sylvain Thery committed
500
	void updateQuickIncidentTraversal();
Sylvain Thery's avatar
Sylvain Thery committed
501 502

	template <unsigned int ORBIT, unsigned int INCI>
Sylvain Thery's avatar
Sylvain Thery committed
503
	const AttributeMultiVector<NoTypeNameAttribute<std::vector<Dart> > >* getQuickIncidentTraversal() const;
Sylvain Thery's avatar
Sylvain Thery committed
504 505

	template <unsigned int ORBIT, unsigned int INCI>
Sylvain Thery's avatar
Sylvain Thery committed
506
	void disableQuickIncidentTraversal();
Sylvain Thery's avatar
Sylvain Thery committed
507 508

	template <typename MAP, unsigned int ORBIT, unsigned int ADJ>
Sylvain Thery's avatar
Sylvain Thery committed
509
	void enableQuickAdjacentTraversal();
Sylvain Thery's avatar
Sylvain Thery committed
510 511

	template <typename MAP, unsigned int ORBIT, unsigned int ADJ>
Sylvain Thery's avatar
Sylvain Thery committed
512
	void updateQuickAdjacentTraversal();
Sylvain Thery's avatar
Sylvain Thery committed
513 514

	template <unsigned int ORBIT, unsigned int INCI>
Sylvain Thery's avatar
Sylvain Thery committed
515
	const AttributeMultiVector<NoTypeNameAttribute<std::vector<Dart> > >* getQuickAdjacentTraversal() const;
Sylvain Thery's avatar
Sylvain Thery committed
516 517

	template <unsigned int ORBIT, unsigned int ADJ>
Sylvain Thery's avatar
Sylvain Thery committed
518
	void disableQuickAdjacentTraversal();
Sylvain Thery's avatar
Sylvain Thery committed
519

Pierre Kraemer's avatar
Pierre Kraemer committed
520 521 522 523
	/****************************************
	 *        ATTRIBUTES MANAGEMENT         *
	 ****************************************/

524 525 526 527 528 529
	/**
	 * 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
530
	/**
531 532
	 * get the attrib container of a given orbit
	 * @param orbit the orbit !!! (bilbo the orbit !)
Pierre Kraemer's avatar
Pierre Kraemer committed
533
	 */
534 535
	template <unsigned int ORBIT>
	AttributeContainer& getAttributeContainer() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
536

Sylvain Thery's avatar
Sylvain Thery committed
537 538 539
	template <unsigned int ORBIT>
	const AttributeContainer& getAttributeContainer() const;

Pierre Kraemer's avatar
Pierre Kraemer committed
540 541
	AttributeContainer& getAttributeContainer(unsigned int orbit) ;

Sylvain Thery's avatar
Sylvain Thery committed
542 543
	const AttributeContainer& getAttributeContainer(unsigned int orbit) const;

Pierre Kraemer's avatar
Pierre Kraemer committed
544
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
545
	 * get a multi vector of mark attribute (direct access with [i])
Pierre Kraemer's avatar
Pierre Kraemer committed
546
	 */
547 548
	template <unsigned int ORBIT>
	AttributeMultiVector<Mark>* getMarkVector(unsigned int thread = 0) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
549 550

	/**
551 552
	 * 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
553
	 */
554 555
	template <unsigned int ORBIT>
	AttributeMultiVector<unsigned int>* getEmbeddingAttributeVector() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
556

557 558 559 560 561 562 563 564 565 566
	/**
	 * get the MR attribute container
	 */
	AttributeContainer& getMRAttributeContainer() ;

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

untereiner's avatar
untereiner committed
567 568
	AttributeMultiVector<unsigned int>* getMRLevelAttributeVector();

untereiner's avatar
untereiner committed
569 570 571 572
	/**
	 * swap two attribute containers
	 */
	void swapEmbeddingContainers(unsigned int orbit1, unsigned int orbit2) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
573 574 575 576 577 578 579

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

Pierre Kraemer's avatar
Pierre Kraemer committed
580 581 582 583 584
	/**
	 * print attributes name of map in std::cout (for debugging)
	 */
	void viewAttributesTables() ;

585 586
	void printDartsTable();

Sylvain Thery's avatar
Sylvain Thery committed
587 588 589 590 591 592 593
protected:
	/****************************************
	 *   EMBEDDING ATTRIBUTES MANAGEMENT    *
	 ****************************************/
	/**
	 * Create the dart attribute to store the embedding of this orbit (for internal use only)
	 */
594 595
	template <unsigned int ORBIT>
	void addEmbedding() ;
Sylvain Thery's avatar
Sylvain Thery committed
596 597 598 599 600 601

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

	/**
602
	 * Add a topological relation in the map
Sylvain Thery's avatar
Sylvain Thery committed
603 604 605 606
	 * @param name name of relation
	 */
	AttributeMultiVector<Dart>* addRelation(const std::string& name) ;

Sylvain Thery's avatar
Sylvain Thery committed
607
	/**
Pierre Kraemer's avatar
merges  
Pierre Kraemer committed
608 609
	 * Get AttributeMultivector pointer of a relation attribute
	 * @param name name of the relation
Sylvain Thery's avatar
Sylvain Thery committed
610 611
	 * @return the attribute multi-vector pointer
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
612
	AttributeMultiVector<Dart>* getRelation(const std::string& name) ;
Sylvain Thery's avatar
Sylvain Thery committed
613

Sylvain Thery's avatar
Sylvain Thery committed
614
	/****************************************
615
	 *          THREAD MANAGEMENT           *
Sylvain Thery's avatar
Sylvain Thery committed
616 617 618 619 620 621 622
	 ****************************************/
public:
	/**
	 * add  threads (a table of Marker per orbit for each thread)
	 * to allow MT
	 * @param nb thread to add
	 */
623
	void addThreadMarker(unsigned int nb) ;
Sylvain Thery's avatar
Sylvain Thery committed
624 625 626 627 628

	/**
	 * return allowed threads
	 * @return the number of threads (including principal)
	 */
629
	unsigned int getNbThreadMarkers() ;
Sylvain Thery's avatar
Sylvain Thery committed
630 631

	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
632
	 * Remove some added threads
Sylvain Thery's avatar
Sylvain Thery committed
633 634
	 * @return remaining number of threads (including principal)
	 */
635
	void removeThreadMarker(unsigned int nb) ;
Sylvain Thery's avatar
Sylvain Thery committed
636

Pierre Kraemer's avatar
Pierre Kraemer committed
637 638 639 640 641 642 643 644 645 646
	/****************************************
	 *             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
647
//	bool chechXmlNode(xmlNodePtr node, const std::string& name) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
648 649 650 651 652 653

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

Sylvain Thery's avatar
Sylvain Thery committed
654 655 656 657 658
	/**
	 * update the markTables and recursively from real type the topo shortcut pointers
	 */
	virtual void update_topo_shortcuts();

Pierre Kraemer's avatar
Pierre Kraemer committed
659 660 661 662 663
	/**
	 * Save map in a XML file
	 * @param filename the file name
	 * @return true if OK
	 */
Sylvain Thery's avatar
Sylvain Thery committed
664
//	bool saveMapXml(const std::string& filename, bool compress = false) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
665 666 667 668 669 670

	 /**
	 * Load map from a XML file
	 * @param filename the file name
	 * @return true if OK
	 */
Sylvain Thery's avatar
Sylvain Thery committed
671
//	bool loadMapXml(const std::string& filename, bool compress = false) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
672 673 674 675 676 677

	/**
	 * Save map in a binary file
	 * @param filename the file name
	 * @return true if OK
	 */
Sylvain Thery's avatar
Sylvain Thery committed
678
	bool saveMapBin(const std::string& filename) const;
Pierre Kraemer's avatar
Pierre Kraemer committed
679 680 681 682 683 684

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

687 688 689
	/**
	 * copy from another map (of same type)
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
690
	bool copyFrom(const GenericMap& map) ;
691

Sylvain Thery's avatar
Sylvain Thery committed
692 693 694
	/**
	 * Dump attributes types and names per orbit
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
695
	void dumpAttributesAndMarkers() ;
Sylvain Thery's avatar
Sylvain Thery committed
696

697 698 699
	/**
	 * update topo relation after compacting the container:
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
700
	virtual void compactTopoRelations(const std::vector<unsigned int>& oldnew) = 0 ;
701 702 703 704

	/**
	 * compact the map
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
705
	void compact() ;
706

Pierre Kraemer's avatar
Pierre Kraemer committed
707 708 709 710
	/****************************************
	 *           DARTS TRAVERSALS           *
	 ****************************************/

711
//	Dart realBegin() const;
712

713
//	Dart realEnd() const;
714

715
//	void realNext(Dart& d) const;
716 717


Pierre Kraemer's avatar
Pierre Kraemer committed
718 719 720 721
	/**
	 * Begin of map
	 * @return the first dart of the map
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
722
	Dart begin() const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
723 724 725 726 727

	/**
	 * End of map
	 * @return the end iterator (next of last) of the map
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
728
	Dart end() const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
729 730 731 732 733 734

	/**
	 * allow to go from a dart to the next
	 * in the order of storage
	 * @param d reference to the dart to be modified
	 */
735
	void  next(Dart& d) const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
736 737 738 739 740

	/**
	 * Apply a functor on each dart of the map
	 * @param f a ref to the functor obj
	 */
741
	bool foreach_dart(FunctorType& f) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
742 743 744 745 746 747

	//! 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
	 */
Sylvain Thery's avatar
Sylvain Thery committed
748 749
//	template <unsigned int ORBIT>
//	bool foreach_dart_of_orbit(Dart d, FunctorType& f, unsigned int thread = 0) ;
750
	template <unsigned int ORBIT>
Sylvain Thery's avatar
Sylvain Thery committed
751 752 753 754 755 756 757 758
	bool foreach_dart_of_orbit(Dart d, FunctorType& f, unsigned int thread = 0) const;


	virtual bool foreach_dart_of_vertex(Dart d, FunctorType& f, unsigned int thread = 0) const = 0 ;
	virtual bool foreach_dart_of_edge(Dart d, FunctorType& f, unsigned int thread = 0) const = 0 ;
	virtual bool foreach_dart_of_face(Dart /*d*/, FunctorType& /*f*/, unsigned int /*thread = 0*/) const { std::cerr << "Not implemented" << std::endl; return false; }
	virtual bool foreach_dart_of_volume(Dart /*d*/, FunctorType& /*f*/, unsigned /*int thread = 0*/) const { std::cerr << "Not implemented" << std::endl; return false; }
	virtual bool foreach_dart_of_cc(Dart /*d*/, FunctorType& /*f*/, unsigned int /*thread = 0*/) const { std::cerr << "Not implemented" << std::endl; return false; }
Pierre Kraemer's avatar
Pierre Kraemer committed
759

Sylvain Thery's avatar
Sylvain Thery committed
760 761
	virtual bool foreach_dart_of_vertex1(Dart /*d*/, FunctorType& /*f*/, unsigned int /*thread = 0*/) const { std::cerr << "Not implemented" << std::endl; return false; }
	virtual bool foreach_dart_of_edge1(Dart /*d*/, FunctorType& /*f*/, unsigned int /*thread = 0*/) const { std::cerr << "Not implemented" << std::endl; return false; }
762

Sylvain Thery's avatar
Sylvain Thery committed
763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779
	virtual bool foreach_dart_of_vertex2(Dart /*d*/, FunctorType& /*f*/, unsigned int /*thread = 0*/) const { std::cerr << "Not implemented" << std::endl; return false; }
	virtual bool foreach_dart_of_edge2(Dart /*d*/, FunctorType& /*f*/, unsigned int /*thread = 0*/) const { std::cerr << "Not implemented" << std::endl; return false; }
	virtual bool foreach_dart_of_face2(Dart /*d*/, FunctorType& /*f*/, unsigned int /*thread = 0*/) const { std::cerr << "Not implemented" << std::endl; return false; }


//	virtual bool foreach_dart_of_vertex(Dart d, FunctorConstType& f, unsigned int thread = 0) const = 0 ;
//	virtual bool foreach_dart_of_edge(Dart d, FunctorConstType& f, unsigned int thread = 0) const = 0 ;
//	virtual bool foreach_dart_of_face(Dart /*d*/, FunctorConstType& /*f*/, unsigned int /*thread = 0*/) const { std::cerr << "Not implemented" << std::endl; return false; }
//	virtual bool foreach_dart_of_volume(Dart /*d*/, FunctorConstType& /*f*/, unsigned /*int thread = 0*/) const { std::cerr << "Not implemented" << std::endl; return false; }
//	virtual bool foreach_dart_of_cc(Dart /*d*/, FunctorConstType& /*f*/, unsigned int /*thread = 0*/) const { std::cerr << "Not implemented" << std::endl; return false; }

//	virtual bool foreach_dart_of_vertex1(Dart /*d*/, FunctorConstType& /*f*/, unsigned int /*thread = 0*/) const { std::cerr << "Not implemented" << std::endl; return false; }
//	virtual bool foreach_dart_of_edge1(Dart /*d*/, FunctorConstType& /*f*/, unsigned int /*thread = 0*/) const { std::cerr << "Not implemented" << std::endl; return false; }

//	virtual bool foreach_dart_of_vertex2(Dart /*d*/, FunctorConstType& /*f*/, unsigned int /*thread = 0*/) const { std::cerr << "Not implemented" << std::endl; return false; }
//	virtual bool foreach_dart_of_edge2(Dart /*d*/, FunctorConstType& /*f*/, unsigned int /*thread = 0*/) const { std::cerr << "Not implemented" << std::endl; return false; }
//	virtual bool foreach_dart_of_face2(Dart /*d*/, FunctorConstType& /*f*/, unsigned int /*thread = 0*/) const { std::cerr << "Not implemented" << std::endl; return false; }
780 781


Pierre Kraemer's avatar
Pierre Kraemer committed
782 783 784 785 786
	/**
	* execute functor for each orbit
	* @param dim the dimension of the orbit
	* @param f the functor
	*/
787
	template <unsigned int ORBIT>
Sylvain Thery's avatar
Sylvain Thery committed
788 789 790 791 792
	bool foreach_orbit(FunctorType& f, unsigned int thread = 0) const;

//	template <unsigned int ORBIT>
//	bool foreach_orbit(FunctorConstType& f, unsigned int thread = 0) const;

Pierre Kraemer's avatar
Pierre Kraemer committed
793 794 795 796 797

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

801 802 803
	//! For an orbit of a given dimension, return the number of incident cells of an other given dimension
	/*! @param d a dart
	 */
804
	template <typename MAP, unsigned int ORBIT, unsigned int INCIDENT>
Sylvain Thery's avatar
Sylvain Thery committed
805
	unsigned int degree(Dart d) const;
806

807
protected:
Thery Sylvain's avatar
Thery Sylvain committed
808 809 810 811
	/// boundary markers
//	Mark m_boundaryMarker2 ;
//	Mark m_boundaryMarker3 ;
	Mark m_boundaryMarkers[2] ; // 0 for dim 2 / 1 for dim 3
812 813 814 815

	/**
	 * mark a dart as  belonging to boundary
	 */
Thery Sylvain's avatar
Thery Sylvain committed
816
	template <unsigned int D>
Pierre Kraemer's avatar
Pierre Kraemer committed
817
	void boundaryMark(Dart d) ;
Thery Sylvain's avatar
Thery Sylvain committed
818 819
	void boundaryMark2(Dart d) ;
	void boundaryMark3(Dart d) ;
820 821 822 823

	/**
	 * unmark a dart from the boundary
	 */
Thery Sylvain's avatar
Thery Sylvain committed
824
	template <unsigned int D>
Pierre Kraemer's avatar
Pierre Kraemer committed
825
	void boundaryUnmark(Dart d) ;
Thery Sylvain's avatar
Thery Sylvain committed
826 827
	void boundaryUnmark2(Dart d) ;
	void boundaryUnmark3(Dart d) ;
828

Pierre Kraemer's avatar
Pierre Kraemer committed
829
public:
830 831 832
	/**
	 * test if a dart belong to the boundary
	 */
Thery Sylvain's avatar
Thery Sylvain committed
833
	template <unsigned int D>
Pierre Kraemer's avatar
Pierre Kraemer committed
834
	bool isBoundaryMarked(Dart d) const ;
835

Thery Sylvain's avatar
Thery Sylvain committed
836 837
	bool isBoundaryMarked2(Dart d) const ;
	bool isBoundaryMarked3(Dart d) const ;
838
	bool isBoundaryMarkedCurrent(Dart d) const ;
Thery Sylvain's avatar
Thery Sylvain committed
839

Pierre Kraemer's avatar
Pierre Kraemer committed
840
protected:
841 842 843
	/**
	 * mark an orbit of dart as belonging to boundary
	 */
Thery Sylvain's avatar
Thery Sylvain committed
844
	template <unsigned int ORBIT, unsigned int DIM>
845
	void boundaryMarkOrbit(Dart d) ;
846 847 848 849

	/**
	 * unmark an orbit of dart from the boundary
	 */
Thery Sylvain's avatar
Thery Sylvain committed
850
	template <unsigned int ORBIT, unsigned int DIM>
851
	void boundaryUnmarkOrbit(Dart d) ;
852 853 854 855

	/**
	 * clear all boundary markers
	 */
Thery Sylvain's avatar
Thery Sylvain committed
856
	template<unsigned int DIM>
Pierre Kraemer's avatar
Pierre Kraemer committed
857
	void boundaryUnmarkAll() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
858 859
} ;

860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891
//
//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 ;
//}
892

Pierre Kraemer's avatar
Pierre Kraemer committed
893 894 895 896 897
} //namespace CGoGN

#include "Topology/generic/genericmap.hpp"

#endif