genericmap.h 20.4 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>

Pierre Kraemer's avatar
Pierre Kraemer committed
38

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

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

namespace CGoGN
{

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

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

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

protected:
	/**
	 * Attributes Containers
	 */
84
	AttributeContainer m_attribs[NB_ORBITS] ;
Pierre Kraemer's avatar
Pierre Kraemer committed
85

86
	static std::map<std::string, RegisteredBaseAttribute*>* m_attributes_registry_map ;
Pierre Kraemer's avatar
Pierre Kraemer committed
87

88 89
	static int m_nbInstances;

Pierre Kraemer's avatar
Pierre Kraemer committed
90 91 92 93
	/**
	 * Direct access to the Dart attributes that store the orbits embeddings
	 * (only initialized when necessary)
	 */
94
	AttributeMultiVector<unsigned int>* m_embeddings[NB_ORBITS] ;
Pierre Kraemer's avatar
Pierre Kraemer committed
95

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

Pierre Kraemer's avatar
Pierre Kraemer committed
102
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
103
	 * Marks manager
Pierre Kraemer's avatar
Pierre Kraemer committed
104
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
105
	MarkSet m_marksets[NB_ORBITS][NB_THREAD] ;
Pierre Kraemer's avatar
Pierre Kraemer committed
106 107 108 109

	/**
	 * Direct access to the attributes that store Marks
	 */
110 111 112
	AttributeMultiVector<Mark>* m_markTables[NB_ORBITS][NB_THREAD] ;

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

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

120 121 122 123
	std::vector<DartMarkerGen*> dartMarkers[NB_THREAD] ;
	std::vector<CellMarkerGen*> cellMarkers[NB_THREAD] ;


Pierre Kraemer's avatar
Pierre Kraemer committed
124

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

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

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

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

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

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

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

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

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

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

173
	virtual std::string mapTypeName() const = 0 ;
174 175 176 177 178 179 180 181

	/**
	 * 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
182

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

Pierre Kraemer's avatar
Pierre Kraemer committed
189
	/****************************************
Pierre Kraemer's avatar
Pierre Kraemer committed
190
	 *     RESOLUTION LEVELS MANAGEMENT     *
Pierre Kraemer's avatar
Pierre Kraemer committed
191 192
	 ****************************************/

Pierre Kraemer's avatar
Pierre Kraemer committed
193 194 195 196 197 198 199
	void printMR() ;

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

200
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
201
	 * get the current resolution level (use only in MRMaps)
202
	 */
203 204
	unsigned int getCurrentLevel() ;

205
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
206
	 * set the current resolution level (use only in MRMaps)
207
	 */
208 209
	void setCurrentLevel(unsigned int l) ;

Pierre Kraemer's avatar
Pierre Kraemer committed
210 211 212 213 214 215 216 217 218 219
	/**
	 * increment the current resolution level (use only in MRMaps)
	 */
	void incCurrentLevel() ;

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

220
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
221
	 * store current resolution level on a stack (use only in MRMaps)
222
	 */
223 224
	void pushLevel() ;

225
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
226
	 * set as current the resolution level of the top of the stack (use only in MRMaps)
227
	 */
228 229
	void popLevel() ;

230
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
231
	 * get the maximum resolution level (use only in MRMaps)
232
	 */
233 234
	unsigned int getMaxLevel() ;

235
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
236
	 * add a resolution level (use only in MRMaps)
237
	 */
238 239
	void addLevel() ;

240 241 242
	/**
	 * add a resolution level in the front of the level table (use only in MRMaps)
	 */
243
	void addFrontLevel();
244

Pierre Kraemer's avatar
Pierre Kraemer committed
245
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
246
	 * remove last resolution level (use only in MRMaps)
Pierre Kraemer's avatar
Pierre Kraemer committed
247
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
248
	void removeLevel() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
249

250 251 252 253 254
	/**
	 * remove first resolution level (use only in MRMaps)
	 */
	void removeFrontLevel();

Pierre Kraemer's avatar
Pierre Kraemer committed
255 256 257 258 259 260 261
	/****************************************
	 *           DARTS MANAGEMENT           *
	 ****************************************/
protected:
	/**
	 * Add a dart to the map
	 */
262
	virtual Dart newDart() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
263 264 265 266

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

269 270 271
	/**
	 * 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
272
	unsigned int copyDartLine(unsigned int index) ;
273

Pierre Kraemer's avatar
Pierre Kraemer committed
274
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
275 276 277 278 279 280
	 * duplicate a dart starting from current level
	 */
	void duplicateDart(Dart d) ;

