genericmap.h 13.1 KB
Newer Older
Pierre Kraemer's avatar
Pierre Kraemer committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
/*******************************************************************************
* CGoGN: Combinatorial and Geometric modeling with Generic N-dimensional Maps  *
* version 0.1                                                                  *
* Copyright (C) 2009, IGG Team, LSIIT, University of Strasbourg                *
*                                                                              *
* 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.           *
*                                                                              *
* Web site: https://iggservis.u-strasbg.fr/CGoGN/                              *
* Contact information: cgogn@unistra.fr                                        *
*                                                                              *
*******************************************************************************/

#ifndef __GENERIC_MAP__
#define __GENERIC_MAP__

#include <iostream>
#include <sstream>
#include <fstream>
#include <iomanip>
#include <list>
#include <vector>
#include <map>


#define EMBNULL 0xffffffff

#define NB_ORBITS 5
sylvain thery's avatar
sylvain thery committed
40
#define NBTHREAD 16
Pierre Kraemer's avatar
Pierre Kraemer committed
41
42
43
44
45
46
47
48

#define VERTEX_ORBIT	(unsigned int)(0)
#define EDGE_ORBIT		(unsigned int)(1)
#define FACE_ORBIT		(unsigned int)(2)
#define VOLUME_ORBIT	(unsigned int)(3)
#define DART_ORBIT		(unsigned int)(4)


49
#include "Container/attributeContainer.h"
Pierre Kraemer's avatar
Pierre Kraemer committed
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
#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:
	virtual Dart begin() = 0;
	virtual Dart end() = 0;
	virtual void next(Dart& d) = 0;
};

class GenericMap : public MapBrowser
{
	friend class DartMarker ;
	friend class DartMarkerStore ;
	friend class DartMarkerNoUnmark ;

	template<typename T> friend class AutoAttributeHandler ;

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

87
	static std::map<std::string, RegisteredBaseAttribute*>* m_attributes_registry_map ;
Pierre Kraemer's avatar
Pierre Kraemer committed
88
89
90
91
92

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

	/**
	 * Markers manager
	 */
Sylvain Thery's avatar
Sylvain Thery committed
98
	MarkerSet m_orbMarker[NB_ORBITS][NBTHREAD] ;
Pierre Kraemer's avatar
Pierre Kraemer committed
99
100
101
102

	/**
	 * Direct access to the attributes that store Marks
	 */
103
	AttributeMultiVector<Mark>* m_markerTables[NB_ORBITS][NBTHREAD];
Sylvain Thery's avatar
Sylvain Thery committed
104
105

	unsigned int m_nbThreads;
Pierre Kraemer's avatar
Pierre Kraemer committed
106
107

public:
108
	static const unsigned int UNKNOWN_ATTRIB = AttributeContainer::UNKNOWN ;
Pierre Kraemer's avatar
Pierre Kraemer committed
109
110
111
112
113
114
115
116
117
118
119
120
121
122

	GenericMap();

	~GenericMap();

	virtual std::string mapTypeName() = 0;

	/****************************************
	 *           DARTS MANAGEMENT           *
	 ****************************************/
protected:
	/**
	 * Add a dart to the map
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
123
	virtual Dart newDart();
Pierre Kraemer's avatar
Pierre Kraemer committed
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230

	/**
	 * Erase a dart of the map
	 */
	void deleteDart(Dart d);

public:
	/**
	 * return true if the dart d refers to a valid index
	 */
	bool isDartValid(Dart d) ;

	/**
	 * @return the number of darts in the map
	 */
	unsigned getNbDarts();

	/****************************************
	 *         EMBEDDING MANAGEMENT         *
	 ****************************************/

	/**
	 * tell if an orbit is embedded or not
	 */
	bool isOrbitEmbedded(unsigned int orbit) const;

	/**
	 * return the number of embedded orbits (including DART_ORBIT)
	 */
	unsigned int nbEmbeddings() const;

	/**
	 * get the cell index of the given dimension associated to dart d
	 * (can go through the whole orbit due to lazy embedding)
	 * @return EMBNULL if the orbit of d is not attached to any cell
	 */
	unsigned int getEmbedding(Dart d, unsigned int orbit);

