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

#ifndef __GENERIC_MAP__
#define __GENERIC_MAP__

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

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

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

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

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

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

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

87 88
	static int m_nbInstances;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

168
	virtual std::string mapTypeName() const = 0 ;
169

170 171
	virtual unsigned int dimension() const = 0 ;

172 173 174 175 176 177 178
	/**
	 * 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
179

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

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

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

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

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

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

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

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

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

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

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

232 233 234 235 236
//private:
//	/*
//	 * add a resolution level
//	 */
//	AttributeMultiVector<unsigned int>* addLevel();
untereiner's avatar
untereiner committed
237

238
	/**
untereiner's avatar
untereiner committed
239
	 * add a resolution level in the back of the level table (use only in MRMaps)
240
	 */
untereiner's avatar
untereiner committed
241
	void addLevelBack() ;
242

243 244 245
	/**
	 * add a resolution level in the front of the level table (use only in MRMaps)
	 */
untereiner's avatar
untereiner committed
246
	void addLevelFront();
247

Pierre Kraemer's avatar
Pierre Kraemer committed
248
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
249
	 * remove last resolution level (use only in MRMaps)
Pierre Kraemer's avatar
Pierre Kraemer committed
250
	 */
untereiner's avatar
untereiner committed
251
	void removeLevelBack() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
252

253 254 255
	/**
	 * remove first resolution level (use only in MRMaps)
	 */
untereiner's avatar
untereiner committed
256 257 258 259 260 261 262 263 264 265 266 267 268
	void removeLevelFront();

	/**
	 * copy MRDarts from level-1 to level
	 */
	void copyLevel(unsigned int level);

	/**
	 * duplicate darts from level-1 to level
	 */
	void duplicateDarts(unsigned int level);

	/**
269
	 * duplicate a dart starting from current level
untereiner's avatar
untereiner committed
270
	 */
271
	void duplicateDart(Dart d) ;
272

untereiner's avatar
untereiner committed
273
	void duplicateDartAtOneLevel(Dart d, unsigned int level) ;
274

Pierre Kraemer's avatar
Pierre Kraemer committed
275 276 277 278 279 280 281
	/****************************************
	 *           DARTS MANAGEMENT           *
	 ****************************************/
protected:
	/**
	 * Add a dart to the map
	 */
282
	virtual Dart newDart() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
283 284 285 286

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

289 290 291
	/**
	 * 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
292
	unsigned int copyDartLine(unsigned int index) ;
293

Pierre Kraemer's avatar
Pierre Kraemer committed
294 295
	/**
	 * Properly deletes a dart in m_attribs[DART]
Pierre Kraemer's avatar
Pierre Kraemer committed
296 297 298
	 */
	void deleteDartLine(unsigned int index) ;

Pierre Kraemer's avatar
Pierre Kraemer committed
299
public:
300 301 302
	/**
	 * get the index of dart in topological table
	 */
Sylvain Thery's avatar
Sylvain Thery committed
303
	unsigned int dartIndex(Dart d) const;
304

Pierre Kraemer's avatar
Pierre Kraemer committed
305
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
306
	 * get the insertion level of a dart (use only in MRMaps)
Pierre Kraemer's avatar
Pierre Kraemer committed
307
	 */
308
	unsigned int getDartLevel(Dart d) const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
309

310 311 312 313 314
	/**
	 *
	 */
	void incDartLevel(Dart d) const ;

Pierre Kraemer's avatar
Pierre Kraemer committed
315 316 317 318 319 320 321 322 323
	/**
	 * 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
324 325 326 327

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

Pierre Kraemer's avatar
Pierre Kraemer committed
330 331 332 333 334
	/**
	 * return true if the dart d refers to a valid index
	 */
	bool isDartValid(Dart d) ;

Pierre Kraemer's avatar
Pierre Kraemer committed
335 336 337 338 339 340 341
	/****************************************
	 *         EMBEDDING MANAGEMENT         *
	 ****************************************/

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

