genericmap.h 19.8 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 69
	template<typename T, unsigned int ORBIT> friend class AttributeHandler ;
	template<typename T, unsigned int ORBIT> friend class AutoAttributeHandler ;
70
	friend class DartMarkerGen ;
Sylvain Thery's avatar
Sylvain Thery committed
71
	friend class CellMarkerGen ;
72
	template<unsigned int CELL> friend class CellMarkerBase ;
Pierre Kraemer's avatar
Pierre Kraemer committed
73 74 75 76 77

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

80
	static std::map<std::string, RegisteredBaseAttribute*>* m_attributes_registry_map ;
Pierre Kraemer's avatar
Pierre Kraemer committed
81 82 83 84 85

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

Pierre Kraemer's avatar
Pierre Kraemer committed
88 89 90 91 92 93
	/**
	 * Direct access to quick traversal attributes
	 * (initialized by enableQuickTraversal function)
	 */
	AttributeMultiVector<Dart>* m_quickTraversal[NB_ORBITS] ;

Pierre Kraemer's avatar
Pierre Kraemer committed
94
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
95
	 * Marks manager
Pierre Kraemer's avatar
Pierre Kraemer committed
96
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
97
	MarkSet m_marksets[NB_ORBITS][NB_THREAD] ;
Pierre Kraemer's avatar
Pierre Kraemer committed
98 99 100 101

	/**
	 * Direct access to the attributes that store Marks
	 */
102 103 104
	AttributeMultiVector<Mark>* m_markTables[NB_ORBITS][NB_THREAD] ;

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

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

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

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

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

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

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

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

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

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

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

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

161
	virtual std::string mapTypeName() const = 0 ;
162 163 164 165 166 167 168 169

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

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

Pierre Kraemer's avatar
Pierre Kraemer committed
177
	/****************************************
Pierre Kraemer's avatar
Pierre Kraemer committed
178
	 *     RESOLUTION LEVELS MANAGEMENT     *
Pierre Kraemer's avatar
Pierre Kraemer committed
179 180
	 ****************************************/

Pierre Kraemer's avatar
Pierre Kraemer committed
181 182 183 184 185 186 187
	void printMR() ;

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

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

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

Pierre Kraemer's avatar
Pierre Kraemer committed
198 199 200 201 202 203 204 205 206 207
	/**
	 * increment the current resolution level (use only in MRMaps)
	 */
	void incCurrentLevel() ;

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

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

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

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

223
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
224
	 * add a resolution level (use only in MRMaps)
225
	 */
226 227
	void addLevel() ;

Pierre Kraemer's avatar
Pierre Kraemer committed
228
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
229
	 * remove last resolution level (use only in MRMaps)
Pierre Kraemer's avatar
Pierre Kraemer committed
230
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
231
	void removeLevel() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
232

Pierre Kraemer's avatar
Pierre Kraemer committed
233 234 235 236 237 238 239
	/****************************************
	 *           DARTS MANAGEMENT           *
	 ****************************************/
protected:
	/**
	 * Add a dart to the map
	 */
240
	virtual Dart newDart() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
241 242 243 244

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

247 248 249
	/**
	 * 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
250
	unsigned int copyDartLine(unsigned int index) ;
251

Pierre Kraemer's avatar
Pierre Kraemer committed
252
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
253 254 255 256 257 258
	 * 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
259 260 261
	 */
	void deleteDartLine(unsigned int index) ;

Pierre Kraemer's avatar
Pierre Kraemer committed
262
public:
263 264 265
	/**
	 * get the index of dart in topological table
	 */
Sylvain Thery's avatar
Sylvain Thery committed
266
	unsigned int dartIndex(Dart d) const;
267

Pierre Kraemer's avatar
Pierre Kraemer committed
268
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
269
	 * get the insertion level of a dart (use only in MRMaps)
Pierre Kraemer's avatar
Pierre Kraemer committed
270
	 */
