cellmarker.h

/*******************************************************************************
* CGoGN: Combinatorial and Geometric modeling with Generic N-dimensional Maps  *
* version 0.1                                                                  *
* Copyright (C) 2009-2012, 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: http://cgogn.unistra.fr/                                           *
* Contact information: cgogn@unistra.fr                                        *
*                                                                              *
*******************************************************************************/

#ifndef __CELL_MARKER__
#define __CELL_MARKER__

#include "Topology/generic/marker.h"
#include "Topology/generic/genericmap.h"
#include "Topology/generic/functor.h"
#include "Algo/Topo/embedding.h"

#include "Utils/static_assert.h"

namespace CGoGN
{
/**
 * @brief The CellMarkerGen class
 * @warning CellMarkerGen is no polymorphic version of CellMarker
 */
class CellMarkerGen
{
	friend class GenericMap ;

protected:
	AttributeMultiVector<MarkerBool>* m_markVector ;
	unsigned int m_cell ;
	unsigned int m_thread;

public:
	CellMarkerGen(unsigned int cell, unsigned int thread = 0) :
		m_cell(cell),m_thread(thread)
	{}

	virtual ~CellMarkerGen()
	{}

	unsigned int getCell() { return m_cell ; }

protected:
	// protected copy constructor to forbid its usage
	CellMarkerGen(const CellMarkerGen& /*cm*/)
	{}

};

/**
 * generic class that allows the marking of cells
 * \warning no default constructor
 */
template <typename MAP, unsigned int CELL>
class CellMarkerBase : public CellMarkerGen
{
protected:
	MAP& m_map ;

public:
	/**
	 * constructor
	 * @param map the map on which we work
	 */
	CellMarkerBase(MAP& map, unsigned int thread = 0) :
		CellMarkerGen(CELL, thread),
		m_map(map)
	{
		if(!m_map.template isOrbitEmbedded<CELL>())
			m_map.template addEmbedding<CELL>() ;
		m_markVector = m_map.template askMarkVector<CELL>(m_thread);
	}

	CellMarkerBase(const MAP& map, unsigned int thread = 0) :
		CellMarkerGen(CELL, thread),
		m_map(const_cast<MAP&>(map))
	{
		if(!m_map.template isOrbitEmbedded<CELL>())
			m_map.template addEmbedding<CELL>() ;
		m_markVector = m_map.template askMarkVector<CELL>(m_thread);
	}

	virtual ~CellMarkerBase()
	{
		if (GenericMap::alive(&m_map))
			m_map.template releaseMarkVector<CELL>(m_markVector,m_thread);
	}

	/**
	 * @brief update: realloc the marker in map
	 * @warning call only after map cleaning
	 */
	void update()
	{
		if(!m_map.template isOrbitEmbedded<CELL>())
			m_map.template addEmbedding<CELL>() ;
		m_markVector = m_map.template askMarkVector<CELL>(m_thread);
	}


protected:
	// protected copy constructor to forbid its usage
	CellMarkerBase(const CellMarkerBase<MAP, CELL>& cm) :
		m_map(cm.m_map),
		CellMarkerGen(CELL)
	{}

public:
	/**
	 * mark the cell of dart
	 */
	inline void mark(Cell<CELL> c)
	{
		assert(m_markVector != NULL);

		unsigned int a = m_map.getEmbedding(c) ;

		if (a == EMBNULL)
			a = Algo::Topo::setOrbitEmbeddingOnNewCell(m_map, c) ;

		m_markVector->setTrue(a);
	}

	/**
	 * unmark the cell of dart
	 */
	inline void unmark(Cell<CELL> c)
	{
		assert(m_markVector != NULL);

		unsigned int a = m_map.getEmbedding(c) ;

		if (a == EMBNULL)
			a = Algo::Topo::setOrbitEmbeddingOnNewCell(m_map, c) ;

		m_markVector->setFalse(a);
	}

	/**
	 * test if cell of dart is marked
	 */
	inline bool isMarked(Cell<CELL> c) const
	{
		assert(m_markVector != NULL);

		unsigned int a = m_map.getEmbedding(c) ;

		if (a == EMBNULL)
			return false ;

		return m_markVector->operator[](a);
	}

	/**
	 * mark the cell
	 */
	inline void mark(unsigned int em)
	{
		assert(m_markVector != NULL);
		m_markVector->setTrue(em);
	}

	/**
	 * unmark the cell
	 */
	inline void unmark(unsigned int em)
	{
		assert(m_markVector != NULL);
		m_markVector->setFalse(em);
	}

	/**
	 * test if cell is marked
	 */
	inline bool isMarked(unsigned int em) const
	{
		assert(m_markVector != NULL);

		if (em == EMBNULL)
			return false ;
		return m_markVector->operator[](em);
	}

	/**
	 * mark all the cells
	 */
	inline void markAll()
	{
		assert(m_markVector != NULL);

		AttributeContainer& cont = m_map.template getAttributeContainer<CELL>() ;
		if (cont.hasBrowser())
			for (unsigned int i = cont.begin(); i != cont.end(); cont.next(i))
				this->m_markVector->setTrue(i);
		else
			m_markVector->allTrue();
	}

