genericmap.h 24.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
	 */
120 121 122
	AttributeMultiVector<Mark>* m_markTables[NB_ORBITS][NB_THREAD] ;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

271 272 273
	/**
	 * remove first resolution level (use only in MRMaps)
	 */
untereiner's avatar
untereiner committed
274 275 276 277 278 279 280 281 282 283 284 285 286
	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);

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

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

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

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

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

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

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

323 324 325 326 327 328 329 330 331 332
	/**
	 * 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
333
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
334
	 * get the insertion level of a dart (use only in MRMaps)
Pierre Kraemer's avatar
Pierre Kraemer committed
335
	 */
336
	unsigned int getDartLevel(Dart d) const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
337

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	template <unsigned int ORBIT>
	void enableQuickTraversal() ;

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

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

	template <unsigned int ORBIT>
	void disableQuickTraversal() ;

Sylvain Thery's avatar
Sylvain Thery committed
494 495

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

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

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

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

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

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

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

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

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

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

Pierre Kraemer's avatar
Pierre Kraemer committed
536 537
	AttributeContainer& getAttributeContainer(unsigned int orbit) ;

Pierre Kraemer's avatar
Pierre Kraemer committed
538
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
539
	 * get a multi vector of mark attribute (direct access with [i])
Pierre Kraemer's avatar
Pierre Kraemer committed
540
	 */
541 542
	template <unsigned int ORBIT>
	AttributeMultiVector<Mark>* getMarkVector(unsigned int thread = 0) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
543 544

	/**
545 546
	 * 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
547
	 */
548 549
	template <unsigned int ORBIT>
	AttributeMultiVector<unsigned int>* getEmbeddingAttributeVector() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
550

551 552 553 554 555 556 557 558 559 560
	/**
	 * get the MR attribute container
	 */
	AttributeContainer& getMRAttributeContainer() ;

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

untereiner's avatar
untereiner committed
561 562
	AttributeMultiVector<unsigned int>* getMRLevelAttributeVector();

untereiner's avatar
untereiner committed
563 564 565 566
	/**
	 * swap two attribute containers
	 */
	void swapEmbeddingContainers(unsigned int orbit1, unsigned int orbit2) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
567 568 569 570 571 572 573

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

Pierre Kraemer's avatar
Pierre Kraemer committed
574 575 576 577 578
	/**
	 * print attributes name of map in std::cout (for debugging)
	 */
	void viewAttributesTables() ;

579 580
	void printDartsTable();

Sylvain Thery's avatar
Sylvain Thery committed
581 582 583 584 585 586 587
protected:
	/****************************************
	 *   EMBEDDING ATTRIBUTES MANAGEMENT    *
	 ****************************************/
	/**
	 * Create the dart attribute to store the embedding of this orbit (for internal use only)
	 */
588 589
	template <unsigned int ORBIT>
	void addEmbedding() ;
Sylvain Thery's avatar
Sylvain Thery committed
590 591 592 593 594 595

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

	/**
596
	 * Add a topological relation in the map
Sylvain Thery's avatar
Sylvain Thery committed
597 598 599 600
	 * @param name name of relation
	 */
	AttributeMultiVector<Dart>* addRelation(const std::string& name) ;

Sylvain Thery's avatar
Sylvain Thery committed
601
	/**
Pierre Kraemer's avatar
merges  
Pierre Kraemer committed
602 603
	 * Get AttributeMultivector pointer of a relation attribute
	 * @param name name of the relation
Sylvain Thery's avatar
Sylvain Thery committed
604 605
	 * @return the attribute multi-vector pointer
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
606
	AttributeMultiVector<Dart>* getRelation(const std::string& name) ;
Sylvain Thery's avatar
Sylvain Thery committed
607

Sylvain Thery's avatar
Sylvain Thery committed
608
	/****************************************
609
	 *          THREAD MANAGEMENT           *
Sylvain Thery's avatar
Sylvain Thery committed
610 611 612 613 614 615 616
	 ****************************************/
