genericmap.h 20.1 KB
Newer Older
Pierre Kraemer's avatar
Pierre Kraemer committed
1 2 3
/*******************************************************************************
* CGoGN: Combinatorial and Geometric modeling with Generic N-dimensional Maps  *
* version 0.1                                                                  *
4
* Copyright (C) 2009-2012, IGG Team, LSIIT, University of Strasbourg           *
Pierre Kraemer's avatar
Pierre Kraemer committed
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
*                                                                              *
* This library is free software; you can redistribute it and/or modify it      *
* under the terms of the GNU Lesser General Public License as published by the *
* Free Software Foundation; either version 2.1 of the License, or (at your     *
* option) any later version.                                                   *
*                                                                              *
* This library is distributed in the hope that it will be useful, but WITHOUT  *
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or        *
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License  *
* for more details.                                                            *
*                                                                              *
* You should have received a copy of the GNU Lesser General Public License     *
* along with this library; if not, write to the Free Software Foundation,      *
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA.           *
*                                                                              *
20
* Web site: http://cgogn.unistra.fr/                                           *
Pierre Kraemer's avatar
Pierre Kraemer committed
21 22 23 24 25 26 27 28
* Contact information: cgogn@unistra.fr                                        *
*                                                                              *
*******************************************************************************/

#ifndef __GENERIC_MAP__
#define __GENERIC_MAP__

#include <iostream>
Sylvain Thery's avatar
Sylvain Thery committed
29
#include <string>
Pierre Kraemer's avatar
Pierre Kraemer committed
30 31 32 33 34 35 36
#include <sstream>
#include <fstream>
#include <iomanip>
#include <list>
#include <vector>
#include <map>

37
#include "Container/attributeContainer.h"
Pierre Kraemer's avatar
Pierre Kraemer committed
38

Pierre Kraemer's avatar
Pierre Kraemer committed
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
#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:
56 57 58
	virtual Dart begin() const = 0;
	virtual Dart end() const = 0;
	virtual void next(Dart& d) const = 0;
Pierre Kraemer's avatar
Pierre Kraemer committed
59 60
};

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

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

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

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

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

Pierre Kraemer's avatar
Pierre Kraemer committed
92 93 94 95 96 97
	/**
	 * Direct access to quick traversal attributes
	 * (initialized by enableQuickTraversal function)
	 */
	AttributeMultiVector<Dart>* m_quickTraversal[NB_ORBITS] ;

Pierre Kraemer's avatar
Pierre Kraemer committed
98
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
99
	 * Marks manager
Pierre Kraemer's avatar
Pierre Kraemer committed
100
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
101
	MarkSet m_marksets[NB_ORBITS][NB_THREAD] ;
Pierre Kraemer's avatar
Pierre Kraemer committed
102 103 104 105

	/**
	 * Direct access to the attributes that store Marks
	 */
106 107 108
	AttributeMultiVector<Mark>* m_markTables[NB_ORBITS][NB_THREAD] ;

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

110 111 112
	/**
	 * Store links to created AttributeHandlers, DartMarkers and CellMarkers
	 */
113
	std::multimap<AttributeMultiVectorGen*, AttributeHandlerGen*> attributeHandlers ;
114 115
	std::vector<DartMarkerGen*> dartMarkers ;
	std::vector<CellMarkerGen*> cellMarkers ;
Pierre Kraemer's avatar
Pierre Kraemer committed
116

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

128
	/**
129
	 * container for multiresolution darts
130
	 */
131 132
	AttributeContainer m_mrattribs ;

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

	/**
139
	 * pointer to attribute of m_mrattribs that stores darts insertion levels
140
	 */
141
	AttributeMultiVector<unsigned int>* m_mrLevels ;
142

Pierre Kraemer's avatar
Pierre Kraemer committed
143 144 145 146 147
	/**
	 * vector that stores the number of darts inserted on each resolution level
	 */
	std::vector<unsigned int> m_mrNbDarts ;

148
	/**
149
	 * current level in multiresolution map
150
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
151
	unsigned int m_mrCurrentLevel ;
152

153 154 155
	/**
	 * stack for current level temporary storage
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
156
	std::vector<unsigned int> m_mrLevelStack ;
157

Pierre Kraemer's avatar
Pierre Kraemer committed
158
public:
159
	static const unsigned int UNKNOWN_ATTRIB = AttributeContainer::UNKNOWN ;
Pierre Kraemer's avatar
Pierre Kraemer committed
160

161
	GenericMap() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
162

163
	~GenericMap() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
164

165
	virtual std::string mapTypeName() const = 0 ;
166 167 168 169 170 171 172 173

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

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

Pierre Kraemer's avatar
Pierre Kraemer committed
181
	/****************************************
Pierre Kraemer's avatar
Pierre Kraemer committed
182
	 *     RESOLUTION LEVELS MANAGEMENT     *
Pierre Kraemer's avatar
Pierre Kraemer committed
183 184
	 ****************************************/

