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

#ifndef __GENERIC_MAP__
#define __GENERIC_MAP__

#include <iostream>
Sylvain Thery's avatar
Sylvain Thery committed
29
#include <string>
Pierre Kraemer's avatar
Pierre Kraemer committed
30 31 32 33 34 35
#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
//template<typename MAP, unsigned int CELL> class CellMarkerBase ;
52

53
class GenericMap
Pierre Kraemer's avatar
Pierre Kraemer committed
54
{
Pierre Kraemer's avatar
Pierre Kraemer committed
55 56 57 58 59 60
	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 ;
61
	friend class DartMarkerGen ;
Sylvain Thery's avatar
Sylvain Thery committed
62
	friend class CellMarkerGen ;
63
	template<typename MAP, unsigned int CELL> friend class CellMarkerBase ;
Pierre Kraemer's avatar
Pierre Kraemer committed
64 65 66 67 68

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

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

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

Pierre Kraemer's avatar
Pierre Kraemer committed
80 81 82 83 84
	/**
	 * Direct access to quick traversal attributes
	 * (initialized by enableQuickTraversal function)
	 */
	AttributeMultiVector<Dart>* m_quickTraversal[NB_ORBITS] ;
Sylvain Thery's avatar
Sylvain Thery committed
85 86 87
	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
88
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
89
	 * Marks manager
Pierre Kraemer's avatar
Pierre Kraemer committed
90
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
91
	MarkSet m_marksets[NB_ORBITS][NB_THREAD] ;
Pierre Kraemer's avatar
Pierre Kraemer committed
92 93 94 95

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Pierre Kraemer's avatar
Pierre Kraemer committed
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
public:
	virtual unsigned int getNbDarts() const = 0 ;

	/****************************************
	 *          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>
	bool foreach_dart_of_orbit(Dart d, FunctorType& f, unsigned int thread = 0) const ;

	virtual bool foreach_dart_of_vertex(Dart d, FunctorType& f, unsigned int thread = 0) const = 0 ;
	virtual bool foreach_dart_of_edge(Dart d, FunctorType& f, unsigned int thread = 0) const = 0 ;
	virtual bool foreach_dart_of_face(Dart /*d*/, FunctorType& /*f*/, unsigned int /*thread = 0*/) const { std::cerr << "Not implemented" << std::endl; return false; }
	virtual bool foreach_dart_of_volume(Dart /*d*/, FunctorType& /*f*/, unsigned /*int thread = 0*/) const { std::cerr << "Not implemented" << std::endl; return false; }
	virtual bool foreach_dart_of_cc(Dart /*d*/, FunctorType& /*f*/, unsigned int /*thread = 0*/) const { std::cerr << "Not implemented" << std::endl; return false; }

	virtual bool foreach_dart_of_vertex1(Dart /*d*/, FunctorType& /*f*/, unsigned int /*thread = 0*/) const { std::cerr << "Not implemented" << std::endl; return false; }
	virtual bool foreach_dart_of_edge1(Dart /*d*/, FunctorType& /*f*/, unsigned int /*thread = 0*/) const { std::cerr << "Not implemented" << std::endl; return false; }

	virtual bool foreach_dart_of_vertex2(Dart /*d*/, FunctorType& /*f*/, unsigned int /*thread = 0*/) const { std::cerr << "Not implemented" << std::endl; return false; }
	virtual bool foreach_dart_of_edge2(Dart /*d*/, FunctorType& /*f*/, unsigned int /*thread = 0*/) const { std::cerr << "Not implemented" << std::endl; return false; }
	virtual bool foreach_dart_of_face2(Dart /*d*/, FunctorType& /*f*/, unsigned int /*thread = 0*/) const { std::cerr << "Not implemented" << std::endl; return false; }

	/**
	 * @brief getNbOrbits
	 * @param orbit
	 * @return the number of orbits in the map
	 */
	virtual unsigned int getNbOrbits(unsigned int orbit) const = 0 ;

Pierre Kraemer's avatar
Pierre Kraemer committed
202 203 204
	/****************************************
	 *         EMBEDDING MANAGEMENT         *
	 ****************************************/
Pierre Kraemer's avatar
Pierre Kraemer committed
205

Pierre Kraemer's avatar
Pierre Kraemer committed
206 207 208
	/**
	 * tell if an orbit is embedded or not
	 */
209 210
	template <unsigned int ORBIT>
	bool isOrbitEmbedded() const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
211

212
	bool isOrbitEmbedded(unsigned int orbit) const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
213 214 215 216 217 218

	/**
	 * Allocation of some place in attrib table
	 * @param orbit the orbit of embedding
	 * @return the index to use as embedding
	 */
219 220
	template <unsigned int ORBIT>
	unsigned int newCell() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
221 222 223 224 225 226 227

	/**
	 * 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
	 */
228 229
	template <unsigned int ORBIT>
	void copyCell(unsigned int i, unsigned int j) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
230 231 232 233 234 235

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

Pierre Kraemer's avatar
Pierre Kraemer committed
239
	/****************************************
Pierre Kraemer's avatar
Pierre Kraemer committed
240
	 *   ATTRIBUTES CONTAINERS MANAGEMENT   *
Pierre Kraemer's avatar
Pierre Kraemer committed
241 242
	 ****************************************/

243 244 245 246 247 248
	/**
	 * 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
249
	/**
250 251
	 * get the attrib container of a given orbit
	 * @param orbit the orbit !!! (bilbo the orbit !)
Pierre Kraemer's avatar
Pierre Kraemer committed
252
	 */
253 254
	template <unsigned int ORBIT>
	AttributeContainer& getAttributeContainer() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
255