	inline bool isAllUnmarked()
	{
		assert(m_markVector != NULL);

		AttributeContainer& cont = m_map.template getAttributeContainer<CELL>() ;
		if (cont.hasBrowser())
		{
			for (unsigned int i = cont.begin(); i != cont.end(); cont.next(i))
				if(m_markVector->operator[](i))
				return false ;
			return true ;
		}
		//else
		return m_markVector->isAllFalse();
	}
};

/**
 * class that allows the marking of cells
 * \warning no default constructor
 */
template <typename MAP, unsigned int CELL>
class CellMarker : public CellMarkerBase<MAP, CELL>
{
public:
	CellMarker(MAP& map, unsigned int thread = 0) : CellMarkerBase<MAP, CELL>(map, thread)
	{}

	CellMarker(const MAP& map, unsigned int thread = 0) :
		CellMarkerBase<MAP, CELL>(map, thread)
	{}

	virtual ~CellMarker()
	{
		unmarkAll() ;
	}

protected:
	CellMarker(const CellMarker& cm) :
		CellMarkerBase<MAP, CELL>(cm)
	{}

public:
	inline void unmarkAll()
	{
		assert(this->m_markVector != NULL);

		AttributeContainer& cont = this->m_map.template getAttributeContainer<CELL>() ;
		if (cont.hasBrowser())
			for (unsigned int i = cont.begin(); i != cont.end(); cont.next(i))
				this->m_markVector->setFalse(i);
		else
			this->m_markVector->allFalse();
	}
};

/**
 * class that allows the marking of cells
 * the marked cells are stored to optimize the unmarking task at destruction
 * \warning no default constructor
 */
template <typename MAP, unsigned int CELL>
class CellMarkerStore: public CellMarkerBase<MAP, CELL>
{
protected:
	std::vector<unsigned int>* m_markedCells ;

public:
	CellMarkerStore(MAP& map, unsigned int thread = 0) :
		CellMarkerBase<MAP, CELL>(map, thread)
	{
//		m_markedCells.reserve(128);
		m_markedCells = GenericMap::askUIntBuffer(thread);
	}

	CellMarkerStore(const MAP& map, unsigned int thread = 0) :
		CellMarkerBase<MAP, CELL>(map, thread)
	{
//		m_markedCells.reserve(128);
		m_markedCells = GenericMap::askUIntBuffer(thread);
	}

	virtual ~CellMarkerStore()
	{
		unmarkAll() ;
		GenericMap::releaseUIntBuffer(m_markedCells, this->m_thread);
//		assert(isAllUnmarked);
//		CGoGN_ASSERT(this->isAllUnmarked())
	}

protected:
	CellMarkerStore(const CellMarkerStore& cm) :
		CellMarkerBase<MAP, CELL>(cm)
	{}

public:
	inline void mark(Cell<CELL> d)
	{
		CellMarkerBase<MAP, CELL>::mark(d) ;
		m_markedCells->push_back(this->m_map.template getEmbedding<CELL>(d)) ;
	}

	inline void mark(unsigned int em)
	{
		CellMarkerBase<MAP, CELL>::mark(em) ;
		m_markedCells->push_back(em) ;
	}

	inline void unmarkAll()
	{
		assert(this->m_markVector != NULL);

		for (std::vector<unsigned int>::iterator it = m_markedCells->begin(); it != m_markedCells->end(); ++it)
			this->m_markVector->setFalse(*it);
	}
};

/**
 * class that allows the marking of Darts
 * the marked Darts are stored to optimize the unmarking task at destruction
 * \warning no default constructor
 */
template <typename MAP, unsigned int CELL>
class CellMarkerMemo: public CellMarkerBase<MAP, CELL>
{
protected:
	std::vector<Dart> m_markedDarts ;

public:
	CellMarkerMemo(MAP& map, unsigned int thread = 0) :
		CellMarkerBase<MAP, CELL>(map, thread)
	{
		m_markedDarts.reserve(128);
	}

	CellMarkerMemo(const MAP& map, unsigned int thread = 0) :
		CellMarkerBase<MAP, CELL>(map, thread)
	{
		m_markedDarts.reserve(128);
	}

	virtual ~CellMarkerMemo()
	{
		unmarkAll() ;
//		assert(isAllUnmarked);
//		CGoGN_ASSERT(this->isAllUnmarked())
	}

protected:
	CellMarkerMemo(const CellMarkerMemo& cm) :
		CellMarkerBase<MAP, CELL>(cm)
	{}

public:
	inline void mark(Cell<CELL> c)
	{
		if(!this->isMarked(c))
		{
			CellMarkerBase<MAP, CELL>::mark(c) ;
			m_markedDarts.push_back(c.dart) ;
		}
	}

	inline void unmarkAll()
	{
		assert(this->m_markVector != NULL);
		for (std::vector<Dart>::iterator it = m_markedDarts.begin(); it != m_markedDarts.end(); ++it)
		{
			this->unmark(*it) ;
		}
		m_markedDarts.clear();

	}

