genericmap.h 22.2 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 ;
86
87
	static int m_nbInstances;

Pierre Kraemer's avatar
Pierre Kraemer committed
88
89
	/**
	 * Direct access to the Dart attributes that store the orbits embeddings
90
	 * (only initialized when necessary, i.e. addEmbedding function)
Pierre Kraemer's avatar
Pierre Kraemer committed
91
	 */
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
	std::multimap<AttributeMultiVectorGen*, AttributeHandlerGen*> attributeHandlers ; // TODO think of MT (AttributeHandler creation & release are not thread safe!)
116
117
	boost::mutex attributeHandlersMutex;

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

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

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

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

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

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

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

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

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

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

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

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

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

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
232
233
234
235
//private:
//	/*
//	 * add a resolution level
//	 */
//	AttributeMultiVector<unsigned int>* addLevel();
untereiner's avatar
untereiner committed
236

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

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

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

252
253
254
	/**
	 * remove first resolution level (use only in MRMaps)
	 */
untereiner's avatar
untereiner committed
255
256
257
258
259
260
261
262
263
264
265
266
267
	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);

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

359
360
361
362
363
364
365
	/**
	 * Set the cell index of the given dimension associated to dart d
	 * !!! WARNING !!! use only on freshly inserted darts (no unref is done on old embedding) !!! WARNING !!!
	 */
	template <unsigned int ORBIT>
	void initDartEmbedding(Dart d, unsigned int emb) ;

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

	/**
	 * Allocation of some place in attrib table
	 * @param orbit the orbit of embedding
	 * @return the index to use as embedding
	 */
380
381
	template <unsigned int ORBIT>
	unsigned int newCell() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
382
383
384
385
386
387
388

	/**
	* 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
	*/
389
	template <unsigned int ORBIT>
390
391
392
393
394
395
396
397
	void setOrbitEmbedding(Dart d, unsigned int em) ;

	/**
	 * Set the index of the associated cell to all the darts of an orbit
	 * !!! WARNING !!! use only on freshly inserted darts (no unref is done on old embedding)!!! WARNING !!!
	 */
	template <unsigned int ORBIT>
	void initOrbitEmbedding(Dart d, unsigned int em) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
398
399

	/**
400
	* Associate an new cell to all darts of an orbit
Pierre Kraemer's avatar
Pierre Kraemer committed
401
402
403
404
	* @param orbit orbit to embed
	* @param d a dart of the topological cell
	* @return index of the attribute in table
	*/
405
	template <unsigned int ORBIT>
406
	unsigned int setOrbitEmbeddingOnNewCell(Dart d) ;
407
408
409
410
411
412
413

	/**
	 * Associate an new cell to all darts of an orbit
	 * !!! WARNING !!! use only on freshly inserted darts (no unref is done on old embedding)!!! WARNING !!!
	 */
	template <unsigned int ORBIT>
	unsigned int initOrbitEmbeddingNewCell(Dart d) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
414
415

	/**
untereiner's avatar
untereiner committed
416
	 * Copy the cell associated to a dart over an other dart
Pierre Kraemer's avatar
Pierre Kraemer committed
417
	 * @param orbit attribute orbit to use
untereiner's avatar
untereiner committed
418
419
	 * @param d the dart to overwrite (dest)
	 * @param e the dart to copy (src)
Pierre Kraemer's avatar
Pierre Kraemer committed
420
	 */
421
422
	template <unsigned int ORBIT>
	void copyCell(Dart d, Dart e) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
423
424
425
426
427
428
429

	/**
	 * 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
	 */
430
431
	template <unsigned int ORBIT>
	void copyCell(unsigned int i, unsigned int j) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
432
433
434
435
436
437

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

441
442
443
444
445
446
447
448
	/**
	 * 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
	 */
	template <unsigned int ORBIT>
	void initAllOrbitsEmbedding(bool realloc = false) ;


Pierre Kraemer's avatar
Pierre Kraemer committed
449
450
451
452
453
454
455
456
	/****************************************
	 *     QUICK TRAVERSAL MANAGEMENT       *
	 ****************************************/

	template <unsigned int ORBIT>
	void enableQuickTraversal() ;

	template <unsigned int ORBIT>
457
	void updateQuickTraversal(const FunctorSelect& good = allDarts) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
458
459
460
461
462
463
464

	template <unsigned int ORBIT>
	AttributeMultiVector<Dart>* getQuickTraversal() ;

	template <unsigned int ORBIT>
	void disableQuickTraversal() ;