Pierre Kraemer's avatar
Pierre Kraemer committed
185 186 187 188 189 190 191
	void printMR() ;

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

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

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

Pierre Kraemer's avatar
Pierre Kraemer committed
202 203 204 205 206 207 208 209 210 211
	/**
	 * increment the current resolution level (use only in MRMaps)
	 */
	void incCurrentLevel() ;

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

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

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

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

227
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
228
	 * add a resolution level (use only in MRMaps)
229
	 */
230 231
	void addLevel() ;

232 233 234 235 236
	/**
	 * add a resolution level in the front of the level table (use only in MRMaps)
	 */
	void addFrontLevel() ;

Pierre Kraemer's avatar
Pierre Kraemer committed
237
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
238
	 * remove last resolution level (use only in MRMaps)
Pierre Kraemer's avatar
Pierre Kraemer committed
239
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
240
	void removeLevel() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
241

Pierre Kraemer's avatar
Pierre Kraemer committed
242 243 244 245 246 247 248
	/****************************************
	 *           DARTS MANAGEMENT           *
	 ****************************************/
protected:
	/**
	 * Add a dart to the map
	 */
249
	virtual Dart newDart() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
250 251 252 253

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

256 257 258
	/**
	 * 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
259
	unsigned int copyDartLine(unsigned int index) ;
260

Pierre Kraemer's avatar
Pierre Kraemer committed
261
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
262 263 264 265 266 267
	 * 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
268 269 270
	 */
	void deleteDartLine(unsigned int index) ;

Pierre Kraemer's avatar
Pierre Kraemer committed
271
public:
272 273 274
	/**
	 * get the index of dart in topological table
	 */
Sylvain Thery's avatar
Sylvain Thery committed
275
	unsigned int dartIndex(Dart d) const;
276

Pierre Kraemer's avatar
Pierre Kraemer committed
277
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
278
	 * get the insertion level of a dart (use only in MRMaps)
Pierre Kraemer's avatar
Pierre Kraemer committed
279
	 */
280
	unsigned int getDartLevel(Dart d) const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
281 282 283 284 285 286 287 288 289 290

	/**
	 * 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
291 292 293 294

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

Pierre Kraemer's avatar
Pierre Kraemer committed
297 298 299 300 301
	/**
	 * return true if the dart d refers to a valid index
	 */
	bool isDartValid(Dart d) ;

Pierre Kraemer's avatar
Pierre Kraemer committed
302 303 304 305 306 307 308
	/****************************************
	 *         EMBEDDING MANAGEMENT         *
	 ****************************************/

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

312
	bool isOrbitEmbedded(unsigned int orbit) const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
313 314 315 316 317

	/**
	 * 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
	 */
318 319
	template<unsigned int ORBIT>
	unsigned int getEmbedding(Dart d) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
320 321 322 323

	/**
	 * Set the cell index of the given dimension associated to dart d
	 */
324 325
	template <unsigned int ORBIT>
	void setDartEmbedding(Dart d, unsigned int emb) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
326 327 328 329

	/**
	 * 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
330 331
	 * @param dest the dart to overwrite
	 * @param src the dart to copy
Pierre Kraemer's avatar
Pierre Kraemer committed
332
	 */
333 334
	template <unsigned int ORBIT>
	void copyDartEmbedding(Dart dest, Dart src) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
335 336 337 338 339 340

	/**
	 * Allocation of some place in attrib table
	 * @param orbit the orbit of embedding
	 * @return the index to use as embedding
	 */
341 342
	template <unsigned int ORBIT>
	unsigned int newCell() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
343 344 345 346 347 348 349

	/**
	* 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
	*/
350 351
	template <unsigned int ORBIT>
	void embedOrbit(Dart d, unsigned int em) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
352 353

	/**
untereiner's avatar
untereiner committed
354
	* Associate an new embedding to all darts of an orbit
Pierre Kraemer's avatar
Pierre Kraemer committed
355 356 357 358
	* @param orbit orbit to embed
	* @param d a dart of the topological cell
	* @return index of the attribute in table
	*/
359 360
	template <unsigned int ORBIT>
	unsigned int embedNewCell(Dart d) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
361 362

	/**
untereiner's avatar
untereiner committed
363
	 * Copy the cell associated to a dart over an other dart
Pierre Kraemer's avatar
Pierre Kraemer committed
364
	 * @param orbit attribute orbit to use
untereiner's avatar
untereiner committed
365 366
	 * @param d the dart to overwrite (dest)
	 * @param e the dart to copy (src)
Pierre Kraemer's avatar
Pierre Kraemer committed
367
	 */
