genericmap.h 20.3 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
	/**
	 * is map a multiresolution map
	 */
#ifndef CGoGN_FORCE_MR
Pierre Kraemer's avatar
Pierre Kraemer committed
129
	static const bool m_isMultiRes = false ;
130 131
#else
	static const bool m_isMultiRes = true ;
132 133
#endif

134
	/**
135
	 * container for multiresolution darts
136
	 */
137 138
	AttributeContainer m_mrattribs ;

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

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

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

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

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

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

167
	GenericMap() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
168

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

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

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

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

Pierre Kraemer's avatar
Pierre Kraemer committed
187
	/****************************************
Pierre Kraemer's avatar
Pierre Kraemer committed
188
	 *     RESOLUTION LEVELS MANAGEMENT     *
Pierre Kraemer's avatar
Pierre Kraemer committed
189 190
	 ****************************************/

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Pierre Kraemer's avatar
Pierre Kraemer committed
272
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
273 274 275 276 277 278
	 * 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
279 280 281
	 */
	void deleteDartLine(unsigned int index) ;

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

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

	/**
	 * 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
302 303 304 305

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

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

Pierre Kraemer's avatar
Pierre Kraemer committed
313 314 315 316 317 318 319
	/****************************************
	 *         EMBEDDING MANAGEMENT         *
	 ****************************************/

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

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

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

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

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

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

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

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

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

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

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

Pierre Kraemer's avatar
Pierre Kraemer committed
399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414
	/****************************************
	 *     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
415 416 417 418 419
	/****************************************
	 *        ATTRIBUTES MANAGEMENT         *
	 ****************************************/

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	/**
	 * compact the map
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
580
	void compact() ;
581

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

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

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

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

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

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

619 620
	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
621 622 623
	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; }
624

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

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

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

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

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

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

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

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

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

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

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

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
//
//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 ;
//}
720

Pierre Kraemer's avatar
Pierre Kraemer committed
721 722 723 724 725
} //namespace CGoGN

#include "Topology/generic/genericmap.hpp"

#endif