Sylvain Thery's avatar
Sylvain Thery committed
256 257 258
	template <unsigned int ORBIT>
	const AttributeContainer& getAttributeContainer() const;

Pierre Kraemer's avatar
Pierre Kraemer committed
259 260
	AttributeContainer& getAttributeContainer(unsigned int orbit) ;

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

Pierre Kraemer's avatar
Pierre Kraemer committed
263 264 265 266 267 268 269 270
	/**
	 * @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
271
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
272
	 * get a multi vector of mark attribute (direct access with [i])
Pierre Kraemer's avatar
Pierre Kraemer committed
273
	 */
274 275
	template <unsigned int ORBIT>
	AttributeMultiVector<Mark>* getMarkVector(unsigned int thread = 0) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
276 277

	/**
278 279
	 * 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
280
	 */
281 282
	template <unsigned int ORBIT>
	AttributeMultiVector<unsigned int>* getEmbeddingAttributeVector() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
283

untereiner's avatar
untereiner committed
284 285 286 287
	/**
	 * swap two attribute containers
	 */
	void swapEmbeddingContainers(unsigned int orbit1, unsigned int orbit2) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
288 289 290 291 292 293 294

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

Pierre Kraemer's avatar
Pierre Kraemer committed
295 296 297 298 299
	/**
	 * print attributes name of map in std::cout (for debugging)
	 */
	void viewAttributesTables() ;

300 301
	void printDartsTable();

Sylvain Thery's avatar
Sylvain Thery committed
302 303 304 305 306 307 308
protected:
	/****************************************
	 *   EMBEDDING ATTRIBUTES MANAGEMENT    *
	 ****************************************/
	/**
	 * Create the dart attribute to store the embedding of this orbit (for internal use only)
	 */
309 310
	template <unsigned int ORBIT>
	void addEmbedding() ;
Sylvain Thery's avatar
Sylvain Thery committed
311 312 313 314 315 316

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

	/**
317
	 * Add a topological relation in the map
Sylvain Thery's avatar
Sylvain Thery committed
318 319 320 321
	 * @param name name of relation
	 */
	AttributeMultiVector<Dart>* addRelation(const std::string& name) ;

Sylvain Thery's avatar
Sylvain Thery committed
322
	/**
Pierre Kraemer's avatar
merges  
Pierre Kraemer committed
323 324
	 * Get AttributeMultivector pointer of a relation attribute
	 * @param name name of the relation
Sylvain Thery's avatar
Sylvain Thery committed
325 326
	 * @return the attribute multi-vector pointer
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
327
	AttributeMultiVector<Dart>* getRelation(const std::string& name) ;
Sylvain Thery's avatar
Sylvain Thery committed
328

Sylvain Thery's avatar
Sylvain Thery committed
329
	/****************************************
330
	 *          THREAD MANAGEMENT           *
Sylvain Thery's avatar
Sylvain Thery committed
331 332 333
	 ****************************************/
public:
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
334
	 * add threads (a table of Marker per orbit for each thread)
Sylvain Thery's avatar
Sylvain Thery committed
335 336 337
	 * to allow MT
	 * @param nb thread to add
	 */
338
	void addThreadMarker(unsigned int nb) ;
Sylvain Thery's avatar
Sylvain Thery committed
339 340 341 342 343

	/**
	 * return allowed threads
	 * @return the number of threads (including principal)
	 */
344
	unsigned int getNbThreadMarkers() ;
Sylvain Thery's avatar
Sylvain Thery committed
345 346

	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
347
	 * Remove some added threads
Sylvain Thery's avatar
Sylvain Thery committed
348 349
	 * @return remaining number of threads (including principal)
	 */
350
	void removeThreadMarker(unsigned int nb) ;
Sylvain Thery's avatar
Sylvain Thery committed
351

Pierre Kraemer's avatar
Pierre Kraemer committed
352 353 354
	/****************************************
	 *             SAVE & LOAD              *
	 ****************************************/
Pierre Kraemer's avatar
Pierre Kraemer committed
355
protected:
Sylvain Thery's avatar
Sylvain Thery committed
356
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
357
	 * restore embedding / markers / quick traversal shortcuts
Sylvain Thery's avatar
Sylvain Thery committed
358
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
359
	void restore_shortcuts();
Sylvain Thery's avatar
Sylvain Thery committed
360

Pierre Kraemer's avatar
Pierre Kraemer committed
361
public:
Pierre Kraemer's avatar
Pierre Kraemer committed
362 363 364 365 366
	/**
	 * Save map in a binary file
	 * @param filename the file name
	 * @return true if OK
	 */
367
	virtual bool saveMapBin(const std::string& filename) const = 0;
Pierre Kraemer's avatar
Pierre Kraemer committed
368 369 370 371 372 373

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

376 377 378
	/**
	 * copy from another map (of same type)
	 */
379
	virtual bool copyFrom(const GenericMap& map) = 0 ;
380

Sylvain Thery's avatar
Sylvain Thery committed
381 382 383
	/**
	 * Dump attributes types and names per orbit
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
384
	void dumpAttributesAndMarkers() ;
Sylvain Thery's avatar
Sylvain Thery committed
385

Pierre Kraemer's avatar
Pierre Kraemer committed
386
protected:
387
	/**
388
	 * compact topo relations
389
	 */
390
	virtual void compactTopo() = 0 ;
391

Pierre Kraemer's avatar
Pierre Kraemer committed
392
public:
393 394 395
	/**
	 * compact the map
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
396
	void compact() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
397 398
} ;

399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430
//
//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 ;
//}
431

Pierre Kraemer's avatar
Pierre Kraemer committed
432 433 434 435 436
} //namespace CGoGN

#include "Topology/generic/genericmap.hpp"

#endif