genericmap.h 26.2 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"
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
namespace CGoGN
{

50
class AttributeHandlerGen ;
51 52
class DartMarkerGen ;
class CellMarkerGen ;
53
template<unsigned int CELL> class CellMarkerBase ;
54

55
class GenericMap
Pierre Kraemer's avatar
Pierre Kraemer committed
56
{
57
	template<typename T, unsigned int ORBIT> friend class AttributeHandler ;
58 59 60 61 62
	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 ;
63
	friend class DartMarkerGen ;
Sylvain Thery's avatar
Sylvain Thery committed
64
	friend class CellMarkerGen ;
65
	template<unsigned int CELL> friend class CellMarkerBase ;
Pierre Kraemer's avatar
Pierre Kraemer committed
66 67

protected:
68

Pierre Kraemer's avatar
Pierre Kraemer committed
69 70 71
	/**
	 * Attributes Containers
	 */
72
	AttributeContainer m_attribs[NB_ORBITS] ;
Pierre Kraemer's avatar
Pierre Kraemer committed
73

74
	static std::map<std::string, RegisteredBaseAttribute*>* m_attributes_registry_map ;
75 76
	static int m_nbInstances;

Pierre Kraemer's avatar
Pierre Kraemer committed
77 78
	/**
	 * Direct access to the Dart attributes that store the orbits embeddings
79
	 * (only initialized when necessary, i.e. addEmbedding function)
Pierre Kraemer's avatar
Pierre Kraemer committed
80
	 */
81
	AttributeMultiVector<unsigned int>* m_embeddings[NB_ORBITS] ;
Pierre Kraemer's avatar
Pierre Kraemer committed
82

Pierre Kraemer's avatar
Pierre Kraemer committed
83 84 85 86 87 88
	/**
	 * Direct access to quick traversal attributes
	 * (initialized by enableQuickTraversal function)
	 */
	AttributeMultiVector<Dart>* m_quickTraversal[NB_ORBITS] ;

Sylvain Thery's avatar
Sylvain Thery committed
89 90 91 92
	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
93
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
94
	 * Marks manager
Pierre Kraemer's avatar
Pierre Kraemer committed
95
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
96
	MarkSet m_marksets[NB_ORBITS][NB_THREAD] ;
Pierre Kraemer's avatar
Pierre Kraemer committed
97 98 99 100

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

102 103 104
	AttributeMultiVector<Mark>* m_markTables[NB_ORBITS][NB_THREAD] ;

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

106 107 108
	/**
	 * Store links to created AttributeHandlers, DartMarkers and CellMarkers
	 */
109
	std::multimap<AttributeMultiVectorGen*, AttributeHandlerGen*> attributeHandlers ; // TODO think of MT (AttributeHandler creation & release are not thread safe!)
110 111
	boost::mutex attributeHandlersMutex;

112 113 114
	std::vector<DartMarkerGen*> dartMarkers[NB_THREAD] ;
	std::vector<CellMarkerGen*> cellMarkers[NB_THREAD] ;

115 116 117 118
	/**
	 * is map a multiresolution map
	 */
#ifndef CGoGN_FORCE_MR
Pierre Kraemer's avatar
Pierre Kraemer committed
119
	static const bool m_isMultiRes = false ;
120 121
#else
	static const bool m_isMultiRes = true ;
122 123
#endif

124
	/**
125
	 * container for multiresolution darts
126
	 */
127 128
	AttributeContainer m_mrattribs ;

129
	/**
130
	 * pointers to attributes of m_mrattribs that store indices in m_attribs[DART] (one for each level)
131
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
132
	std::vector< AttributeMultiVector<unsigned int>* > m_mrDarts ;
133 134

	/**
135
	 * pointer to attribute of m_mrattribs that stores darts insertion levels
136
	 */
137
	AttributeMultiVector<unsigned int>* m_mrLevels ;
138

139 140 141 142 143
	/**
	 * vector that stores the number of darts inserted on each resolution level
	 */
	std::vector<unsigned int> m_mrNbDarts ;

144
	/**
145
	 * current level in multiresolution map
146
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
147
	unsigned int m_mrCurrentLevel ;
148

149 150 151
	/**
	 * stack for current level temporary storage
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
152
	std::vector<unsigned int> m_mrLevelStack ;
153

Pierre Kraemer's avatar
Pierre Kraemer committed
154
public:
155
	static const unsigned int UNKNOWN_ATTRIB = AttributeContainer::UNKNOWN ;
Pierre Kraemer's avatar
Pierre Kraemer committed
156

157
	GenericMap() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
158

Sylvain Thery's avatar
Sylvain Thery committed
159
	virtual ~GenericMap() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
160

161
	virtual std::string mapTypeName() const = 0 ;
162

163 164
	virtual unsigned int dimension() const = 0 ;

165 166 167 168 169 170 171
	/**
	 * 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
172

Sylvain Thery's avatar
Sylvain Thery committed
173 174 175
	/**
	 * get the marker_set of an orbit and thread (used for Cell & Dart Marker)
	 */
176 177
	template <unsigned int ORBIT>
	MarkSet& getMarkerSet(unsigned int thread = 0) { return m_marksets[ORBIT][thread]; }
Sylvain Thery's avatar
Sylvain Thery committed
178

Pierre Kraemer's avatar
Pierre Kraemer committed
179
	/****************************************
Pierre Kraemer's avatar
Pierre Kraemer committed
180
	 *     RESOLUTION LEVELS MANAGEMENT     *
Pierre Kraemer's avatar
Pierre Kraemer committed
181 182
	 ****************************************/

183 184 185 186 187 188 189
	void printMR() ;

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

190
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
191
	 * get the current resolution level (use only in MRMaps)
192
	 */
193 194
	unsigned int getCurrentLevel() ;

195
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
196
	 * set the current resolution level (use only in MRMaps)
197
	 */
198 199
	void setCurrentLevel(unsigned int l) ;

200 201 202 203 204 205 206 207 208 209
	/**
	 * increment the current resolution level (use only in MRMaps)
	 */
	void incCurrentLevel() ;

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

210
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
211
	 * store current resolution level on a stack (use only in MRMaps)
212
	 */
213 214
	void pushLevel() ;

215
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
216
	 * set as current the resolution level of the top of the stack (use only in MRMaps)
217
	 */
218 219
	void popLevel() ;

220
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
221
	 * get the maximum resolution level (use only in MRMaps)
222
	 */
223 224
	unsigned int getMaxLevel() ;

225 226 227 228 229
//private:
//	/*
//	 * add a resolution level
//	 */
//	AttributeMultiVector<unsigned int>* addLevel();
untereiner's avatar
untereiner committed
230

231
	/**
untereiner's avatar
untereiner committed
232
	 * add a resolution level in the back of the level table (use only in MRMaps)
233
	 */
untereiner's avatar
untereiner committed
234
	void addLevelBack() ;
235

236 237 238
	/**
	 * add a resolution level in the front of the level table (use only in MRMaps)
	 */
untereiner's avatar
untereiner committed
239
	void addLevelFront();
240

Pierre Kraemer's avatar
Pierre Kraemer committed
241
	/**
242
	 * remove last resolution level (use only in MRMaps)
Pierre Kraemer's avatar
Pierre Kraemer committed
243
	 */
untereiner's avatar
untereiner committed
244
	void removeLevelBack() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
245

246 247 248
	/**
	 * remove first resolution level (use only in MRMaps)
	 */
untereiner's avatar
untereiner committed
249 250 251 252 253 254 255 256 257 258
	void removeLevelFront();

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

	/**
	 * duplicate darts from level-1 to level
	 */
259
	void duplicateDarts(unsigned int newlevel);
untereiner's avatar
untereiner committed
260 261

	/**
262
	 * duplicate a dart starting from current level
untereiner's avatar
untereiner committed
263
	 */
264
	void duplicateDart(Dart d) ;
265

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

untereiner's avatar
untereiner committed
268 269 270 271 272 273 274 275 276 277 278 279 280 281

	void propagateDartRelation(Dart d, AttributeMultiVector<Dart>* rel) ;

	void propagateDartRelation(Dart d, Dart e, AttributeMultiVector<Dart>* rel);

	void propagateDartRelation(Dart d, Dart e, Dart f, AttributeMultiVector<Dart>* rel, AttributeMultiVector<Dart>* rel2);


	template <unsigned int ORBIT>
	void propagateDartEmbedding(Dart d) ;

	template <unsigned int ORBIT>
	void propagateOrbitEmbedding(Dart d) ;

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

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

296 297 298
	/**
	 * 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
299
	unsigned int copyDartLine(unsigned int index) ;
300

Pierre Kraemer's avatar
Pierre Kraemer committed
301 302
	/**
	 * Properly deletes a dart in m_attribs[DART]
303 304 305
	 */
	void deleteDartLine(unsigned int index) ;

Pierre Kraemer's avatar
Pierre Kraemer committed
306
public:
307 308 309
	/**
	 * get the index of dart in topological table
	 */
Sylvain Thery's avatar
Sylvain Thery committed
310
	unsigned int dartIndex(Dart d) const;
311

312 313 314 315 316 317 318 319 320 321
	/**
	 * 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
322
	/**
323
	 * get the insertion level of a dart (use only in MRMaps)
Pierre Kraemer's avatar
Pierre Kraemer committed
324
	 */
325
	unsigned int getDartLevel(Dart d) const ;
326

327 328 329 330 331
	/**
	 *
	 */
	void incDartLevel(Dart d) const ;

332 333 334 335 336 337 338 339 340
	/**
	 * 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
341 342 343 344

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

347 348 349 350 351
	/**
	 * return true if the dart d refers to a valid index
	 */
	bool isDartValid(Dart d) ;

Pierre Kraemer's avatar
Pierre Kraemer committed
352 353 354 355 356 357 358
	/****************************************
	 *         EMBEDDING MANAGEMENT         *
	 ****************************************/

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

362
	bool isOrbitEmbedded(unsigned int orbit) const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
363 364 365 366 367

	/**
	 * 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
	 */
368
	template<unsigned int ORBIT>
Sylvain Thery's avatar
Sylvain Thery committed
369
	unsigned int getEmbedding(Dart d) const;
Pierre Kraemer's avatar
Pierre Kraemer committed
370 371 372 373

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

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

	/**
	 * Allocation of some place in attrib table
	 * @param orbit the orbit of embedding
	 * @return the index to use as embedding
	 */
398 399
	template <unsigned int ORBIT>
	unsigned int newCell() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
400 401 402 403 404 405 406

	/**
	* 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
	*/
407
	template <unsigned int ORBIT>
408 409 410 411 412 413 414 415
	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
416 417

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

	/**
	 * 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
432 433

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

	/**
	 * 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
	 */
448 449
	template <unsigned int ORBIT>
	void copyCell(unsigned int i, unsigned int j) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
450 451 452 453 454 455

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

459 460 461 462 463 464 465 466
	/**
	 * 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
467 468 469 470 471 472 473 474
	/****************************************
	 *     QUICK TRAVERSAL MANAGEMENT       *
	 ****************************************/

	template <unsigned int ORBIT>
	void enableQuickTraversal() ;

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

	template <unsigned int ORBIT>
Sylvain Thery's avatar
Sylvain Thery committed
478
	const AttributeMultiVector<Dart>* getQuickTraversal() const;
Pierre Kraemer's avatar
Pierre Kraemer committed
479 480 481 482

	template <unsigned int ORBIT>
	void disableQuickTraversal() ;

Sylvain Thery's avatar
Sylvain Thery committed
483 484

	template <typename MAP, unsigned int ORBIT, unsigned int INCI>
Sylvain Thery's avatar
Sylvain Thery committed
485
	void enableQuickIncidentTraversal();
Sylvain Thery's avatar
Sylvain Thery committed
486 487

	template <typename MAP, unsigned int ORBIT, unsigned int INCI>
Sylvain Thery's avatar
Sylvain Thery committed
488
	void updateQuickIncidentTraversal();
Sylvain Thery's avatar
Sylvain Thery committed
489 490

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

	template <unsigned int ORBIT, unsigned int INCI>
Sylvain Thery's avatar
Sylvain Thery committed
494
	void disableQuickIncidentTraversal();
Sylvain Thery's avatar
Sylvain Thery committed
495 496

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

	template <typename MAP, unsigned int ORBIT, unsigned int ADJ>
Sylvain Thery's avatar
Sylvain Thery committed
500
	void updateQuickAdjacentTraversal();
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> > >* getQuickAdjacentTraversal() const;
Sylvain Thery's avatar
Sylvain Thery committed
504 505

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

Pierre Kraemer's avatar
Pierre Kraemer committed
508 509 510 511
	/****************************************
	 *        ATTRIBUTES MANAGEMENT         *
	 ****************************************/

512 513 514 515 516 517
	/**
	 * 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
518
	/**
519 520
	 * get the attrib container of a given orbit
	 * @param orbit the orbit !!! (bilbo the orbit !)
Pierre Kraemer's avatar
Pierre Kraemer committed
521
	 */
522 523
	template <unsigned int ORBIT>
	AttributeContainer& getAttributeContainer() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
524

Sylvain Thery's avatar
Sylvain Thery committed
525 526 527
	template <unsigned int ORBIT>
	const AttributeContainer& getAttributeContainer() const;

Pierre Kraemer's avatar
Pierre Kraemer committed
528 529
	AttributeContainer& getAttributeContainer(unsigned int orbit) ;

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

Pierre Kraemer's avatar
Pierre Kraemer committed
532
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
533
	 * get a multi vector of mark attribute (direct access with [i])
Pierre Kraemer's avatar
Pierre Kraemer committed
534
	 */
535 536
	template <unsigned int ORBIT>
	AttributeMultiVector<Mark>* getMarkVector(unsigned int thread = 0) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
537 538

	/**
539 540
	 * 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
541
	 */
542 543
	template <unsigned int ORBIT>
	AttributeMultiVector<unsigned int>* getEmbeddingAttributeVector() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
544

545 546 547 548 549 550 551 552 553 554
	/**
	 * get the MR attribute container
	 */
	AttributeContainer& getMRAttributeContainer() ;

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

untereiner's avatar
untereiner committed
555 556
	AttributeMultiVector<unsigned int>* getMRLevelAttributeVector();

untereiner's avatar
untereiner committed
557 558 559 560
	/**
	 * swap two attribute containers
	 */
	void swapEmbeddingContainers(unsigned int orbit1, unsigned int orbit2) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
561 562 563 564 565 566 567

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

568 569 570 571 572
	/**
	 * print attributes name of map in std::cout (for debugging)
	 */
	void viewAttributesTables() ;

573 574
	void printDartsTable();

Sylvain Thery's avatar
Sylvain Thery committed
575 576 577 578 579 580 581
protected:
	/****************************************
	 *   EMBEDDING ATTRIBUTES MANAGEMENT    *
	 ****************************************/
	/**
	 * Create the dart attribute to store the embedding of this orbit (for internal use only)
	 */
582 583
	template <unsigned int ORBIT>
	void addEmbedding() ;
Sylvain Thery's avatar
Sylvain Thery committed
584 585 586 587 588 589

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

	/**
590
	 * Add a topological relation in the map
Sylvain Thery's avatar
Sylvain Thery committed
591 592 593 594
	 * @param name name of relation
	 */
	AttributeMultiVector<Dart>* addRelation(const std::string& name) ;

Sylvain Thery's avatar
Sylvain Thery committed
595
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
596 597
	 * Get AttributeMultivector pointer of a relation attribute
	 * @param name name of the relation
Sylvain Thery's avatar
Sylvain Thery committed
598 599
	 * @return the attribute multi-vector pointer
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
600
	AttributeMultiVector<Dart>* getRelation(const std::string& name) ;
Sylvain Thery's avatar
Sylvain Thery committed
601

Sylvain Thery's avatar
Sylvain Thery committed
602
	/****************************************
603
	 *          THREAD MANAGEMENT           *
Sylvain Thery's avatar
Sylvain Thery committed
604 605 606 607 608 609 610
	 ****************************************/
public:
	/**
	 * add  threads (a table of Marker per orbit for each thread)
	 * to allow MT
	 * @param nb thread to add
	 */
611
	void addThreadMarker(unsigned int nb) ;
Sylvain Thery's avatar
Sylvain Thery committed
612 613 614 615 616

	/**
	 * return allowed threads
	 * @return the number of threads (including principal)
	 */
617
	unsigned int getNbThreadMarkers() ;
Sylvain Thery's avatar
Sylvain Thery committed
618 619

	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
620
	 * Remove some added threads
Sylvain Thery's avatar
Sylvain Thery committed
621 622
	 * @return remaining number of threads (including principal)
	 */
623
	void removeThreadMarker(unsigned int nb) ;
Sylvain Thery's avatar
Sylvain Thery committed
624

Pierre Kraemer's avatar
Pierre Kraemer committed
625 626 627 628 629 630 631 632 633 634
	/****************************************
	 *             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
635
//	bool chechXmlNode(xmlNodePtr node, const std::string& name) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
636 637 638 639 640 641

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

Sylvain Thery's avatar
Sylvain Thery committed
642 643 644 645 646
	/**
	 * update the markTables and recursively from real type the topo shortcut pointers
	 */
	virtual void update_topo_shortcuts();

Pierre Kraemer's avatar
Pierre Kraemer committed
647 648 649 650 651
	/**
	 * Save map in a XML file
	 * @param filename the file name
	 * @return true if OK
	 */
Sylvain Thery's avatar
Sylvain Thery committed
652
//	bool saveMapXml(const std::string& filename, bool compress = false) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
653 654 655 656 657 658

	 /**
	 * Load map from a XML file
	 * @param filename the file name
	 * @return true if OK
	 */
Sylvain Thery's avatar
Sylvain Thery committed
659
//	bool loadMapXml(const std::string& filename, bool compress = false) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
660 661 662 663 664 665

	/**
	 * Save map in a binary file
	 * @param filename the file name
	 * @return true if OK
	 */
Sylvain Thery's avatar
Sylvain Thery committed
666
	bool saveMapBin(const std::string& filename) const;
Pierre Kraemer's avatar
Pierre Kraemer committed
667 668 669 670 671 672

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

675 676 677
	/**
	 * copy from another map (of same type)
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
678
	bool copyFrom(const GenericMap& map) ;
679

Sylvain Thery's avatar
Sylvain Thery committed
680 681 682
	/**
	 * Dump attributes types and names per orbit
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
683
	void dumpAttributesAndMarkers() ;
Sylvain Thery's avatar
Sylvain Thery committed
684

685 686 687
	/**
	 * update topo relation after compacting the container:
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
688
	virtual void compactTopoRelations(const std::vector<unsigned int>& oldnew) = 0 ;
689 690 691 692

	/**
	 * compact the map
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
693
	void compact() ;
694

Pierre Kraemer's avatar
Pierre Kraemer committed
695 696 697 698 699 700 701 702
	/****************************************
	 *           DARTS TRAVERSALS           *
	 ****************************************/

	/**
	 * Begin of map
	 * @return the first dart of the map
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
703
	Dart begin() const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
704 705 706 707 708

	/**
	 * End of map
	 * @return the end iterator (next of last) of the map
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
709
	Dart end() const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
710 711 712 713 714 715

	/**
	 * allow to go from a dart to the next
	 * in the order of storage
	 * @param d reference to the dart to be modified
	 */
716
	void  next(Dart& d) const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
717 718 719 720 721

	/**
	 * Apply a functor on each dart of the map
	 * @param f a ref to the functor obj
	 */
722
	bool foreach_dart(FunctorType& f) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
723 724 725 726 727 728

	//! 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
729 730
//	template <unsigned int ORBIT>
//	bool foreach_dart_of_orbit(Dart d, FunctorType& f, unsigned int thread = 0) ;
731
	template <unsigned int ORBIT>
Sylvain Thery's avatar
Sylvain Thery committed
732 733 734 735 736 737 738 739
	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
740

Sylvain Thery's avatar
Sylvain Thery committed
741 742
	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; }
743

Sylvain Thery's avatar
Sylvain Thery committed
744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760
	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; }