Pierre Kraemer's avatar
Pierre Kraemer committed
465
466
467
468
469
	/****************************************
	 *        ATTRIBUTES MANAGEMENT         *
	 ****************************************/

	/**
470
471
	 * get the attrib container of a given orbit
	 * @param orbit the orbit !!! (bilbo the orbit !)
Pierre Kraemer's avatar
Pierre Kraemer committed
472
	 */
473
474
	template <unsigned int ORBIT>
	AttributeContainer& getAttributeContainer() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
475
476

	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
477
	 * get a multi vector of mark attribute (direct access with [i])
Pierre Kraemer's avatar
Pierre Kraemer committed
478
	 */
479
480
	template <unsigned int ORBIT>
	AttributeMultiVector<Mark>* getMarkVector(unsigned int thread = 0) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
481
482

	/**
483
484
	 * 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
485
	 */
486
487
	template <unsigned int ORBIT>
	AttributeMultiVector<unsigned int>* getEmbeddingAttributeVector() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
488

489
490
491
492
493
494
495
496
497
498
	/**
	 * get the MR attribute container
	 */
	AttributeContainer& getMRAttributeContainer() ;

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

untereiner's avatar
untereiner committed
499
500
	AttributeMultiVector<unsigned int>* getMRLevelAttributeVector();

501
502
503
504
//	/**
//	 * swap two attribute containers
//	 */
//	void swapEmbeddingContainers(unsigned int orbit1, unsigned int orbit2) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
505
506
507
508
509
510
511

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

Pierre Kraemer's avatar
Pierre Kraemer committed
512
513
514
515
516
	/**
	 * print attributes name of map in std::cout (for debugging)
	 */
	void viewAttributesTables() ;

517
518
	void printDartsTable();

Sylvain Thery's avatar
Sylvain Thery committed
519
520
521
522
523
524
525
protected:
	/****************************************
	 *   EMBEDDING ATTRIBUTES MANAGEMENT    *
	 ****************************************/
	/**
	 * Create the dart attribute to store the embedding of this orbit (for internal use only)
	 */
526
527
	template <unsigned int ORBIT>
	void addEmbedding() ;
Sylvain Thery's avatar
Sylvain Thery committed
528
529
530
531
532
533

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

	/**
534
	 * Add a topological relation in the map
Sylvain Thery's avatar
Sylvain Thery committed
535
536
537
538
	 * @param name name of relation
	 */
	AttributeMultiVector<Dart>* addRelation(const std::string& name) ;

Sylvain Thery's avatar
Sylvain Thery committed
539
	/**
Pierre Kraemer's avatar
merges    
Pierre Kraemer committed
540
541
	 * Get AttributeMultivector pointer of a relation attribute
	 * @param name name of the relation
Sylvain Thery's avatar
Sylvain Thery committed
542
543
	 * @return the attribute multi-vector pointer
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
544
	AttributeMultiVector<Dart>* getRelation(const std::string& name) ;
Sylvain Thery's avatar
Sylvain Thery committed
545

Sylvain Thery's avatar
Sylvain Thery committed
546
	/****************************************
547
	 *          THREAD MANAGEMENT           *
Sylvain Thery's avatar
Sylvain Thery committed
548
549
550
551
552
553
554
	 ****************************************/
public:
	/**
	 * add  threads (a table of Marker per orbit for each thread)
	 * to allow MT
	 * @param nb thread to add
	 */
555
	void addThreadMarker(unsigned int nb) ;
Sylvain Thery's avatar
Sylvain Thery committed
556
557
558
559
560

	/**
	 * return allowed threads
	 * @return the number of threads (including principal)
	 */
561
	unsigned int getNbThreadMarkers() ;
Sylvain Thery's avatar
Sylvain Thery committed
562
563

	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
564
	 * Remove some added threads
Sylvain Thery's avatar
Sylvain Thery committed
565
566
	 * @return remaining number of threads (including principal)
	 */
567
	void removeThreadMarker(unsigned int nb) ;
Sylvain Thery's avatar
Sylvain Thery committed
568

Pierre Kraemer's avatar
Pierre Kraemer committed
569
570
571
572
573
574
575
576
577
578
	/****************************************
	 *             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
579
//	bool chechXmlNode(xmlNodePtr node, const std::string& name) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
580
581
582
583
584
585

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

Sylvain Thery's avatar
Sylvain Thery committed
586
587
588
589
590
	/**
	 * update the markTables and recursively from real type the topo shortcut pointers
	 */
	virtual void update_topo_shortcuts();

