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

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

Sylvain Thery's avatar
Sylvain Thery committed
45 46
#include <thread>
#include <mutex>
Sylvain Thery's avatar
Sylvain Thery committed
47

Sylvain Thery's avatar
Sylvain Thery committed
48
#include "Topology/dll.h"
Sylvain Thery's avatar
Sylvain Thery committed
49 50


Pierre Kraemer's avatar
Pierre Kraemer committed
51 52 53
namespace CGoGN
{

Sylvain Thery's avatar
Sylvain Thery committed
54 55 56 57 58
namespace Parallel
{
/**
 * @brief Number of threads used for // traversal foreach
 */
Sylvain Thery's avatar
Sylvain Thery committed
59
CGoGN_TOPO_API extern int NumberOfThreads;
Sylvain Thery's avatar
Sylvain Thery committed
60 61 62 63 64 65 66 67 68

/**
 * @brief get number of cores of computer (threads, /2 if hyperthreading)
 * @param hyperthreading
 * @return nb of core
 */
inline int getSystemNumberOfCores(bool hyperthreading=false)
{
	if (hyperthreading)
Sylvain Thery's avatar
Sylvain Thery committed
69 70
		return std::thread::hardware_concurrency()/2;
	return std::thread::hardware_concurrency();
Sylvain Thery's avatar
Sylvain Thery committed
71 72 73 74
}

}

75 76 77 78 79 80 81 82 83 84 85
// forward
class GenericMap;

// classs that store static pointer for copy in schnapps plugins
struct StaticPointers
{
	std::map<std::string, RegisteredBaseAttribute*>* att_registry;
	std::vector<GenericMap*>* instances;
	std::vector< std::vector<Dart>* >* vdartsBuffers;
	std::vector< std::vector<unsigned int>* >* vintsBuffers;
};
Sylvain Thery's avatar
Sylvain Thery committed
86

87
class AttributeHandlerGen ;
88 89
class DartMarkerGen ;
class CellMarkerGen ;
Sylvain Thery's avatar
Sylvain Thery committed
90
class MapManipulator;
91

Sylvain Thery's avatar
Sylvain Thery committed
92
class CGoGN_TOPO_API GenericMap
Pierre Kraemer's avatar
Pierre Kraemer committed
93
{
Pierre Kraemer's avatar
Pierre Kraemer committed
94 95 96 97 98 99
	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 ;
Sylvain Thery's avatar
Sylvain Thery committed
100 101 102
//	friend class DartMarkerGen ;
//	friend class CellMarkerGen ;
//	template<typename MAP, unsigned int CELL> friend class CellMarkerBase ;
Pierre Kraemer's avatar
Pierre Kraemer committed
103 104

protected:
105 106 107
	// protected copy constructor to prevent the copy of map
	GenericMap(const GenericMap& ) {}

Sylvain Thery's avatar
Sylvain Thery committed
108 109 110 111 112 113 114 115 116

	/**
	 *
	 */
	std::vector<std::thread::id> m_thread_ids;
public:
	/// compute thread index in the table of thread
	inline unsigned int getCurrentThreadIndex() const;

Sylvain Thery's avatar
Sylvain Thery committed
117 118
	/// add place for n new threads in the table of thread return index of first
	inline unsigned int addEmptyThreadIds(unsigned int n);
Sylvain Thery's avatar
Sylvain Thery committed
119 120 121 122

	/// remove  the n last added threads from table
	inline void popThreadIds(unsigned int nb);

Sylvain Thery's avatar
Sylvain Thery committed
123 124 125
	/// get ref to jth threadId for updating (in thread)
	inline std::thread::id& getThreadId(unsigned int j);

Sylvain Thery's avatar
Sylvain Thery committed
126 127

protected:
Pierre Kraemer's avatar
Pierre Kraemer committed
128 129 130
	/**
	 * Attributes Containers
	 */
131
	AttributeContainer m_attribs[NB_ORBITS] ;
Pierre Kraemer's avatar
Pierre Kraemer committed
132

133
	static std::map<std::string, RegisteredBaseAttribute*>* m_attributes_registry_map;
134

Sylvain Thery's avatar
Sylvain Thery committed
135
	/// buffer for less memory allocation
136 137 138
	static  std::vector< std::vector<Dart>* >* s_vdartsBuffers;
	static  std::vector< std::vector<unsigned int>* >* s_vintsBuffers;

139
public:
Sylvain Thery's avatar
Sylvain Thery committed
140
	/// table of instancied maps for Dart/CellMarker release
141
	static std::vector<GenericMap*>* s_instances;
142
protected:
Sylvain Thery's avatar
Sylvain Thery committed
143

Pierre Kraemer's avatar
Pierre Kraemer committed
144 145
	/**
	 * Direct access to the Dart attributes that store the orbits embeddings
146
	 * (only initialized when necessary, i.e. addEmbedding function)
Pierre Kraemer's avatar
Pierre Kraemer committed
147
	 */
148
	AttributeMultiVector<unsigned int>* m_embeddings[NB_ORBITS] ;
Pierre Kraemer's avatar
Pierre Kraemer committed
149

Pierre Kraemer's avatar
Pierre Kraemer committed
150 151 152 153 154
	/**
	 * Direct access to quick traversal attributes
	 * (initialized by enableQuickTraversal function)
	 */
	AttributeMultiVector<Dart>* m_quickTraversal[NB_ORBITS] ;
Sylvain Thery's avatar
Sylvain Thery committed
155 156 157
	AttributeMultiVector<NoTypeNameAttribute<std::vector<Dart> > >* m_quickLocalIncidentTraversal[NB_ORBITS][NB_ORBITS] ;
	AttributeMultiVector<NoTypeNameAttribute<std::vector<Dart> > >* m_quickLocalAdjacentTraversal[NB_ORBITS][NB_ORBITS] ;

Sylvain Thery's avatar
Sylvain Thery committed
158
	std::vector< AttributeMultiVector<MarkerBool>* > m_markVectors_free[NB_ORBITS][NB_THREAD] ;
Sylvain Thery's avatar
Sylvain Thery committed
159
	std::mutex m_MarkerStorageMutex[NB_ORBITS];
160

161 162
	unsigned int m_nextMarkerId;

Pierre Kraemer's avatar
Pierre Kraemer committed
163 164 165
	/**
	 * Reserved boundary markers
	 */
Sylvain Thery's avatar
Sylvain Thery committed
166
	AttributeMultiVector<MarkerBool>* m_boundaryMarkers[2];
Sylvain Thery's avatar
Sylvain Thery committed
167

168
	/**
Sylvain Thery's avatar
Sylvain Thery committed
169
	 * Store links to created AttributeHandlers
170
	 */
Sylvain Thery's avatar
Sylvain Thery committed
171
	std::multimap<AttributeMultiVectorGen*, AttributeHandlerGen*> attributeHandlers ;
Sylvain Thery's avatar
Sylvain Thery committed
172
	std::mutex attributeHandlersMutex;
173

Pierre Kraemer's avatar
Pierre Kraemer committed
174
public:
175
	static const unsigned int UNKNOWN_ATTRIB = AttributeContainer::UNKNOWN ;
Pierre Kraemer's avatar
Pierre Kraemer committed
176

177 178 179 180 181 182
	/// copy all static pointers: use in SCHNApps only
	static void copyAllStatics(const StaticPointers& sp);

	/// init all static and store in sp (if not null) : use in SCHNApps only
	static void initAllStatics(StaticPointers* sp);

183
	GenericMap() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
184

Sylvain Thery's avatar
Sylvain Thery committed
185
	virtual ~GenericMap() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
186

187 188
	static inline bool alive(GenericMap* map)
	{
189 190
		for (auto it=s_instances->begin(); it != s_instances->end(); ++it)
		{
191 192
			if (*it == map)
				return true;
193
		}
194 195 196
		return false;
	}

Sylvain Thery's avatar
Sylvain Thery committed
197 198
	inline std::vector<Dart>* askDartBuffer() const;
	inline void releaseDartBuffer(std::vector<Dart>* vd) const;
Sylvain Thery's avatar
Sylvain Thery committed
199

Sylvain Thery's avatar
Sylvain Thery committed
200 201
	inline std::vector<unsigned int>* askUIntBuffer() const;
	inline void releaseUIntBuffer(std::vector<unsigned int>* vd) const;
Sylvain Thery's avatar
Sylvain Thery committed
202

Pierre Kraemer's avatar
Pierre Kraemer committed
203
protected:
204
	void init(bool addBoundaryMarkers=true);
Pierre Kraemer's avatar
Pierre Kraemer committed
205 206

public:
207
	virtual std::string mapTypeName() const = 0 ;
208

209 210
	virtual unsigned int dimension() const = 0 ;

211 212 213 214 215 216 217
	/**
	 * 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
218

Sylvain Thery's avatar
Sylvain Thery committed
219

Sylvain Thery's avatar
Sylvain Thery committed
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
	/****************************************
	 *     MANIPULATOR MANAGEMENT           *
	 ****************************************/
protected:
	/// manipulator pointer to Manipulator object that currently work on map
	MapManipulator* m_manipulator;

public:
	/**
	 * @brief ask for associating manipulator to the map
	 * @param ptr Manipulator ptr
	 * @return ok or not
	 */
	bool askManipulate(MapManipulator* ptr);

	/**
	 * @brief release the map from manipulator
	 * @param ptr manipulator asking for release
	 * @return ok or not
	 */
	bool releaseManipulate(MapManipulator* ptr);

	/**
	 * @brief get the manipulator
	 * @return manipulator ptr
	 */
	MapManipulator* getManipulator();

Pierre Kraemer's avatar
Pierre Kraemer committed
248 249 250 251 252 253 254
	/****************************************
	 *           DARTS MANAGEMENT           *
	 ****************************************/
protected:
	/**
	 * Add a dart to the map
	 */
255
	virtual Dart newDart() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
256 257 258 259

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

262 263 264
	/**
	 * 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
265
	unsigned int copyDartLine(unsigned int index) ;
266

Pierre Kraemer's avatar
Pierre Kraemer committed
267 268
	/**
	 * Properly deletes a dart in m_attribs[DART]
Pierre Kraemer's avatar
Pierre Kraemer committed
269 270 271
	 */
	void deleteDartLine(unsigned int index) ;

Pierre Kraemer's avatar
Pierre Kraemer committed
272 273 274 275 276
public:
	/****************************************
	 *          ORBITS TRAVERSALS           *
	 ****************************************/

277 278 279 280 281
//	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
282

283 284
//	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
285

286 287 288
//	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
289

Pierre Kraemer's avatar
Pierre Kraemer committed
290 291 292
	/****************************************
	 *         EMBEDDING MANAGEMENT         *
	 ****************************************/
Pierre Kraemer's avatar
Pierre Kraemer committed
293

Pierre Kraemer's avatar
Pierre Kraemer committed
294 295 296
	/**
	 * tell if an orbit is embedded or not
	 */
297 298
	template <unsigned int ORBIT>
	bool isOrbitEmbedded() const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
299

300
	bool isOrbitEmbedded(unsigned int orbit) const ;
Pierre Kraemer's avatar
Pierre Kraemer committed
301 302 303 304 305 306

	/**
	 * Allocation of some place in attrib table
	 * @param orbit the orbit of embedding
	 * @return the index to use as embedding
	 */
307 308
	template <unsigned int ORBIT>
	unsigned int newCell() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
309 310 311 312 313 314 315

	/**
	 * 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
	 */
316 317
	template <unsigned int ORBIT>
	void copyCell(unsigned int i, unsigned int j) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
318 319 320 321 322 323

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

Pierre Kraemer's avatar
Pierre Kraemer committed
327
	/****************************************
Pierre Kraemer's avatar
Pierre Kraemer committed
328
	 *   ATTRIBUTES CONTAINERS MANAGEMENT   *
Pierre Kraemer's avatar
Pierre Kraemer committed
329 330
	 ****************************************/

331 332 333 334 335 336
	/**
	 * 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
337
	/**
338 339
	 * get the attrib container of a given orbit
	 * @param orbit the orbit !!! (bilbo the orbit !)
Pierre Kraemer's avatar
Pierre Kraemer committed
340
	 */
341 342
	template <unsigned int ORBIT>
	AttributeContainer& getAttributeContainer() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
343

Sylvain Thery's avatar
Sylvain Thery committed
344 345 346
	template <unsigned int ORBIT>
	const AttributeContainer& getAttributeContainer() const;

Pierre Kraemer's avatar
Pierre Kraemer committed
347 348
	AttributeContainer& getAttributeContainer(unsigned int orbit) ;

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

Pierre Kraemer's avatar
Pierre Kraemer committed
351 352 353 354 355 356 357 358
	/**
	 * @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
359
	/**
Sylvain Thery's avatar
Sylvain Thery committed
360 361 362
	 * @brief ask for a marker attribute
	 */
	template <unsigned int ORBIT>
Sylvain Thery's avatar
Sylvain Thery committed
363
	AttributeMultiVector<MarkerBool>* askMarkVector() ;
Sylvain Thery's avatar
Sylvain Thery committed
364 365 366

	/**
	 * @brief release allocated marker attribute
Pierre Kraemer's avatar
Pierre Kraemer committed
367
	 */
368
	template <unsigned int ORBIT>
Sylvain Thery's avatar
Sylvain Thery committed
369
	void releaseMarkVector(AttributeMultiVector<MarkerBool>* amv);
Sylvain Thery's avatar
Sylvain Thery committed
370

Sylvain Thery's avatar
Sylvain Thery committed
371 372 373 374 375 376 377 378 379 380 381
protected:
	/**
	 * @brief scan attributes for MarkerBool, clean them and store as free in thread 0
	 */
	void garbageMarkVectors();

	/**
	 * @brief scan attributes for MarkerBool and remove them
	 */
	void removeMarkVectors();
public:
Pierre Kraemer's avatar
Pierre Kraemer committed
382 383

	/**
384 385
	 * 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
386
	 */
387 388
	template <unsigned int ORBIT>
	AttributeMultiVector<unsigned int>* getEmbeddingAttributeVector() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
389

untereiner's avatar
untereiner committed
390 391 392 393
	/**
	 * swap two attribute containers
	 */
	void swapEmbeddingContainers(unsigned int orbit1, unsigned int orbit2) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
394 395 396 397 398 399 400

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

Pierre Kraemer's avatar
Pierre Kraemer committed
401 402 403 404 405
	/**
	 * print attributes name of map in std::cout (for debugging)
	 */
	void viewAttributesTables() ;

406 407
	void printDartsTable();

Sylvain Thery's avatar
Sylvain Thery committed
408 409 410 411 412 413
	/****************************************
	 *   EMBEDDING ATTRIBUTES MANAGEMENT    *
	 ****************************************/
	/**
	 * Create the dart attribute to store the embedding of this orbit (for internal use only)
	 */
414 415
	template <unsigned int ORBIT>
	void addEmbedding() ;
Sylvain Thery's avatar
Sylvain Thery committed
416

417
protected:
Sylvain Thery's avatar
Sylvain Thery committed
418 419 420 421 422
	/****************************************
	 *  TOPOLOGICAL ATTRIBUTES MANAGEMENT   *
	 ****************************************/

	/**
423
	 * Add a topological relation in the map
Sylvain Thery's avatar
Sylvain Thery committed
424 425 426 427
	 * @param name name of relation
	 */
	AttributeMultiVector<Dart>* addRelation(const std::string& name) ;

Sylvain Thery's avatar
Sylvain Thery committed
428
	/**
Pierre Kraemer's avatar
merges  
Pierre Kraemer committed
429 430
	 * Get AttributeMultivector pointer of a relation attribute
	 * @param name name of the relation
Sylvain Thery's avatar
Sylvain Thery committed
431 432
	 * @return the attribute multi-vector pointer
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
433
	AttributeMultiVector<Dart>* getRelation(const std::string& name) ;
Sylvain Thery's avatar
Sylvain Thery committed
434

Pierre Kraemer's avatar
Pierre Kraemer committed
435 436 437
	/****************************************
	 *             SAVE & LOAD              *
	 ****************************************/
Pierre Kraemer's avatar
Pierre Kraemer committed
438
protected:
Sylvain Thery's avatar
Sylvain Thery committed
439
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
440
	 * restore embedding / markers / quick traversal shortcuts
Sylvain Thery's avatar
Sylvain Thery committed
441
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
442
	void restore_shortcuts();
Sylvain Thery's avatar
Sylvain Thery committed
443

Pierre Kraemer's avatar
Pierre Kraemer committed
444
public:
Pierre Kraemer's avatar
Pierre Kraemer committed
445 446 447 448 449
	/**
	 * Save map in a binary file
	 * @param filename the file name
	 * @return true if OK
	 */
450
	virtual bool saveMapBin(const std::string& filename) const = 0;
Pierre Kraemer's avatar
Pierre Kraemer committed
451 452 453 454 455 456

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

459 460 461
	/**
	 * copy from another map (of same type)
	 */
462
	virtual bool copyFrom(const GenericMap& map) = 0 ;
463

Sylvain Thery's avatar
Sylvain Thery committed
464 465 466
	/**
	 * Dump attributes types and names per orbit
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
467
	void dumpAttributesAndMarkers() ;
Sylvain Thery's avatar
Sylvain Thery committed
468

Pierre Kraemer's avatar
Pierre Kraemer committed
469
protected:
470
	/**
471
	 * compact topo relations
472
	 */
473
	virtual void compactTopo() = 0 ;
474

Pierre Kraemer's avatar
Pierre Kraemer committed
475
public:
476 477
	/**
	 * compact the map
Sylvain Thery's avatar
Sylvain Thery committed
478
	 * @warning the quickTraversals needs to be updated
Sylvain Thery's avatar
Sylvain Thery committed
479
	 * @param topoOnly compact only the topo ?
480
	 */
Sylvain Thery's avatar
Sylvain Thery committed
481 482 483
	void compact(bool topoOnly = false) ;


Sylvain Thery's avatar
Sylvain Thery committed
484 485 486 487 488 489 490 491 492 493 494 495 496 497 498
	/**
	 * compact a container (and update embedding attribute of topo)
	 * @param orbit orbit of container to compact
	 * @param frag minimum fragmentation value for compacting (default value 1.0 mean always compact)s
	 */
	void compactOrbitContainer(unsigned int orbit, float frag=1.0);

	/**
	 * @brief compact if containers are fragmented.
	 * @warning the quickTraversals needs to be updated
	 * @param frag if fragmentation (filling) of containers inferior to frag then compact
	 * @param topoOnly compact only the topo ?
	 */
	void compactIfNeeded(float frag, bool topoOnly = false) ;

Sylvain Thery's avatar
Sylvain Thery committed
499 500
	/**
	 * test if containers are fragmented
Sylvain Thery's avatar
Sylvain Thery committed
501 502
	 *  ~1.0 (full filled) no need to compact
	 *  ~0.0 (lots of holes) need to compact
Sylvain Thery's avatar
Sylvain Thery committed
503 504
	 */
	inline float fragmentation(unsigned int orbit);
505 506 507 508

	/**
	 * @brief dump all attributes of map in CSV format  (; separated columns)
	 */
Sylvain Thery's avatar
Sylvain Thery committed
509
	virtual void dumpCSV() const;
Sylvain Thery's avatar
Sylvain Thery committed
510 511 512 513 514 515 516

public:
	/**
	 * @brief move data (container && shortcuts from a map to this map
	 * @param mapf map from which data are moved);
	 */
	void moveData(GenericMap &mapf);
Pierre Kraemer's avatar
Pierre Kraemer committed
517 518
} ;

Sylvain Thery's avatar
Sylvain Thery committed
519

Sylvain Thery's avatar
Sylvain Thery committed
520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547
// DartBufferThread class that hide the usage of askDartBuffer & releaseDartBuffer
// scope of DartBuffer declaration use for auto release;
// typical usage:
//    DartBuffer buff(thread)
//    std::vector<DART>& vd=buff.vector();
//    vd.push_back(..)
//    ....

//class DartsBufferThread
//{
//protected:
//	std::vector<Dart>* m_vd;
//public:
//	inline DartsBufferThread()
//	{
//		m_vd = GenericMap::askDartBuffer();
//	}

//	inline ~DartsBufferThread()
//	{
//		GenericMap::releaseDartBuffer(m_vd);
//	}

//	inline std::vector<Dart>& vector() { return *m_vd;}
//};



Pierre Kraemer's avatar
Pierre Kraemer committed
548 549 550 551 552
} //namespace CGoGN

#include "Topology/generic/genericmap.hpp"

#endif