	/**
	 * Properly deletes a dart in m_attribs[DART]
Pierre Kraemer's avatar
Pierre Kraemer committed
281 282 283
	 */
	void deleteDartLine(unsigned int index) ;

Pierre Kraemer's avatar
Pierre Kraemer committed
284
public:
285 286 287
	/**
	 * get the index of dart in topological table
	 */
Sylvain Thery's avatar
Sylvain Thery committed
288
	unsigned int dartIndex(Dart d) const;
289

Pierre Kraemer's avatar
Pierre Kraemer committed
290
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
291
	 * get the insertion level of a dart (use only in MRMaps)
Pierre Kraemer's avatar
Pierre Kraemer committed
292
	 */
293
	unsigned int getDartLevel(Dart d) const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
294 295 296 297 298 299 300 301 302 303

	/**
	 * 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
304 305 306 307

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

Pierre Kraemer's avatar
Pierre Kraemer committed
310 311 312 313 314
	/**
	 * return true if the dart d refers to a valid index
	 */
	bool isDartValid(Dart d) ;

Pierre Kraemer's avatar
Pierre Kraemer committed
315 316 317 318 319 320 321
	/****************************************
	 *         EMBEDDING MANAGEMENT         *
	 ****************************************/

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

325
	bool isOrbitEmbedded(unsigned int orbit) const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
326 327 328 329 330

	/**
	 * 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
	 */
331 332
	template<unsigned int ORBIT>
	unsigned int getEmbedding(Dart d) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
333 334 335 336

	/**
	 * Set the cell index of the given dimension associated to dart d
	 */
337 338
	template <unsigned int ORBIT>
	void setDartEmbedding(Dart d, unsigned int emb) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
339 340 341 342

	/**
	 * 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
343 344
	 * @param dest the dart to overwrite
	 * @param src the dart to copy
Pierre Kraemer's avatar
Pierre Kraemer committed
345
	 */
346 347
	template <unsigned int ORBIT>
	void copyDartEmbedding(Dart dest, Dart src) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
348 349 350 351 352 353

	/**
	 * Allocation of some place in attrib table
	 * @param orbit the orbit of embedding
	 * @return the index to use as embedding
	 */
354 355
	template <unsigned int ORBIT>
	unsigned int newCell() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
356 357 358 359 360 361 362

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

	/**
untereiner's avatar
untereiner committed
367
	* Associate an new embedding to all darts of an orbit
Pierre Kraemer's avatar
Pierre Kraemer committed
368 369 370 371
	* @param orbit orbit to embed
	* @param d a dart of the topological cell
	* @return index of the attribute in table
	*/
372 373
	template <unsigned int ORBIT>
	unsigned int embedNewCell(Dart d) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
374 375

	/**
untereiner's avatar
untereiner committed
376
	 * Copy the cell associated to a dart over an other dart
Pierre Kraemer's avatar
Pierre Kraemer committed
377
	 * @param orbit attribute orbit to use
untereiner's avatar
untereiner committed
378 379
	 * @param d the dart to overwrite (dest)
	 * @param e the dart to copy (src)
Pierre Kraemer's avatar
Pierre Kraemer committed
380
	 */
381 382
	template <unsigned int ORBIT>
	void copyCell(Dart d, Dart e) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
383 384 385 386 387 388 389

	/**
	 * 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
	 */
390 391
	template <unsigned int ORBIT>
	void copyCell(unsigned int i, unsigned int j) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
392 393 394 395 396 397

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

Pierre Kraemer's avatar
Pierre Kraemer committed
401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416
	/****************************************
	 *     QUICK TRAVERSAL MANAGEMENT       *
	 ****************************************/

	template <unsigned int ORBIT>
	void enableQuickTraversal() ;

	template <unsigned int ORBIT>
	void updateQuickTraversal() ;

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

	template <unsigned int ORBIT>
	void disableQuickTraversal() ;

Pierre Kraemer's avatar
Pierre Kraemer committed
417 418 419 420 421
	/****************************************
	 *        ATTRIBUTES MANAGEMENT         *
	 ****************************************/

	/**
422 423
	 * get the attrib container of a given orbit
	 * @param orbit the orbit !!! (bilbo the orbit !)
Pierre Kraemer's avatar
Pierre Kraemer committed
424
	 */
425 426
	template <unsigned int ORBIT>
	AttributeContainer& getAttributeContainer() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
427 428

	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
429
	 * get a multi vector of mark attribute (direct access with [i])
Pierre Kraemer's avatar
Pierre Kraemer committed
430
	 */
431 432
	template <unsigned int ORBIT>
	AttributeMultiVector<Mark>* getMarkVector(unsigned int thread = 0) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
433 434