345
	bool isOrbitEmbedded(unsigned int orbit) const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
346 347 348 349 350

	/**
	 * 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
	 */
351 352
	template<unsigned int ORBIT>
	unsigned int getEmbedding(Dart d) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
353 354 355 356

	/**
	 * Set the cell index of the given dimension associated to dart d
	 */
357 358
	template <unsigned int ORBIT>
	void setDartEmbedding(Dart d, unsigned int emb) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
359 360 361 362

	/**
	 * 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
363 364
	 * @param dest the dart to overwrite
	 * @param src the dart to copy
Pierre Kraemer's avatar
Pierre Kraemer committed
365
	 */
366 367
	template <unsigned int ORBIT>
	void copyDartEmbedding(Dart dest, Dart src) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
368 369 370 371 372 373

	/**
	 * Allocation of some place in attrib table
	 * @param orbit the orbit of embedding
	 * @return the index to use as embedding
	 */
374 375
	template <unsigned int ORBIT>
	unsigned int newCell() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
376 377 378 379 380 381 382

	/**
	* 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
	*/
383 384
	template <unsigned int ORBIT>
	void embedOrbit(Dart d, unsigned int em) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
385 386

	/**
untereiner's avatar
untereiner committed
387
	* Associate an new embedding to all darts of an orbit
Pierre Kraemer's avatar
Pierre Kraemer committed
388 389 390 391
	* @param orbit orbit to embed
	* @param d a dart of the topological cell
	* @return index of the attribute in table
	*/
392 393
	template <unsigned int ORBIT>
	unsigned int embedNewCell(Dart d) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
394 395

	/**
untereiner's avatar
untereiner committed
396
	 * Copy the cell associated to a dart over an other dart
Pierre Kraemer's avatar
Pierre Kraemer committed
397
	 * @param orbit attribute orbit to use
untereiner's avatar
untereiner committed
398 399
	 * @param d the dart to overwrite (dest)
	 * @param e the dart to copy (src)
Pierre Kraemer's avatar
Pierre Kraemer committed
400
	 */
401 402
	template <unsigned int ORBIT>
	void copyCell(Dart d, Dart e) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
403 404 405 406 407 408 409

	/**
	 * 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
	 */
410 411
	template <unsigned int ORBIT>
	void copyCell(unsigned int i, unsigned int j) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
412 413 414 415 416 417

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

Pierre Kraemer's avatar
Pierre Kraemer committed
421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436
	/****************************************
	 *     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
437 438 439 440 441
	/****************************************
	 *        ATTRIBUTES MANAGEMENT         *
	 ****************************************/

	/**
442 443
	 * get the attrib container of a given orbit
	 * @param orbit the orbit !!! (bilbo the orbit !)
Pierre Kraemer's avatar
Pierre Kraemer committed
444
	 */
445 446
	template <unsigned int ORBIT>
	AttributeContainer& getAttributeContainer() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
447 448

	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
449
	 * get a multi vector of mark attribute (direct access with [i])
Pierre Kraemer's avatar
Pierre Kraemer committed
450
	 */
451 452
	template <unsigned int ORBIT>
	AttributeMultiVector<Mark>* getMarkVector(unsigned int thread = 0) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
453 454

	/**
455 456
	 * 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
457
	 */
458 459
	template <unsigned int ORBIT>
	AttributeMultiVector<unsigned int>* getEmbeddingAttributeVector() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
460

461 462 463 464 465 466 467 468 469 470
	/**
	 * get the MR attribute container
	 */
	AttributeContainer& getMRAttributeContainer() ;

	/**
	 * get the MR attribute container
	 */
	AttributeMultiVector<unsigned int>* getMRDartAttributeVector(unsigned int level) ;

untereiner's avatar
untereiner committed
471 472
	AttributeMultiVector<unsigned int>* getMRLevelAttributeVector();

473 474 475 476
//	/**
//	 * swap two attribute containers
//	 */
//	void swapEmbeddingContainers(unsigned int orbit1, unsigned int orbit2) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
477 478 479 480 481 482 483

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