public:
	/**
	 * add  threads (a table of Marker per orbit for each thread)
	 * to allow MT
	 * @param nb thread to add
	 */
617
	void addThreadMarker(unsigned int nb) ;
Sylvain Thery's avatar
Sylvain Thery committed
618 619 620 621 622

	/**
	 * return allowed threads
	 * @return the number of threads (including principal)
	 */
623
	unsigned int getNbThreadMarkers() ;
Sylvain Thery's avatar
Sylvain Thery committed
624 625

	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
626
	 * Remove some added threads
Sylvain Thery's avatar
Sylvain Thery committed
627 628
	 * @return remaining number of threads (including principal)
	 */
629
	void removeThreadMarker(unsigned int nb) ;
Sylvain Thery's avatar
Sylvain Thery committed
630

Pierre Kraemer's avatar
Pierre Kraemer committed
631 632 633 634 635 636 637 638 639 640
	/****************************************
	 *             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
641
//	bool chechXmlNode(xmlNodePtr node, const std::string& name) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
642 643 644 645 646 647

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

Sylvain Thery's avatar
Sylvain Thery committed
648 649 650 651 652
	/**
	 * update the markTables and recursively from real type the topo shortcut pointers
	 */
	virtual void update_topo_shortcuts();

Pierre Kraemer's avatar
Pierre Kraemer committed
653 654 655 656 657
	/**
	 * Save map in a XML file
	 * @param filename the file name
	 * @return true if OK
	 */
Sylvain Thery's avatar
Sylvain Thery committed
658
//	bool saveMapXml(const std::string& filename, bool compress = false) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
659 660 661 662 663 664

	 /**
	 * Load map from a XML file
	 * @param filename the file name
	 * @return true if OK
	 */
Sylvain Thery's avatar
Sylvain Thery committed
665
//	bool loadMapXml(const std::string& filename, bool compress = false) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
666 667 668 669 670 671

	/**
	 * Save map in a binary file
	 * @param filename the file name
	 * @return true if OK
	 */
672
	bool saveMapBin(const std::string& filename) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
673 674 675 676 677 678

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

681 682 683
	/**
	 * copy from another map (of same type)
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
684
	bool copyFrom(const GenericMap& map) ;
685

Sylvain Thery's avatar
Sylvain Thery committed
686 687 688
	/**
	 * Dump attributes types and names per orbit
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
689
	void dumpAttributesAndMarkers() ;
Sylvain Thery's avatar
Sylvain Thery committed
690

691 692 693
	/**
	 * update topo relation after compacting the container:
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
694
	virtual void compactTopoRelations(const std::vector<unsigned int>& oldnew) = 0 ;
695 696 697 698

	/**
	 * compact the map
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
699
	void compact() ;
700

Pierre Kraemer's avatar
Pierre Kraemer committed
701 702 703 704
	/****************************************
	 *           DARTS TRAVERSALS           *
	 ****************************************/

705
//	Dart realBegin() const;
706

707
//	Dart realEnd() const;
708

709
//	void realNext(Dart& d) const;
710 711


Pierre Kraemer's avatar
Pierre Kraemer committed
712 713 714 715
	/**
	 * Begin of map
	 * @return the first dart of the map
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
716
	Dart begin() const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
717 718 719 720 721

	/**
	 * End of map
	 * @return the end iterator (next of last) of the map
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
722
	Dart end() const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
723 724 725 726 727 728

	/**
	 * allow to go from a dart to the next
	 * in the order of storage
	 * @param d reference to the dart to be modified
	 */
729
	void  next(Dart& d) const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
730 731 732 733 734

	/**
	 * Apply a functor on each dart of the map
	 * @param f a ref to the functor obj
	 */
735
	bool foreach_dart(FunctorType& f) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