	/**
	 * Get the cell index of the given dimension associated to dart d
	 */
	unsigned int getDartEmbedding(unsigned int orbit, Dart d);

	/**
	 * Set the cell index of the given dimension associated to dart d
	 */
	void setDartEmbedding(unsigned int orbit, Dart d, unsigned int emb);

	/**
	 * Copy the index of the cell associated to a dart over an other dart
	 * @param d the dart to overwrite (dest)
	 * @param e the dart to copy (src)
	 * @param orbit the id of orbit embedding
	 */
	void copyDartEmbedding(unsigned int orbit, Dart d, Dart e);

	/**
	 * Allocation of some place in attrib table
	 * @param orbit the orbit of embedding
	 * @return the index to use as embedding
	 */
	unsigned int newCell(unsigned int orbit);

	/**
	* 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
	*/
	void embedOrbit(unsigned int orbit, Dart d, unsigned int em);

	/**
	* Associate an new embedding to all darts of a vertex
	* @param orbit orbit to embed
	* @param d a dart of the topological cell
	* @return index of the attribute in table
	*/
	unsigned int embedNewCell(unsigned int orbit, Dart d);

	/**
	* Copy the cell associated to a dart over an other dart
	 * @param orbit attribute orbit to use
	* @param d the dart to overwrite (dest)
	* @param e the dart to copy (src)
	 */
	void copyCell(unsigned int orbit, Dart d, Dart e);

	/**
	 * 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
	 */
	void copyCell(unsigned int orbit, unsigned int i, unsigned int j);

	/**
	 * Line of attributes i is initialized
	 * @param orbit attribute orbit to use
	 * @param i line to init
	 */
	void initCell(unsigned int orbit, unsigned int i);

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

	/**
231
232
	 * get the attrib container of a given orbit
	 * @param orbit the orbit !!! (bilbo the orbit !)
Pierre Kraemer's avatar
Pierre Kraemer committed
233
	 */
234
	AttributeContainer& getAttributeContainer(unsigned int orbit);
Pierre Kraemer's avatar
Pierre Kraemer committed
235
236

	/**
237
	 * get a multi vector of marker attribute (direct access with [i])
Pierre Kraemer's avatar
Pierre Kraemer committed
238
239
	 * @param orbit code
	 */
240
	AttributeMultiVector<Mark>* getMarkerVector(unsigned int orbit, unsigned int thread = 0);
Pierre Kraemer's avatar
Pierre Kraemer committed
241
242

	/**
243
244
	 * 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
245
	 */
246
	AttributeMultiVector<unsigned int>* getEmbeddingAttributeVector(unsigned int orbit);
Pierre Kraemer's avatar
Pierre Kraemer committed
247
248

	/**
249
	 * swap two attribute containers
Pierre Kraemer's avatar
Pierre Kraemer committed
250
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
251
	void swapEmbeddingContainers(unsigned int orbit1, unsigned int orbit2);
Pierre Kraemer's avatar
Pierre Kraemer committed
252
253
254
255
256
257
258

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

259
260
261
262
263
	/**
	 * 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
	 */
	void initOrbitEmbedding(unsigned int orbit, bool realloc = false);
Pierre Kraemer's avatar
Pierre Kraemer committed
264
265
266
267
268
269
270
271
272
273
274

	/****************************************
	 *          MARKERS MANAGEMENT          *
	 ****************************************/
protected:
	/**
	 * get a new marker on cell
	 * \pre the orbit must be already embedded
	 * @param orbit the orbit of cell to use (xxx_ORBIT)
	 * @return the marker to use
	 */
275
	Marker getNewMarker(unsigned int cell = DART_ORBIT, unsigned int thread = 0);
Pierre Kraemer's avatar
Pierre Kraemer committed
276
277
278
279
280

	/**
	 * release a marker of cell.
	 * @param m the marker to release
	 */
281
	void releaseMarker(Marker m, unsigned int thread = 0);
Sylvain Thery's avatar
Sylvain Thery committed
282
283

	/****************************************
284
	 *          THREAD MANAGEMENT           *
Sylvain Thery's avatar
Sylvain Thery committed
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
	 ****************************************/
public:
	/**
	 * add  threads (a table of Marker per orbit for each thread)
	 * to allow MT
	 * @param nb thread to add
	 */
	void addThreadMarker(unsigned int nb);