	/**
435 436
	 * 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
437
	 */
438 439
	template <unsigned int ORBIT>
	AttributeMultiVector<unsigned int>* getEmbeddingAttributeVector() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
440

441 442 443 444
//	/**
//	 * swap two attribute containers
//	 */
//	void swapEmbeddingContainers(unsigned int orbit1, unsigned int orbit2) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
445 446 447 448 449 450 451

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

452 453 454 455
	/**
	 * 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
	 */
456 457
	template <unsigned int ORBIT>
	void initOrbitEmbedding(bool realloc = false) ;
Sylvain Thery's avatar
Sylvain Thery committed
458

Pierre Kraemer's avatar
Pierre Kraemer committed
459 460 461 462 463
	/**
	 * print attributes name of map in std::cout (for debugging)
	 */
	void viewAttributesTables() ;

Sylvain Thery's avatar
Sylvain Thery committed
464 465 466 467 468 469 470
protected:
	/****************************************
	 *   EMBEDDING ATTRIBUTES MANAGEMENT    *
	 ****************************************/
	/**
	 * Create the dart attribute to store the embedding of this orbit (for internal use only)
	 */
471 472
	template <unsigned int ORBIT>
	void addEmbedding() ;
Sylvain Thery's avatar
Sylvain Thery committed
473 474 475 476 477 478

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

	/**
479
	 * Add a topological relation in the map
Sylvain Thery's avatar
Sylvain Thery committed
480 481 482 483
	 * @param name name of relation
	 */
	AttributeMultiVector<Dart>* addRelation(const std::string& name) ;

Sylvain Thery's avatar
Sylvain Thery committed
484
	/**
Pierre Kraemer's avatar
merges  
Pierre Kraemer committed
485 486
	 * Get AttributeMultivector pointer of a relation attribute
	 * @param name name of the relation
Sylvain Thery's avatar
Sylvain Thery committed
487 488
	 * @return the attribute multi-vector pointer
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
489
	AttributeMultiVector<Dart>* getRelation(const std::string& name) ;
Sylvain Thery's avatar
Sylvain Thery committed
490

Sylvain Thery's avatar
Sylvain Thery committed
491
	/****************************************
492
	 *          THREAD MANAGEMENT           *
Sylvain Thery's avatar
Sylvain Thery committed
493 494 495 496 497 498 499
	 ****************************************/
public:
	/**
	 * add  threads (a table of Marker per orbit for each thread)
	 * to allow MT
	 * @param nb thread to add
	 */
500
	void addThreadMarker(unsigned int nb) ;
Sylvain Thery's avatar
Sylvain Thery committed
501 502 503 504 505

	/**
	 * return allowed threads
	 * @return the number of threads (including principal)
	 */
506
	unsigned int getNbThreadMarkers() ;
Sylvain Thery's avatar
Sylvain Thery committed
507 508

	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
509
	 * Remove some added threads
Sylvain Thery's avatar
Sylvain Thery committed
510 511
	 * @return remaining number of threads (including principal)
	 */
512
	void removeThreadMarker(unsigned int nb) ;
Sylvain Thery's avatar
Sylvain Thery committed
513

Pierre Kraemer's avatar
Pierre Kraemer committed
514 515 516 517 518 519 520 521 522 523
	/****************************************
	 *             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
524
//	bool chechXmlNode(xmlNodePtr node, const std::string& name) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
525 526 527 528 529 530

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

Sylvain Thery's avatar
Sylvain Thery committed
531 532 533 534 535
	/**
	 * update the markTables and recursively from real type the topo shortcut pointers
	 */
	virtual void update_topo_shortcuts();

Pierre Kraemer's avatar
Pierre Kraemer committed
536 537 538 539 540
	/**
	 * Save map in a XML file
	 * @param filename the file name
	 * @return true if OK
	 */
Sylvain Thery's avatar
Sylvain Thery committed
541
//	bool saveMapXml(const std::string& filename, bool compress = false) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
542 543 544 545 546 547

	 /**
	 * Load map from a XML file
	 * @param filename the file name
	 * @return true if OK
	 */
Sylvain Thery's avatar
Sylvain Thery committed
548
//	bool loadMapXml(const std::string& filename, bool compress = false) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
549 550 551 552 553 554