484 485 486 487
	/**
	 * 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
	 */
488 489
	template <unsigned int ORBIT>
	void initOrbitEmbedding(bool realloc = false) ;
Sylvain Thery's avatar
Sylvain Thery committed
490

Pierre Kraemer's avatar
Pierre Kraemer committed
491 492 493 494 495
	/**
	 * print attributes name of map in std::cout (for debugging)
	 */
	void viewAttributesTables() ;

496 497
	void printDartsTable();

Sylvain Thery's avatar
Sylvain Thery committed
498 499 500 501 502 503 504
protected:
	/****************************************
	 *   EMBEDDING ATTRIBUTES MANAGEMENT    *
	 ****************************************/
	/**
	 * Create the dart attribute to store the embedding of this orbit (for internal use only)
	 */
505 506
	template <unsigned int ORBIT>
	void addEmbedding() ;
Sylvain Thery's avatar
Sylvain Thery committed
507 508 509 510 511 512

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

	/**
513
	 * Add a topological relation in the map
Sylvain Thery's avatar
Sylvain Thery committed
514 515 516 517
	 * @param name name of relation
	 */
	AttributeMultiVector<Dart>* addRelation(const std::string& name) ;

Sylvain Thery's avatar
Sylvain Thery committed
518
	/**
Pierre Kraemer's avatar
merges  
Pierre Kraemer committed
519 520
	 * Get AttributeMultivector pointer of a relation attribute
	 * @param name name of the relation
Sylvain Thery's avatar
Sylvain Thery committed
521 522
	 * @return the attribute multi-vector pointer
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
523
	AttributeMultiVector<Dart>* getRelation(const std::string& name) ;
Sylvain Thery's avatar
Sylvain Thery committed
524

Sylvain Thery's avatar
Sylvain Thery committed
525
	/****************************************
526
	 *          THREAD MANAGEMENT           *
Sylvain Thery's avatar
Sylvain Thery committed
527 528 529 530 531 532 533
	 ****************************************/
public:
	/**
	 * add  threads (a table of Marker per orbit for each thread)
	 * to allow MT
	 * @param nb thread to add
	 */
534
	void addThreadMarker(unsigned int nb) ;
Sylvain Thery's avatar
Sylvain Thery committed
535 536 537 538 539

	/**
	 * return allowed threads
	 * @return the number of threads (including principal)
	 */
540
	unsigned int getNbThreadMarkers() ;
Sylvain Thery's avatar
Sylvain Thery committed
541 542

	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
543
	 * Remove some added threads
Sylvain Thery's avatar
Sylvain Thery committed
544 545
	 * @return remaining number of threads (including principal)
	 */
546
	void removeThreadMarker(unsigned int nb) ;
Sylvain Thery's avatar
Sylvain Thery committed
547

Pierre Kraemer's avatar
Pierre Kraemer committed
548 549 550 551 552 553 554 555 556 557
	/****************************************
	 *             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
558
//	bool chechXmlNode(xmlNodePtr node, const std::string& name) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
559 560 561 562 563 564

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

Sylvain Thery's avatar
Sylvain Thery committed
565 566 567 568 569
	/**
	 * update the markTables and recursively from real type the topo shortcut pointers
	 */
	virtual void update_topo_shortcuts();

Pierre Kraemer's avatar
Pierre Kraemer committed
570 571 572 573 574
	/**
	 * Save map in a XML file
	 * @param filename the file name
	 * @return true if OK
	 */
Sylvain Thery's avatar
Sylvain Thery committed
575
//	bool saveMapXml(const std::string& filename, bool compress = false) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
576 577 578 579 580 581

	 /**
	 * Load map from a XML file
	 * @param filename the file name
	 * @return true if OK
	 */
Sylvain Thery's avatar
Sylvain Thery committed
582
//	bool loadMapXml(const std::string& filename, bool compress = false) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
583 584 585 586 587 588

	/**
	 * Save map in a binary file
	 * @param filename the file name
	 * @return true if OK
	 */