368 369
	template <unsigned int ORBIT>
	void copyCell(Dart d, Dart e) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
370 371 372 373 374 375 376

	/**
	 * 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
	 */
377 378
	template <unsigned int ORBIT>
	void copyCell(unsigned int i, unsigned int j) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
379 380 381 382 383 384

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

Pierre Kraemer's avatar
Pierre Kraemer committed
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403
	/****************************************
	 *     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
404 405 406 407 408
	/****************************************
	 *        ATTRIBUTES MANAGEMENT         *
	 ****************************************/

	/**
409 410
	 * get the attrib container of a given orbit
	 * @param orbit the orbit !!! (bilbo the orbit !)
Pierre Kraemer's avatar
Pierre Kraemer committed
411
	 */
412 413
	template <unsigned int ORBIT>
	AttributeContainer& getAttributeContainer() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
414 415

	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
416
	 * get a multi vector of mark attribute (direct access with [i])
Pierre Kraemer's avatar
Pierre Kraemer committed
417
	 */
418 419
	template <unsigned int ORBIT>
	AttributeMultiVector<Mark>* getMarkVector(unsigned int thread = 0) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
420 421

	/**
422 423
	 * 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
424
	 */
425 426
	template <unsigned int ORBIT>
	AttributeMultiVector<unsigned int>* getEmbeddingAttributeVector() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
427

428 429 430 431
//	/**
//	 * swap two attribute containers
//	 */
//	void swapEmbeddingContainers(unsigned int orbit1, unsigned int orbit2) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
432 433 434 435 436 437 438

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

439 440 441 442
	/**
	 * 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
	 */
443 444
	template <unsigned int ORBIT>
	void initOrbitEmbedding(bool realloc = false) ;
Sylvain Thery's avatar
Sylvain Thery committed
445

Pierre Kraemer's avatar
Pierre Kraemer committed
446 447 448 449 450
	/**
	 * print attributes name of map in std::cout (for debugging)
	 */
	void viewAttributesTables() ;

Sylvain Thery's avatar
Sylvain Thery committed
451 452 453 454 455 456 457
protected:
	/****************************************
	 *   EMBEDDING ATTRIBUTES MANAGEMENT    *
	 ****************************************/
	/**
	 * Create the dart attribute to store the embedding of this orbit (for internal use only)
	 */
458 459
	template <unsigned int ORBIT>
	void addEmbedding() ;
Sylvain Thery's avatar
Sylvain Thery committed
460 461 462 463 464 465

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

	/**
466
	 * Add a topological relation in the map
Sylvain Thery's avatar
Sylvain Thery committed
467 468 469 470
	 * @param name name of relation
	 */
	AttributeMultiVector<Dart>* addRelation(const std::string& name) ;

Sylvain Thery's avatar
Sylvain Thery committed
471
	/**
Pierre Kraemer's avatar
merges  
Pierre Kraemer committed
472 473
	 * Get AttributeMultivector pointer of a relation attribute
	 * @param name name of the relation
Sylvain Thery's avatar
Sylvain Thery committed
474 475
	 * @return the attribute multi-vector pointer
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
476
	AttributeMultiVector<Dart>* getRelation(const std::string& name) ;
Sylvain Thery's avatar
Sylvain Thery committed
477

Sylvain Thery's avatar
Sylvain Thery committed
478
	/****************************************
479
	 *          THREAD MANAGEMENT           *
Sylvain Thery's avatar
Sylvain Thery committed
480 481 482 483 484 485 486
	 ****************************************/
public:
	/**
	 * add  threads (a table of Marker per orbit for each thread)
	 * to allow MT
	 * @param nb thread to add
	 */
487
	void addThreadMarker(unsigned int nb) ;
Sylvain Thery's avatar
Sylvain Thery committed
488 489 490 491 492

	/**
	 * return allowed threads
	 * @return the number of threads (including principal)
	 */
493
	unsigned int getNbThreadMarkers() ;
Sylvain Thery's avatar
Sylvain Thery committed
494 495

	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
496
	 * Remove some added threads
Sylvain Thery's avatar
Sylvain Thery committed
497 498
	 * @return remaining number of threads (including principal)
	 */
499
	void removeThreadMarker(unsigned int nb) ;
Sylvain Thery's avatar
Sylvain Thery committed
500

Pierre Kraemer's avatar
Pierre Kraemer committed
501 502 503 504 505 506 507 508 509 510
	/****************************************
	 *             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
511
//	bool chechXmlNode(xmlNodePtr node, const std::string& name) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
512 513 514 515 516 517

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

Sylvain Thery's avatar
Sylvain Thery committed
518 519 520 521 522
	/**
	 * update the markTables and recursively from real type the topo shortcut pointers
	 */
	virtual void update_topo_shortcuts();