	/**
	 * Save map in a binary file
	 * @param filename the file name
	 * @return true if OK
	 */
555
	bool saveMapBin(const std::string& filename) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
556 557 558 559 560 561

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

564 565 566
	/**
	 * copy from another map (of same type)
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
567
	bool copyFrom(const GenericMap& map) ;
568

Sylvain Thery's avatar
Sylvain Thery committed
569 570 571
	/**
	 * Dump attributes types and names per orbit
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
572
	void dumpAttributesAndMarkers() ;
Sylvain Thery's avatar
Sylvain Thery committed
573

574 575 576
	/**
	 * update topo relation after compacting the container:
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
577
	virtual void compactTopoRelations(const std::vector<unsigned int>& oldnew) = 0 ;
578 579 580 581

	/**
	 * compact the map
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
582
	void compact() ;
583

Pierre Kraemer's avatar
Pierre Kraemer committed
584 585 586 587 588 589 590 591
	/****************************************
	 *           DARTS TRAVERSALS           *
	 ****************************************/

	/**
	 * Begin of map
	 * @return the first dart of the map
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
592
	Dart begin() const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
593 594 595 596 597

	/**
	 * End of map
	 * @return the end iterator (next of last) of the map
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
598
	Dart end() const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
599 600 601 602 603 604

	/**
	 * allow to go from a dart to the next
	 * in the order of storage
	 * @param d reference to the dart to be modified
	 */
605
	void  next(Dart& d) const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
606 607 608 609 610

	/**
	 * Apply a functor on each dart of the map
	 * @param f a ref to the functor obj
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
611
	bool foreach_dart(FunctorType& f, const FunctorSelect& good = allDarts) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
612 613 614 615 616 617

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

621 622
	virtual bool foreach_dart_of_vertex(Dart d, FunctorType& f, unsigned int thread = 0) = 0 ;
	virtual bool foreach_dart_of_edge(Dart d, FunctorType& f, unsigned int thread = 0) = 0 ;
Pierre Kraemer's avatar
Pierre Kraemer committed
623 624 625
	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; }
626

Pierre Kraemer's avatar
Pierre Kraemer committed
627 628
	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; }
629

Pierre Kraemer's avatar
Pierre Kraemer committed
630 631 632
	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; }
633

Pierre Kraemer's avatar
Pierre Kraemer committed
634 635 636 637 638 639
	/**
	* execute functor for each orbit
	* @param dim the dimension of the orbit
	* @param f the functor
	* @param good the selector of darts
	*/
640 641
	template <unsigned int ORBIT>
	bool foreach_orbit(FunctorType& f, const FunctorSelect& good = allDarts, unsigned int thread = 0) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
642 643 644 645 646 647

	//! Count the number of orbits of dimension dim in the map
	/*! @param dim the dimension of the orbit
	 *	@param good the selector of darts
	 * 	@return the number of orbits
	 */
648 649
	template <unsigned int ORBIT>
	unsigned int getNbOrbits(const FunctorSelect& good = allDarts) ;
Sylvain Thery's avatar
Sylvain Thery committed
650

651 652
protected:
	/// boundary marker
Pierre Kraemer's avatar
Pierre Kraemer committed
653
	Mark m_boundaryMarker ;
654 655 656 657

	/**
	 * mark a dart as  belonging to boundary
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
658
	void boundaryMark(Dart d) ;
659 660 661 662

	/**
	 * unmark a dart from the boundary
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
663
	void boundaryUnmark(Dart d) ;
664

Pierre Kraemer's avatar
Pierre Kraemer committed
665
public:
666 667 668
	/**
	 * test if a dart belong to the boundary
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
669
	bool isBoundaryMarked(Dart d) const ;
670

Pierre Kraemer's avatar
Pierre Kraemer committed
671
protected:
672 673 674
	/**
	 * mark an orbit of dart as belonging to boundary
	 */
675 676
	template <unsigned int ORBIT>
	void boundaryMarkOrbit(Dart d) ;
677 678 679 680

	/**
	 * unmark an orbit of dart from the boundary
	 */
681 682
	template <unsigned int ORBIT>
	void boundaryUnmarkOrbit(Dart d) ;
683 684 685 686

	/**
	 * clear all boundary markers
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
687
	void boundaryUnmarkAll() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
688 689
} ;

690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721
//
//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 ;
//}
722

Pierre Kraemer's avatar
Pierre Kraemer committed
723 724 725 726 727
} //namespace CGoGN

#include "Topology/generic/genericmap.hpp"

#endif