589
	bool saveMapBin(const std::string& filename) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
590 591 592 593 594 595

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

598 599 600
	/**
	 * copy from another map (of same type)
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
601
	bool copyFrom(const GenericMap& map) ;
602

Sylvain Thery's avatar
Sylvain Thery committed
603 604 605
	/**
	 * Dump attributes types and names per orbit
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
606
	void dumpAttributesAndMarkers() ;
Sylvain Thery's avatar
Sylvain Thery committed
607

608 609 610
	/**
	 * update topo relation after compacting the container:
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
611
	virtual void compactTopoRelations(const std::vector<unsigned int>& oldnew) = 0 ;
612 613 614 615

	/**
	 * compact the map
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
616
	void compact() ;
617

Pierre Kraemer's avatar
Pierre Kraemer committed
618 619 620 621 622 623 624 625
	/****************************************
	 *           DARTS TRAVERSALS           *
	 ****************************************/

	/**
	 * Begin of map
	 * @return the first dart of the map
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
626
	Dart begin() const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
627 628 629 630 631

	/**
	 * End of map
	 * @return the end iterator (next of last) of the map
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
632
	Dart end() const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
633 634 635 636 637 638

	/**
	 * allow to go from a dart to the next
	 * in the order of storage
	 * @param d reference to the dart to be modified
	 */
639
	void  next(Dart& d) const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
640 641 642 643 644

	/**
	 * Apply a functor on each dart of the map
	 * @param f a ref to the functor obj
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
645
	bool foreach_dart(FunctorType& f, const FunctorSelect& good = allDarts) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
646 647 648 649 650 651

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

655 656
	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
657 658 659
	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; }
660

Pierre Kraemer's avatar
Pierre Kraemer committed
661 662
	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; }
663

Pierre Kraemer's avatar
Pierre Kraemer committed
664 665 666
	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; }
667

Pierre Kraemer's avatar
Pierre Kraemer committed
668 669 670 671 672 673
	/**
	* execute functor for each orbit
	* @param dim the dimension of the orbit
	* @param f the functor
	* @param good the selector of darts
	*/
674 675
	template <unsigned int ORBIT>
	bool foreach_orbit(FunctorType& f, const FunctorSelect& good = allDarts, unsigned int thread = 0) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
676 677 678 679 680 681

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

685 686 687
	//! For an orbit of a given dimension, return the number of incident cells of an other given dimension
	/*! @param d a dart
	 */
688
	template <typename MAP, unsigned int ORBIT, unsigned int INCIDENT>
689 690
	unsigned int degree(Dart d);

691 692
protected:
	/// boundary marker
Pierre Kraemer's avatar
Pierre Kraemer committed
693
	Mark m_boundaryMarker ;
694 695 696 697

	/**
	 * mark a dart as  belonging to boundary
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
698
	void boundaryMark(Dart d) ;
699 700 701 702

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

Pierre Kraemer's avatar
Pierre Kraemer committed
705
public:
706 707 708
	/**
	 * test if a dart belong to the boundary
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
709
	bool isBoundaryMarked(Dart d) const ;
710

Pierre Kraemer's avatar
Pierre Kraemer committed
711
protected:
712 713 714
	/**
	 * mark an orbit of dart as belonging to boundary
	 */
715 716
	template <unsigned int ORBIT>
	void boundaryMarkOrbit(Dart d) ;
717 718 719 720

	/**
	 * unmark an orbit of dart from the boundary
	 */
721 722
	template <unsigned int ORBIT>
	void boundaryUnmarkOrbit(Dart d) ;
723 724 725 726

	/**
	 * clear all boundary markers
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
727
	void boundaryUnmarkAll() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
728 729
} ;

730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761
//
//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 ;
//}
762

Pierre Kraemer's avatar
Pierre Kraemer committed
763 764 765 766 767
} //namespace CGoGN

#include "Topology/generic/genericmap.hpp"

#endif