271
	unsigned int getDartLevel(Dart d) const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
272 273 274 275 276 277 278 279 280 281

	/**
	 * 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
282 283 284 285

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

Pierre Kraemer's avatar
Pierre Kraemer committed
288 289 290 291 292
	/**
	 * return true if the dart d refers to a valid index
	 */
	bool isDartValid(Dart d) ;

Pierre Kraemer's avatar
Pierre Kraemer committed
293 294 295 296 297 298 299
	/****************************************
	 *         EMBEDDING MANAGEMENT         *
	 ****************************************/

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

303
	bool isOrbitEmbedded(unsigned int orbit) const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
304 305 306 307 308

	/**
	 * 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
	 */
309 310
	template<unsigned int ORBIT>
	unsigned int getEmbedding(Dart d) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
311 312 313 314

	/**
	 * Set the cell index of the given dimension associated to dart d
	 */
315 316
	template <unsigned int ORBIT>
	void setDartEmbedding(Dart d, unsigned int emb) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
317 318 319 320

	/**
	 * 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
321 322
	 * @param dest the dart to overwrite
	 * @param src the dart to copy
Pierre Kraemer's avatar
Pierre Kraemer committed
323
	 */
324 325
	template <unsigned int ORBIT>
	void copyDartEmbedding(Dart dest, Dart src) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
326 327 328 329 330 331

	/**
	 * Allocation of some place in attrib table
	 * @param orbit the orbit of embedding
	 * @return the index to use as embedding
	 */
332 333
	template <unsigned int ORBIT>
	unsigned int newCell() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
334 335 336 337 338 339 340

	/**
	* 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
	*/
341 342
	template <unsigned int ORBIT>
	void embedOrbit(Dart d, unsigned int em) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
343 344

	/**
untereiner's avatar
untereiner committed
345
	* Associate an new embedding to all darts of an orbit
Pierre Kraemer's avatar
Pierre Kraemer committed
346 347 348 349
	* @param orbit orbit to embed
	* @param d a dart of the topological cell
	* @return index of the attribute in table
	*/
350 351
	template <unsigned int ORBIT>
	unsigned int embedNewCell(Dart d) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
352 353

	/**
untereiner's avatar
untereiner committed
354
	 * Copy the cell associated to a dart over an other dart
Pierre Kraemer's avatar
Pierre Kraemer committed
355
	 * @param orbit attribute orbit to use
untereiner's avatar
untereiner committed
356 357
	 * @param d the dart to overwrite (dest)
	 * @param e the dart to copy (src)
Pierre Kraemer's avatar
Pierre Kraemer committed
358
	 */
359 360
	template <unsigned int ORBIT>
	void copyCell(Dart d, Dart e) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
361 362 363 364 365 366 367

	/**
	 * 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
	 */
368 369
	template <unsigned int ORBIT>
	void copyCell(unsigned int i, unsigned int j) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
370 371 372 373 374 375

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

Pierre Kraemer's avatar
Pierre Kraemer committed
379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394
	/****************************************
	 *     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
395 396 397 398 399
	/****************************************
	 *        ATTRIBUTES MANAGEMENT         *
	 ****************************************/

	/**
400 401
	 * get the attrib container of a given orbit
	 * @param orbit the orbit !!! (bilbo the orbit !)
Pierre Kraemer's avatar
Pierre Kraemer committed
402
	 */
403 404
	template <unsigned int ORBIT>
	AttributeContainer& getAttributeContainer() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
405 406

	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
407
	 * get a multi vector of mark attribute (direct access with [i])
Pierre Kraemer's avatar
Pierre Kraemer committed
408
	 */
409 410
	template <unsigned int ORBIT>
	AttributeMultiVector<Mark>* getMarkVector(unsigned int thread = 0) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
411 412

	/**
413 414
	 * 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
415
	 */