Pierre Kraemer's avatar
Pierre Kraemer committed
591
592
593
594
595
	/**
	 * Save map in a XML file
	 * @param filename the file name
	 * @return true if OK
	 */
Sylvain Thery's avatar
Sylvain Thery committed
596
//	bool saveMapXml(const std::string& filename, bool compress = false) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
597
598
599
600
601
602

	 /**
	 * Load map from a XML file
	 * @param filename the file name
	 * @return true if OK
	 */
Sylvain Thery's avatar
Sylvain Thery committed
603
//	bool loadMapXml(const std::string& filename, bool compress = false) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
604
605
606
607
608
609

	/**
	 * Save map in a binary file
	 * @param filename the file name
	 * @return true if OK
	 */
610
	bool saveMapBin(const std::string& filename) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
611
612
613
614
615
616

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

619
620
621
	/**
	 * copy from another map (of same type)
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
622
	bool copyFrom(const GenericMap& map) ;
623

Sylvain Thery's avatar
Sylvain Thery committed
624
625
626
	/**
	 * Dump attributes types and names per orbit
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
627
	void dumpAttributesAndMarkers() ;
Sylvain Thery's avatar
Sylvain Thery committed
628

629
630
631
	/**
	 * update topo relation after compacting the container:
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
632
	virtual void compactTopoRelations(const std::vector<unsigned int>& oldnew) = 0 ;
633
634
635
636

	/**
	 * compact the map
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
637
	void compact() ;
638

Pierre Kraemer's avatar
Pierre Kraemer committed
639
640
641
642
643
644
645
646
	/****************************************
	 *           DARTS TRAVERSALS           *
	 ****************************************/

	/**
	 * Begin of map
	 * @return the first dart of the map
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
647
	Dart begin() const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
648
649
650
651
652

	/**
	 * End of map
	 * @return the end iterator (next of last) of the map
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
653
	Dart end() const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
654
655
656
657
658
659

	/**
	 * allow to go from a dart to the next
	 * in the order of storage
	 * @param d reference to the dart to be modified
	 */
660
	void  next(Dart& d) const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
661
662
663
664
665

	/**
	 * Apply a functor on each dart of the map
	 * @param f a ref to the functor obj
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
666
	bool foreach_dart(FunctorType& f, const FunctorSelect& good = allDarts) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
667
668
669
670
671
672

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

676
677
	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
678
679
680
	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; }
681

Pierre Kraemer's avatar
Pierre Kraemer committed
682
683
	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; }
684

Pierre Kraemer's avatar
Pierre Kraemer committed
685
686
687
	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; }
688

Pierre Kraemer's avatar
Pierre Kraemer committed
689
690
691
692
693
694
	/**
	* execute functor for each orbit
	* @param dim the dimension of the orbit
	* @param f the functor
	* @param good the selector of darts
	*/
695
696
	template <unsigned int ORBIT>
	bool foreach_orbit(FunctorType& f, const FunctorSelect& good = allDarts, unsigned int thread = 0) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
697
698
699
700
701
702

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

706
707
708
	//! For an orbit of a given dimension, return the number of incident cells of an other given dimension
	/*! @param d a dart
	 */
709
	template <typename MAP, unsigned int ORBIT, unsigned int INCIDENT>
710
711
	unsigned int degree(Dart d);

712
713
protected:
	/// boundary marker
Pierre Kraemer's avatar
Pierre Kraemer committed
714
	Mark m_boundaryMarker ;
715
716
717
718

	/**
	 * mark a dart as  belonging to boundary
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
719
	void boundaryMark(Dart d) ;
720
721
722
723

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

Pierre Kraemer's avatar
Pierre Kraemer committed
726
public:
727
728
729
	/**
	 * test if a dart belong to the boundary
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
730
	bool isBoundaryMarked(Dart d) const ;
731

Pierre Kraemer's avatar
Pierre Kraemer committed
732
protected:
733
734
735
	/**
	 * mark an orbit of dart as belonging to boundary
	 */
736
737
	template <unsigned int ORBIT>
	void boundaryMarkOrbit(Dart d) ;
738
739
740
741

	/**
	 * unmark an orbit of dart from the boundary
	 */
742
743
	template <unsigned int ORBIT>
	void boundaryUnmarkOrbit(Dart d) ;
744
745
746
747

	/**
	 * clear all boundary markers
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
748
	void boundaryUnmarkAll() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
749
750
} ;

751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
//
//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 ;
//}
783

Pierre Kraemer's avatar
Pierre Kraemer committed
784
785
786
787
788
} //namespace CGoGN

#include "Topology/generic/genericmap.hpp"

#endif