Pierre Kraemer's avatar
Pierre Kraemer committed
523 524 525 526 527
	/**
	 * Save map in a XML file
	 * @param filename the file name
	 * @return true if OK
	 */
Sylvain Thery's avatar
Sylvain Thery committed
528
//	bool saveMapXml(const std::string& filename, bool compress = false) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
529 530 531 532 533 534

	 /**
	 * Load map from a XML file
	 * @param filename the file name
	 * @return true if OK
	 */
Sylvain Thery's avatar
Sylvain Thery committed
535
//	bool loadMapXml(const std::string& filename, bool compress = false) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
536 537 538 539 540 541

	/**
	 * Save map in a binary file
	 * @param filename the file name
	 * @return true if OK
	 */
542
	bool saveMapBin(const std::string& filename) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
543 544 545 546 547 548

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

551 552 553
	/**
	 * copy from another map (of same type)
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
554
	bool copyFrom(const GenericMap& map) ;
555

Sylvain Thery's avatar
Sylvain Thery committed
556 557 558
	/**
	 * Dump attributes types and names per orbit
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
559
	void dumpAttributesAndMarkers() ;
Sylvain Thery's avatar
Sylvain Thery committed
560

561 562 563
	/**
	 * update topo relation after compacting the container:
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
564
	virtual void compactTopoRelations(const std::vector<unsigned int>& oldnew) = 0 ;
565 566 567 568

	/**
	 * compact the map
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
569
	void compact() ;
570

Pierre Kraemer's avatar
Pierre Kraemer committed
571 572 573 574 575 576 577 578
	/****************************************
	 *           DARTS TRAVERSALS           *
	 ****************************************/

	/**
	 * Begin of map
	 * @return the first dart of the map
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
579
	Dart begin() const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
580 581 582 583 584

	/**
	 * End of map
	 * @return the end iterator (next of last) of the map
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
585
	Dart end() const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
586 587 588 589 590 591

	/**
	 * allow to go from a dart to the next
	 * in the order of storage
	 * @param d reference to the dart to be modified
	 */
592
	void  next(Dart& d) const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
593 594 595 596 597

	/**
	 * Apply a functor on each dart of the map
	 * @param f a ref to the functor obj
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
598
	bool foreach_dart(FunctorType& f, const FunctorSelect& good = allDarts) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
599 600 601 602 603 604

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

608 609
	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
610 611 612
	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; }
613

Pierre Kraemer's avatar
Pierre Kraemer committed
614 615
	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; }
616

Pierre Kraemer's avatar
Pierre Kraemer committed
617 618 619
	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; }
620

Pierre Kraemer's avatar
Pierre Kraemer committed
621 622 623 624 625 626
	/**
	* execute functor for each orbit
	* @param dim the dimension of the orbit
	* @param f the functor
	* @param good the selector of darts
	*/
627 628
	template <unsigned int ORBIT>
	bool foreach_orbit(FunctorType& f, const FunctorSelect& good = allDarts, unsigned int thread = 0) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
629 630 631 632 633 634

	//! 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
	 */
635 636
	template <unsigned int ORBIT>
	unsigned int getNbOrbits(const FunctorSelect& good = allDarts) ;
Sylvain Thery's avatar
Sylvain Thery committed
637

638 639
protected:
	/// boundary marker
Pierre Kraemer's avatar
Pierre Kraemer committed
640
	Mark m_boundaryMarker ;
641 642 643 644

	/**
	 * mark a dart as  belonging to boundary
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
645
	void boundaryMark(Dart d) ;
646 647 648 649

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

Pierre Kraemer's avatar
Pierre Kraemer committed
652
public:
653 654 655
	/**
	 * test if a dart belong to the boundary
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
656
	bool isBoundaryMarked(Dart d) const ;
657

Pierre Kraemer's avatar
Pierre Kraemer committed
658
protected:
659 660 661
	/**
	 * mark an orbit of dart as belonging to boundary
	 */
662 663
	template <unsigned int ORBIT>
	void boundaryMarkOrbit(Dart d) ;
664 665 666 667

	/**
	 * unmark an orbit of dart from the boundary
	 */
668 669
	template <unsigned int ORBIT>
	void boundaryUnmarkOrbit(Dart d) ;
670 671 672 673

	/**
	 * clear all boundary markers
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
674
	void boundaryUnmarkAll() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
675 676
} ;

677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708
//
//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 ;
//}
709

Pierre Kraemer's avatar
Pierre Kraemer committed
710 711 712 713 714
} //namespace CGoGN

#include "Topology/generic/genericmap.hpp"

#endif