416 417
	template <unsigned int ORBIT>
	AttributeMultiVector<unsigned int>* getEmbeddingAttributeVector() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
418

419 420 421 422
//	/**
//	 * swap two attribute containers
//	 */
//	void swapEmbeddingContainers(unsigned int orbit1, unsigned int orbit2) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
423 424 425 426 427 428 429

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

430 431 432 433
	/**
	 * 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
	 */
434 435
	template <unsigned int ORBIT>
	void initOrbitEmbedding(bool realloc = false) ;
Sylvain Thery's avatar
Sylvain Thery committed
436

Pierre Kraemer's avatar
Pierre Kraemer committed
437 438 439 440 441
	/**
	 * print attributes name of map in std::cout (for debugging)
	 */
	void viewAttributesTables() ;

Sylvain Thery's avatar
Sylvain Thery committed
442 443 444 445 446 447 448
protected:
	/****************************************
	 *   EMBEDDING ATTRIBUTES MANAGEMENT    *
	 ****************************************/
	/**
	 * Create the dart attribute to store the embedding of this orbit (for internal use only)
	 */
449 450
	template <unsigned int ORBIT>
	void addEmbedding() ;
Sylvain Thery's avatar
Sylvain Thery committed
451 452 453 454 455 456

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

	/**
457
	 * Add a topological relation in the map
Sylvain Thery's avatar
Sylvain Thery committed
458 459 460 461
	 * @param name name of relation
	 */
	AttributeMultiVector<Dart>* addRelation(const std::string& name) ;

Sylvain Thery's avatar
Sylvain Thery committed
462
	/**
Pierre Kraemer's avatar
merges  
Pierre Kraemer committed
463 464
	 * Get AttributeMultivector pointer of a relation attribute
	 * @param name name of the relation
Sylvain Thery's avatar
Sylvain Thery committed
465 466
	 * @return the attribute multi-vector pointer
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
467
	AttributeMultiVector<Dart>* getRelation(const std::string& name) ;
Sylvain Thery's avatar
Sylvain Thery committed
468

Sylvain Thery's avatar
Sylvain Thery committed
469
	/****************************************
470
	 *          THREAD MANAGEMENT           *
Sylvain Thery's avatar
Sylvain Thery committed
471 472 473 474 475 476 477
	 ****************************************/
public:
	/**
	 * add  threads (a table of Marker per orbit for each thread)
	 * to allow MT
	 * @param nb thread to add
	 */
478
	void addThreadMarker(unsigned int nb) ;
Sylvain Thery's avatar
Sylvain Thery committed
479 480 481 482 483

	/**
	 * return allowed threads
	 * @return the number of threads (including principal)
	 */
484
	unsigned int getNbThreadMarkers() ;
Sylvain Thery's avatar
Sylvain Thery committed
485 486

	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
487
	 * Remove some added threads
Sylvain Thery's avatar
Sylvain Thery committed
488 489
	 * @return remaining number of threads (including principal)
	 */
490
	void removeThreadMarker(unsigned int nb) ;
Sylvain Thery's avatar
Sylvain Thery committed
491

Pierre Kraemer's avatar
Pierre Kraemer committed
492 493 494 495 496 497 498 499 500 501
	/****************************************
	 *             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
502
//	bool chechXmlNode(xmlNodePtr node, const std::string& name) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
503 504 505 506 507 508

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

Sylvain Thery's avatar
Sylvain Thery committed
509 510 511 512 513
	/**
	 * update the markTables and recursively from real type the topo shortcut pointers
	 */
	virtual void update_topo_shortcuts();

Pierre Kraemer's avatar
Pierre Kraemer committed
514 515 516 517 518
	/**
	 * Save map in a XML file
	 * @param filename the file name
	 * @return true if OK
	 */
Sylvain Thery's avatar
Sylvain Thery committed
519
//	bool saveMapXml(const std::string& filename, bool compress = false) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
520 521 522 523 524 525

	 /**
	 * Load map from a XML file
	 * @param filename the file name
	 * @return true if OK
	 */
