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 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
	static int m_nbInstances;

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

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

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

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

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

112 113 114
	/**
	 * Store links to created AttributeHandlers, DartMarkers and CellMarkers
	 */
115 116 117 118 119
	std::multimap<AttributeMultiVectorGen*, AttributeHandlerGen*> attributeHandlers ; // TODO think of MT (AttributeHandler creation & release are not thread safe!
	std::vector<DartMarkerGen*> dartMarkers[NB_THREAD] ;
	std::vector<CellMarkerGen*> cellMarkers[NB_THREAD] ;


Pierre Kraemer's avatar
Pierre Kraemer committed
120

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

132
	/**
133
	 * container for multiresolution darts
134
	 */
135 136
	AttributeContainer m_mrattribs ;

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

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

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

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

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

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

165
	GenericMap() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
166

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

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

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

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

Pierre Kraemer's avatar
Pierre Kraemer committed
185
	/****************************************
Pierre Kraemer's avatar
Pierre Kraemer committed
186
	 *     RESOLUTION LEVELS MANAGEMENT     *
Pierre Kraemer's avatar
Pierre Kraemer committed
187 188
	 ****************************************/

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	/**
	 * 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
300 301 302 303

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

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

Pierre Kraemer's avatar
Pierre Kraemer committed
311 312 313 314 315 316 317
	/****************************************
	 *         EMBEDDING MANAGEMENT         *
	 ****************************************/

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	/**
	 * compact the map
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
578
	void compact() ;
579

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

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

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

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

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

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

617 618
	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
619 620 621
	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; }
622

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

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

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

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

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

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

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

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

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

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

	/**
	 * clear all boundary markers
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
683
	void boundaryUnmarkAll() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
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 709 710 711 712 713 714 715 716 717
//
//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 ;
//}
718

Pierre Kraemer's avatar
Pierre Kraemer committed
719 720 721 722 723
} //namespace CGoGN

#include "Topology/generic/genericmap.hpp"

#endif