761 762


Pierre Kraemer's avatar
Pierre Kraemer committed
763 764 765 766 767
	/**
	* execute functor for each orbit
	* @param dim the dimension of the orbit
	* @param f the functor
	*/
768
	template <unsigned int ORBIT>
Sylvain Thery's avatar
Sylvain Thery committed
769 770 771 772 773
	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
774 775 776 777 778

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

782 783 784
	//! For an orbit of a given dimension, return the number of incident cells of an other given dimension
	/*! @param d a dart
	 */
785
	template <typename MAP, unsigned int ORBIT, unsigned int INCIDENT>
Sylvain Thery's avatar
Sylvain Thery committed
786
	unsigned int degree(Dart d) const;
787

788
protected:
Thery Sylvain's avatar
Thery Sylvain committed
789 790
	/// boundary markers
	Mark m_boundaryMarkers[2] ; // 0 for dim 2 / 1 for dim 3
791 792 793 794

	/**
	 * mark a dart as  belonging to boundary
	 */
Thery Sylvain's avatar
Thery Sylvain committed
795
	template <unsigned int D>
Pierre Kraemer's avatar
Pierre Kraemer committed
796
	void boundaryMark(Dart d) ;
Thery Sylvain's avatar
Thery Sylvain committed
797 798
	void boundaryMark2(Dart d) ;
	void boundaryMark3(Dart d) ;