Sylvain Thery's avatar
Sylvain Thery committed
526
//	bool loadMapXml(const std::string& filename, bool compress = false) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
527 528 529 530 531 532

	/**
	 * Save map in a binary file
	 * @param filename the file name
	 * @return true if OK
	 */
533
	bool saveMapBin(const std::string& filename) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
534 535 536 537 538 539

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

542 543 544
	/**
	 * copy from another map (of same type)
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
545
	bool copyFrom(const GenericMap& map) ;
546

Sylvain Thery's avatar
Sylvain Thery committed
547 548 549
	/**
	 * Dump attributes types and names per orbit
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
550
	void dumpAttributesAndMarkers() ;
Sylvain Thery's avatar
Sylvain Thery committed
551

552 553 554
	/**
	 * update topo relation after compacting the container:
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
555
	virtual void compactTopoRelations(const std::vector<unsigned int>& oldnew) = 0 ;
556 557 558 559

	/**
	 * compact the map
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
560
	void compact() ;
561

Pierre Kraemer's avatar
Pierre Kraemer committed
562 563 564 565 566 567 568 569
	/****************************************
	 *           DARTS TRAVERSALS           *
	 ****************************************/

	/**
	 * Begin of map
	 * @return the first dart of the map
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
570
	Dart begin() const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
571 572 573 574 575

	/**
	 * End of map
	 * @return the end iterator (next of last) of the map
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
576
	Dart end() const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
577 578 579 580 581 582

	/**
	 * allow to go from a dart to the next
	 * in the order of storage
	 * @param d reference to the dart to be modified
	 */
583
	void  next(Dart& d) const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
584 585 586 587 588

	/**
	 * Apply a functor on each dart of the map
	 * @param f a ref to the functor obj
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
589
	bool foreach_dart(FunctorType& f, const FunctorSelect& good = allDarts) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
590 591 592 593 594 595

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

599 600
	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 ;
601 602 603 604 605 606 607 608 609 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;}


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

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

Pierre Kraemer's avatar
Pierre Kraemer committed
613 614 615 616 617 618
	/**
	* execute functor for each orbit
	* @param dim the dimension of the orbit
	* @param f the functor
	* @param good the selector of darts
	*/
619 620
	template <unsigned int ORBIT>
	bool foreach_orbit(FunctorType& f, const FunctorSelect& good = allDarts, unsigned int thread = 0) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
621 622 623 624 625 626

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

630 631
protected:
	/// boundary marker
Pierre Kraemer's avatar
Pierre Kraemer committed
632
	Mark m_boundaryMarker ;
633 634 635 636

	/**
	 * mark a dart as  belonging to boundary
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
637
	void boundaryMark(Dart d) ;
638 639 640 641

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

Pierre Kraemer's avatar
Pierre Kraemer committed
644
public:
645 646 647
	/**
	 * test if a dart belong to the boundary
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
648
	bool isBoundaryMarked(Dart d) const ;
649

Pierre Kraemer's avatar
Pierre Kraemer committed
650
protected:
651 652 653
	/**
	 * mark an orbit of dart as belonging to boundary
	 */
654 655
	template <unsigned int ORBIT>
	void boundaryMarkOrbit(Dart d) ;
656 657 658 659

	/**
	 * unmark an orbit of dart from the boundary
	 */
660 661
	template <unsigned int ORBIT>
	void boundaryUnmarkOrbit(Dart d) ;
662 663 664 665

	/**
	 * clear all boundary markers
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
666
	void boundaryUnmarkAll() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
667 668
} ;

669 670 671 672 673 674 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
//
//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 ;
//}
701

Pierre Kraemer's avatar
Pierre Kraemer committed
702 703 704 705 706
} //namespace CGoGN

#include "Topology/generic/genericmap.hpp"

#endif