736 737 738 739 740 741

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

745 746
	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 ;
747 748 749
	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; }
750

751 752
	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; }
753

754 755 756
	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; }
757

Pierre Kraemer's avatar
Pierre Kraemer committed
758 759 760 761 762
	/**
	* execute functor for each orbit
	* @param dim the dimension of the orbit
	* @param f the functor
	*/
763
	template <unsigned int ORBIT>
764
	bool foreach_orbit(FunctorType& f, unsigned int thread = 0) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
765 766 767 768 769

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

773 774 775
	//! For an orbit of a given dimension, return the number of incident cells of an other given dimension
	/*! @param d a dart
	 */
776
	template <typename MAP, unsigned int ORBIT, unsigned int INCIDENT>
777 778
	unsigned int degree(Dart d);

779
protected:
Thery Sylvain's avatar
Thery Sylvain committed
780 781 782 783
	/// boundary markers
//	Mark m_boundaryMarker2 ;
//	Mark m_boundaryMarker3 ;
	Mark m_boundaryMarkers[2] ; // 0 for dim 2 / 1 for dim 3
784 785 786 787

	/**
	 * mark a dart as  belonging to boundary
	 */
Thery Sylvain's avatar
Thery Sylvain committed
788
	template <unsigned int D>
Pierre Kraemer's avatar
Pierre Kraemer committed
789
	void boundaryMark(Dart d) ;
Thery Sylvain's avatar
Thery Sylvain committed
790 791
	void boundaryMark2(Dart d) ;
	void boundaryMark3(Dart d) ;
792 793 794 795

	/**
	 * unmark a dart from the boundary
	 */
Thery Sylvain's avatar
Thery Sylvain committed
796
	template <unsigned int D>
Pierre Kraemer's avatar
Pierre Kraemer committed
797
	void boundaryUnmark(Dart d) ;
Thery Sylvain's avatar
Thery Sylvain committed
798 799
	void boundaryUnmark2(Dart d) ;
	void boundaryUnmark3(Dart d) ;
800

Pierre Kraemer's avatar
Pierre Kraemer committed
801
public:
802 803 804
	/**
	 * test if a dart belong to the boundary
	 */
Thery Sylvain's avatar
Thery Sylvain committed
805
	template <unsigned int D>
Pierre Kraemer's avatar
Pierre Kraemer committed
806
	bool isBoundaryMarked(Dart d) const ;
807

Thery Sylvain's avatar
Thery Sylvain committed
808 809
	bool isBoundaryMarked2(Dart d) const ;
	bool isBoundaryMarked3(Dart d) const ;
810
	bool isBoundaryMarkedCurrent(Dart d) const ;
Thery Sylvain's avatar
Thery Sylvain committed
811

Pierre Kraemer's avatar
Pierre Kraemer committed
812
protected:
813 814 815
	/**
	 * mark an orbit of dart as belonging to boundary
	 */
Thery Sylvain's avatar
Thery Sylvain committed
816
	template <unsigned int ORBIT, unsigned int DIM>
817
	void boundaryMarkOrbit(Dart d) ;
818 819 820 821

	/**
	 * unmark an orbit of dart from the boundary
	 */
Thery Sylvain's avatar
Thery Sylvain committed
822
	template <unsigned int ORBIT, unsigned int DIM>
823
	void boundaryUnmarkOrbit(Dart d) ;
824 825 826 827

	/**
	 * clear all boundary markers
	 */
Thery Sylvain's avatar
Thery Sylvain committed
828
	template<unsigned int DIM>
Pierre Kraemer's avatar
Pierre Kraemer committed
829
	void boundaryUnmarkAll() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
830 831
} ;

832 833 834 835 836 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
//
//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 ;
//}
864

Pierre Kraemer's avatar
Pierre Kraemer committed
865 866 867 868 869
} //namespace CGoGN

#include "Topology/generic/genericmap.hpp"

#endif