genericmap.h 14.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"
Sylvain Thery's avatar
Sylvain Thery committed
39
#include "Container/fakeAttribute.h"
Pierre Kraemer's avatar
Pierre Kraemer committed
40

Pierre Kraemer's avatar
Pierre Kraemer committed
41 42 43 44 45 46 47
#include "Topology/generic/dart.h"
#include "Topology/generic/marker.h"
#include "Topology/generic/functor.h"

namespace CGoGN
{

48
class AttributeHandlerGen ;
49 50
class DartMarkerGen ;
class CellMarkerGen ;
51

52
class GenericMap
Pierre Kraemer's avatar
Pierre Kraemer committed
53
{
Pierre Kraemer's avatar
Pierre Kraemer committed
54 55 56 57 58 59
	template<typename T, unsigned int ORBIT, typename MAP> friend class AttributeHandler ;
	template<typename T, typename MAP> friend class DartAutoAttribute ;
	template<typename T, typename MAP> friend class VertexAutoAttribute ;
	template<typename T, typename MAP> friend class EdgeAutoAttribute ;
	template<typename T, typename MAP> friend class FaceAutoAttribute ;
	template<typename T, typename MAP> friend class VolumeAutoAttribute ;
60
	friend class DartMarkerGen ;
Sylvain Thery's avatar
Sylvain Thery committed
61
	friend class CellMarkerGen ;
62
	template<typename MAP, unsigned int CELL> friend class CellMarkerBase ;
Pierre Kraemer's avatar
Pierre Kraemer committed
63 64 65 66 67

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

70
	static std::map<std::string, RegisteredBaseAttribute*>* m_attributes_registry_map ;
71 72
	static int m_nbInstances;

Pierre Kraemer's avatar
Pierre Kraemer committed
73 74
	/**
	 * Direct access to the Dart attributes that store the orbits embeddings
75
	 * (only initialized when necessary, i.e. addEmbedding function)
Pierre Kraemer's avatar
Pierre Kraemer committed
76
	 */
77
	AttributeMultiVector<unsigned int>* m_embeddings[NB_ORBITS] ;
Pierre Kraemer's avatar
Pierre Kraemer committed
78

Pierre Kraemer's avatar
Pierre Kraemer committed
79 80 81 82 83
	/**
	 * Direct access to quick traversal attributes
	 * (initialized by enableQuickTraversal function)
	 */
	AttributeMultiVector<Dart>* m_quickTraversal[NB_ORBITS] ;
Sylvain Thery's avatar
Sylvain Thery committed
84 85 86
	AttributeMultiVector<NoTypeNameAttribute<std::vector<Dart> > >* m_quickLocalIncidentTraversal[NB_ORBITS][NB_ORBITS] ;
	AttributeMultiVector<NoTypeNameAttribute<std::vector<Dart> > >* m_quickLocalAdjacentTraversal[NB_ORBITS][NB_ORBITS] ;

Pierre Kraemer's avatar
Pierre Kraemer committed
87
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
88
	 * Marks manager
Pierre Kraemer's avatar
Pierre Kraemer committed
89
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
90
	MarkSet m_marksets[NB_ORBITS][NB_THREAD] ;
Pierre Kraemer's avatar
Pierre Kraemer committed
91 92 93 94

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

Pierre Kraemer's avatar
Pierre Kraemer committed
97 98 99 100 101
	/**
	 * Reserved boundary markers
	 */
	Mark m_boundaryMarkers[2] ; // 0 for dim 2 / 1 for dim 3

102
	unsigned int m_nbThreads ;
Sylvain Thery's avatar
Sylvain Thery committed
103

104 105 106
	/**
	 * Store links to created AttributeHandlers, DartMarkers and CellMarkers
	 */
107
	std::multimap<AttributeMultiVectorGen*, AttributeHandlerGen*> attributeHandlers ; // TODO think of MT (AttributeHandler creation & release are not thread safe!)
108 109
	boost::mutex attributeHandlersMutex;

110 111 112
	std::vector<DartMarkerGen*> dartMarkers[NB_THREAD] ;
	std::vector<CellMarkerGen*> cellMarkers[NB_THREAD] ;

Pierre Kraemer's avatar
Pierre Kraemer committed
113
public:
114
	static const unsigned int UNKNOWN_ATTRIB = AttributeContainer::UNKNOWN ;
Pierre Kraemer's avatar
Pierre Kraemer committed
115

116
	GenericMap() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
117

Sylvain Thery's avatar
Sylvain Thery committed
118
	virtual ~GenericMap() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
119

Pierre Kraemer's avatar
Pierre Kraemer committed
120 121 122 123
protected:
	void init();

public:
124
	virtual std::string mapTypeName() const = 0 ;
125

126 127
	virtual unsigned int dimension() const = 0 ;

128 129 130 131 132 133 134
	/**
	 * 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
135

Sylvain Thery's avatar
Sylvain Thery committed
136 137 138
	/**
	 * get the marker_set of an orbit and thread (used for Cell & Dart Marker)
	 */
139 140
	template <unsigned int ORBIT>
	MarkSet& getMarkerSet(unsigned int thread = 0) { return m_marksets[ORBIT][thread]; }
Sylvain Thery's avatar
Sylvain Thery committed
141

Pierre Kraemer's avatar
Pierre Kraemer committed
142 143 144 145 146 147 148
	/****************************************
	 *           DARTS MANAGEMENT           *
	 ****************************************/
protected:
	/**
	 * Add a dart to the map
	 */
149
	virtual Dart newDart() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
150 151 152 153

	/**
	 * Erase a dart of the map
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
154
	virtual void deleteDart(Dart d) = 0 ;
Pierre Kraemer's avatar
Pierre Kraemer committed
155

156 157 158
	/**
	 * 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
159
	unsigned int copyDartLine(unsigned int index) ;
160

Pierre Kraemer's avatar
Pierre Kraemer committed
161 162
	/**
	 * Properly deletes a dart in m_attribs[DART]
Pierre Kraemer's avatar
Pierre Kraemer committed
163 164 165
	 */
	void deleteDartLine(unsigned int index) ;

Pierre Kraemer's avatar
Pierre Kraemer committed
166 167 168 169 170 171 172 173 174 175 176
public:
	/****************************************
	 *          ORBITS TRAVERSALS           *
	 ****************************************/

	//! 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
	 */
	template <unsigned int ORBIT>
177
	void foreach_dart_of_orbit(Dart d, std::function<void (Dart)> f, unsigned int thread = 0) const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
178

179 180 181 182 183
	virtual void foreach_dart_of_vertex(Dart /*d*/, std::function<void (Dart)> /*f*/, unsigned int /*thread = 0*/) const { std::cerr << "Not implemented" << std::endl; }
	virtual void foreach_dart_of_edge(Dart /*d*/, std::function<void (Dart)> /*f*/, unsigned int /*thread = 0*/) const { std::cerr << "Not implemented" << std::endl; }
	virtual void foreach_dart_of_face(Dart /*d*/, std::function<void (Dart)> /*f*/, unsigned int /*thread = 0*/) const { std::cerr << "Not implemented" << std::endl; }
	virtual void foreach_dart_of_volume(Dart /*d*/, std::function<void (Dart)> /*f*/, unsigned int /*thread = 0*/) const { std::cerr << "Not implemented" << std::endl; }
	virtual void foreach_dart_of_cc(Dart /*d*/, std::function<void (Dart)> /*f*/, unsigned int /*thread = 0*/) const { std::cerr << "Not implemented" << std::endl; }
Pierre Kraemer's avatar
Pierre Kraemer committed
184

185 186
	virtual void foreach_dart_of_vertex1(Dart /*d*/, std::function<void (Dart)> /*f*/, unsigned int /*thread = 0*/) const { std::cerr << "Not implemented" << std::endl; }
	virtual void foreach_dart_of_edge1(Dart /*d*/, std::function<void (Dart)> /*f*/, unsigned int /*thread = 0*/) const { std::cerr << "Not implemented" << std::endl; }
Pierre Kraemer's avatar
Pierre Kraemer committed
187

188 189 190
	virtual void foreach_dart_of_vertex2(Dart /*d*/, std::function<void (Dart)> /*f*/, unsigned int /*thread = 0*/) const { std::cerr << "Not implemented" << std::endl; }
	virtual void foreach_dart_of_edge2(Dart /*d*/, std::function<void (Dart)> /*f*/, unsigned int /*thread = 0*/) const { std::cerr << "Not implemented" << std::endl; }
	virtual void foreach_dart_of_face2(Dart /*d*/, std::function<void (Dart)> /*f*/, unsigned int /*thread = 0*/) const { std::cerr << "Not implemented" << std::endl; }
Pierre Kraemer's avatar
Pierre Kraemer committed
191

Pierre Kraemer's avatar
Pierre Kraemer committed
192 193 194
	/****************************************
	 *         EMBEDDING MANAGEMENT         *
	 ****************************************/
Pierre Kraemer's avatar
Pierre Kraemer committed
195

Pierre Kraemer's avatar
Pierre Kraemer committed
196 197 198
	/**
	 * tell if an orbit is embedded or not
	 */
199 200
	template <unsigned int ORBIT>
	bool isOrbitEmbedded() const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
201

202
	bool isOrbitEmbedded(unsigned int orbit) const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
203 204 205 206 207 208

	/**
	 * Allocation of some place in attrib table
	 * @param orbit the orbit of embedding
	 * @return the index to use as embedding
	 */
209 210
	template <unsigned int ORBIT>
	unsigned int newCell() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
211 212 213 214 215 216 217

	/**
	 * 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
	 */
218 219
	template <unsigned int ORBIT>
	void copyCell(unsigned int i, unsigned int j) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
220 221 222 223 224 225

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

Pierre Kraemer's avatar
Pierre Kraemer committed
229
	/****************************************
Pierre Kraemer's avatar
Pierre Kraemer committed
230
	 *   ATTRIBUTES CONTAINERS MANAGEMENT   *
Pierre Kraemer's avatar
Pierre Kraemer committed
231 232
	 ****************************************/

233 234 235 236 237 238
	/**
	 * get the number of cell in the attribute container of an orbit
	 * @param orb the orbit to get number of cells
	 */
	unsigned int getNbCells(unsigned int orbit);

Pierre Kraemer's avatar
Pierre Kraemer committed
239
	/**
240 241
	 * get the attrib container of a given orbit
	 * @param orbit the orbit !!! (bilbo the orbit !)
Pierre Kraemer's avatar
Pierre Kraemer committed
242
	 */
243 244
	template <unsigned int ORBIT>
	AttributeContainer& getAttributeContainer() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
245

Sylvain Thery's avatar
Sylvain Thery committed
246 247 248
	template <unsigned int ORBIT>
	const AttributeContainer& getAttributeContainer() const;

Pierre Kraemer's avatar
Pierre Kraemer committed
249 250
	AttributeContainer& getAttributeContainer(unsigned int orbit) ;

Sylvain Thery's avatar
Sylvain Thery committed
251 252
	const AttributeContainer& getAttributeContainer(unsigned int orbit) const;

Pierre Kraemer's avatar
Pierre Kraemer committed
253 254 255 256 257 258 259 260
	/**
	 * @brief get a generic pointer to an existing attribute multi vector
	 * @param orbit the concerned orbit
	 * @param nameAttr attribute name
	 * @return a pointer to an AttributeMultiVectorGen
	 */
	inline AttributeMultiVectorGen* getAttributeVectorGen(unsigned int orbit, const std::string& nameAttr) ;

Pierre Kraemer's avatar
Pierre Kraemer committed
261
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
262
	 * get a multi vector of mark attribute (direct access with [i])
Pierre Kraemer's avatar
Pierre Kraemer committed
263
	 */
264 265
	template <unsigned int ORBIT>
	AttributeMultiVector<Mark>* getMarkVector(unsigned int thread = 0) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
266 267

	/**
268 269
	 * 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
270
	 */
271 272
	template <unsigned int ORBIT>
	AttributeMultiVector<unsigned int>* getEmbeddingAttributeVector() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
273

untereiner's avatar
untereiner committed
274 275 276 277
	/**
	 * swap two attribute containers
	 */
	void swapEmbeddingContainers(unsigned int orbit1, unsigned int orbit2) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
278 279 280 281 282 283 284

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

Pierre Kraemer's avatar
Pierre Kraemer committed
285 286 287 288 289
	/**
	 * print attributes name of map in std::cout (for debugging)
	 */
	void viewAttributesTables() ;

290 291
	void printDartsTable();

Sylvain Thery's avatar
Sylvain Thery committed
292 293 294 295 296 297
	/****************************************
	 *   EMBEDDING ATTRIBUTES MANAGEMENT    *
	 ****************************************/
	/**
	 * Create the dart attribute to store the embedding of this orbit (for internal use only)
	 */
298 299
	template <unsigned int ORBIT>
	void addEmbedding() ;
Sylvain Thery's avatar
Sylvain Thery committed
300

301
protected:
Sylvain Thery's avatar
Sylvain Thery committed
302 303 304 305 306
	/****************************************
	 *  TOPOLOGICAL ATTRIBUTES MANAGEMENT   *
	 ****************************************/

	/**
307
	 * Add a topological relation in the map
Sylvain Thery's avatar
Sylvain Thery committed
308 309 310 311
	 * @param name name of relation
	 */
	AttributeMultiVector<Dart>* addRelation(const std::string& name) ;

Sylvain Thery's avatar
Sylvain Thery committed
312
	/**
Pierre Kraemer's avatar
merges  
Pierre Kraemer committed
313 314
	 * Get AttributeMultivector pointer of a relation attribute
	 * @param name name of the relation
Sylvain Thery's avatar
Sylvain Thery committed
315 316
	 * @return the attribute multi-vector pointer
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
317
	AttributeMultiVector<Dart>* getRelation(const std::string& name) ;
Sylvain Thery's avatar
Sylvain Thery committed
318

Sylvain Thery's avatar
Sylvain Thery committed
319
	/****************************************
320
	 *          THREAD MANAGEMENT           *
Sylvain Thery's avatar
Sylvain Thery committed
321 322 323
	 ****************************************/
public:
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
324
	 * add threads (a table of Marker per orbit for each thread)
Sylvain Thery's avatar
Sylvain Thery committed
325 326 327
	 * to allow MT
	 * @param nb thread to add
	 */
328
	void addThreadMarker(unsigned int nb) ;
Sylvain Thery's avatar
Sylvain Thery committed
329 330 331 332 333

	/**
	 * return allowed threads
	 * @return the number of threads (including principal)
	 */
334
	unsigned int getNbThreadMarkers() ;
Sylvain Thery's avatar
Sylvain Thery committed
335 336

	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
337
	 * Remove some added threads
Sylvain Thery's avatar
Sylvain Thery committed
338 339
	 * @return remaining number of threads (including principal)
	 */
340
	void removeThreadMarker(unsigned int nb) ;
Sylvain Thery's avatar
Sylvain Thery committed
341

Pierre Kraemer's avatar
Pierre Kraemer committed
342 343 344
	/****************************************
	 *             SAVE & LOAD              *
	 ****************************************/
Pierre Kraemer's avatar
Pierre Kraemer committed
345
protected:
Sylvain Thery's avatar
Sylvain Thery committed
346
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
347
	 * restore embedding / markers / quick traversal shortcuts
Sylvain Thery's avatar
Sylvain Thery committed
348
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
349
	void restore_shortcuts();
Sylvain Thery's avatar
Sylvain Thery committed
350

Pierre Kraemer's avatar
Pierre Kraemer committed
351
public:
Pierre Kraemer's avatar
Pierre Kraemer committed
352 353 354 355 356
	/**
	 * Save map in a binary file
	 * @param filename the file name
	 * @return true if OK
	 */
357
	virtual bool saveMapBin(const std::string& filename) const = 0;
Pierre Kraemer's avatar
Pierre Kraemer committed
358 359 360 361 362 363

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

366 367 368
	/**
	 * copy from another map (of same type)
	 */
369
	virtual bool copyFrom(const GenericMap& map) = 0 ;
370

Sylvain Thery's avatar
Sylvain Thery committed
371 372 373
	/**
	 * Dump attributes types and names per orbit
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
374
	void dumpAttributesAndMarkers() ;
Sylvain Thery's avatar
Sylvain Thery committed
375

Pierre Kraemer's avatar
Pierre Kraemer committed
376
protected:
377
	/**
378
	 * compact topo relations
379
	 */
380
	virtual void compactTopo() = 0 ;
381

Pierre Kraemer's avatar
Pierre Kraemer committed
382
public:
383 384 385
	/**
	 * compact the map
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
386
	void compact() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
387 388
} ;

389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420
//
//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 ;
//}
421

Pierre Kraemer's avatar
Pierre Kraemer committed
422 423 424 425 426
} //namespace CGoGN

#include "Topology/generic/genericmap.hpp"

#endif