799 800 801 802

	/**
	 * unmark a dart from the boundary
	 */
Thery Sylvain's avatar
Thery Sylvain committed
803
	template <unsigned int D>
Pierre Kraemer's avatar
Pierre Kraemer committed
804
	void boundaryUnmark(Dart d) ;
Thery Sylvain's avatar
Thery Sylvain committed
805 806
	void boundaryUnmark2(Dart d) ;
	void boundaryUnmark3(Dart d) ;
807

Pierre Kraemer's avatar
Pierre Kraemer committed
808
public:
809 810 811
	/**
	 * test if a dart belong to the boundary
	 */
Thery Sylvain's avatar
Thery Sylvain committed
812
	template <unsigned int D>
Pierre Kraemer's avatar
Pierre Kraemer committed
813
	bool isBoundaryMarked(Dart d) const ;
814

Thery Sylvain's avatar
Thery Sylvain committed
815 816
	bool isBoundaryMarked2(Dart d) const ;
	bool isBoundaryMarked3(Dart d) const ;
817
	bool isBoundaryMarkedCurrent(Dart d) const ;
Thery Sylvain's avatar
Thery Sylvain committed
818

Pierre Kraemer's avatar
Pierre Kraemer committed
819
protected:
820 821 822
	/**
	 * mark an orbit of dart as belonging to boundary
	 */
Thery Sylvain's avatar
Thery Sylvain committed
823
	template <unsigned int ORBIT, unsigned int DIM>
824
	void boundaryMarkOrbit(Dart d) ;
825 826 827 828

	/**
	 * unmark an orbit of dart from the boundary
	 */
Thery Sylvain's avatar
Thery Sylvain committed
829
	template <unsigned int ORBIT, unsigned int DIM>
830
	void boundaryUnmarkOrbit(Dart d) ;
831 832 833 834

	/**
	 * clear all boundary markers
	 */
Thery Sylvain's avatar
Thery Sylvain committed
835
	template<unsigned int DIM>
Pierre Kraemer's avatar
Pierre Kraemer committed
836
	void boundaryUnmarkAll() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
837 838
} ;

839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870
//
//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 ;
//}
871

Pierre Kraemer's avatar
Pierre Kraemer committed
872 873 874 875 876
} //namespace CGoGN

#include "Topology/generic/genericmap.hpp"

#endif