	/**
	 * return allowed threads
	 * @return the number of threads (including principal)
	 */
	unsigned int getNbThreadMarkers();

	/**
	 *	Remove some added threads
	 * @return remaining number of threads (including principal)
	 */
	void removeThreadMarker(unsigned int nb);

Pierre Kraemer's avatar
Pierre Kraemer committed
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
	/****************************************
	 *             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
	 */
	bool chechXmlNode(xmlNodePtr node, const std::string& name);

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

	/**
	 * Save map in a XML file
	 * @param filename the file name
	 * @return true if OK
	 */
	bool saveMapXml(const std::string& filename, bool compress = false);

	 /**
	 * Load map from a XML file
	 * @param filename the file name
	 * @return true if OK
	 */
	bool loadMapXml(const std::string& filename, bool compress = false);

	/**
	 * Save map in a binary file
	 * @param filename the file name
	 * @return true if OK
	 */
	bool saveMapBin(const std::string& filename);

	/**
	 * Load map from a binary file
	 * @param filename the file name
	 * @return true if OK
	 */
	bool loadMapBin(const std::string& filename);

	/****************************************
	 *           DARTS TRAVERSALS           *
	 ****************************************/

	/**
	 * Begin of map
	 * @return the first dart of the map
	 */
	Dart begin();

	/**
	 * End of map
	 * @return the end iterator (next of last) of the map
	 */
	Dart end();

	/**
	 * allow to go from a dart to the next
	 * in the order of storage
	 * @param d reference to the dart to be modified
	 */
	void next(Dart& d);

	/**
	 * Apply a functor on each dart of the map
	 * @param f a ref to the functor obj
	 */
	bool foreach_dart(FunctorType& f, const FunctorSelect& good = SelectorTrue());

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

387
388
389
390
391
	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;
	virtual bool foreach_dart_of_face(Dart d, FunctorType& f, unsigned int thread = 0) = 0;
	virtual bool foreach_dart_of_volume(Dart d, FunctorType& f, unsigned int thread = 0) = 0;
	virtual bool foreach_dart_of_cc(Dart d, FunctorType& f, unsigned int thread = 0) = 0;
Pierre Kraemer's avatar
Pierre Kraemer committed
392
393
394
395
396
397
398

	/**
	* execute functor for each orbit
	* @param dim the dimension of the orbit
	* @param f the functor
	* @param good the selector of darts
	*/
399
	bool foreach_orbit(unsigned int orbit, FunctorType& f, const FunctorSelect& good = SelectorTrue(), unsigned int thread = 0);
Pierre Kraemer's avatar
Pierre Kraemer committed
400
401
402
403
404
405
406

	//! 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
	 */
	unsigned int getNbOrbits(unsigned int orbit, const FunctorSelect& good = SelectorTrue());
407

Pierre Kraemer's avatar
Pierre Kraemer committed
408
409
} ;

410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442


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_ORBIT: return f(d);
		case  VERTEX_ORBIT: return ptrMap->MAP::ParentMap::foreach_dart_of_vertex(d, f,thread);
		case  EDGE_ORBIT: return ptrMap->MAP::ParentMap::foreach_dart_of_edge(d, f,thread);
		case  FACE_ORBIT: return ptrMap->MAP::ParentMap::foreach_dart_of_face(d, f,thread);
		case  VOLUME_ORBIT: 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_ORBIT: return f(d);
		case  VERTEX_ORBIT: return ptrMap->MAP::ParentMap::ParentMap::foreach_dart_of_vertex(d, f,thread);
		case  EDGE_ORBIT: return ptrMap->MAP::ParentMap::ParentMap::foreach_dart_of_edge(d, f,thread);
		case  FACE_ORBIT: return ptrMap->MAP::ParentMap::ParentMap::foreach_dart_of_face(d, f,thread);
		case  VOLUME_ORBIT: return ptrMap->MAP::ParentMap::ParentMap::foreach_dart_of_volume(d, f, thread);
		default: assert(!"Cells of this dimension are not handled");
	}
	return false;
}


Pierre Kraemer's avatar
Pierre Kraemer committed
443
444
445
446
447
} //namespace CGoGN

#include "Topology/generic/genericmap.hpp"

#endif