	inline const std::vector<Dart>& get_markedCells()
	{
		return m_markedDarts;
	}
};

/**
 * class that allows the marking of cells
 * the markers are not unmarked at destruction
 * \warning no default constructor
 */
template <typename MAP, unsigned int CELL>
class CellMarkerNoUnmark: public CellMarkerBase<MAP, CELL>
{
#ifndef NDEBUG
	int m_counter;
#endif
public:
	CellMarkerNoUnmark(MAP& map, unsigned int thread = 0) :
		CellMarkerBase<MAP, CELL>(map, thread)
  #ifndef NDEBUG
		,m_counter(0)
  #endif
	{}

	CellMarkerNoUnmark(const MAP& map, unsigned int thread = 0) :
		CellMarkerBase<MAP, CELL>(map, thread)
  #ifndef NDEBUG
		,m_counter(0)
  #endif
	{}

	virtual ~CellMarkerNoUnmark()
	{
#ifndef NDEBUG
		if (m_counter != 0)
		{
			CGoGNerr << "CellMarkerNoUnmark: Warning problem unmarking not complete"<< CGoGNendl;
			CGoGNerr << "CellMarkerNoUnmark:  -> calling unmarkAll()"<< CGoGNendl;
			unmarkAll();
		}
#endif
	}

protected:
	CellMarkerNoUnmark(const CellMarkerNoUnmark& cm) :
		CellMarkerBase<MAP, CELL>(cm)
  #ifndef NDEBUG
		,m_counter(cm.m_counter)
  #endif
	{}

public:
	inline void unmarkAll()
	{
		assert(this->m_markVector != NULL);

		AttributeContainer& cont = this->m_map.template getAttributeContainer<CELL>() ;
		if (cont.hasBrowser())
			for (unsigned int i = cont.begin(); i != cont.end(); cont.next(i))
				this->m_markVector->setFalse(i);
		else
			this->m_markVector->allFalse();
	}


#ifndef NDEBUG
	inline void mark(Cell<CELL> c)
	{
		if (this->isMarked(c))
			return;
		CellMarkerBase<MAP, CELL>::mark(c) ;
		m_counter++;
	}

	inline void unmark(Cell<CELL> c)
	{
		if (!this->isMarked(c))
			return;
		CellMarkerBase<MAP, CELL>::unmark(c) ;
		m_counter--;
	}

	inline void mark(unsigned int i)
	{
		if (this->isMarked(i))
			return;
		CellMarkerBase<MAP, CELL>::mark(i) ;
		m_counter++;
	}

	/**
	 * unmark the dart
	 */
	inline void unmark(unsigned int i)
	{
		if (!this->isMarked(i))
			return;
		CellMarkerBase<MAP, CELL>::unmark(i) ;
		m_counter--;
	}

#endif
};

// Selector and count functors testing for marker existence
/********************************************************/

/**
 * selector that say if a dart has its cell marked
 */
template <typename MAP, unsigned int CELL>
class SelectorCellMarked : public FunctorSelect
{
protected:
	const CellMarkerBase<MAP, CELL>& m_cmarker ;

public:
	SelectorCellMarked(const CellMarkerBase<MAP, CELL>& cm) :
		m_cmarker(cm)
	{}

	inline bool operator()(Cell<CELL> d) const
	{
		if (m_cmarker.isMarked(d))
			return true ;
		return false ;
	}

	inline FunctorSelect* copy() const { return new SelectorCellMarked(m_cmarker); }
};

template <typename MAP, unsigned int CELL>
class SelectorCellUnmarked : public FunctorSelect
{
protected:
	const CellMarkerBase<MAP, CELL>& m_cmarker ;

public:
	SelectorCellUnmarked(const CellMarkerBase<MAP, CELL>& cm) :
		m_cmarker(cm)
	{}

	inline bool operator()(Cell<CELL> d) const
	{
		if (!m_cmarker.isMarked(d))
			return true ;
		return false ;
	}

	inline FunctorSelect* copy() const
	{
		return new SelectorCellUnmarked(m_cmarker);
	}
};

// Functor version (needed for use with foreach_xxx)

template <typename MAP, unsigned int CELL>
class FunctorCellIsMarked : public FunctorType
{
protected:
	CellMarkerBase<MAP, CELL>& m_marker;

public:
	FunctorCellIsMarked(CellMarkerBase<MAP, CELL>& cm) :
		m_marker(cm)
	{}

	inline bool operator()(Cell<CELL> d)
	{
		return m_marker.isMarked(d);
	}
};

template <typename MAP, unsigned int CELL>
class FunctorCellIsUnmarked : public FunctorType
{
protected:
	CellMarkerBase<MAP, CELL>& m_marker;
public:
	FunctorCellIsUnmarked(CellMarkerBase<MAP, CELL>& cm) :
		m_marker(cm)
	{}

	inline bool operator()(Cell<CELL> d)
	{
		return !m_marker.isMarked(d);
	}
};

} // namespace CGoGN

#endif