/*
* $Revision: 2523 $
*
* last checkin:
* $Author: gutwenger $
* $Date: 2012-07-02 20:59:27 +0200 (Mon, 02 Jul 2012) $
***************************************************************/
/** \file
* \brief declaration and implementation of class FaceSetSimple,
* FaceSetPure and FaceSet
*
* \author Carsten Gutwenger
*
* \par License:
* This file is part of the Open Graph Drawing Framework (OGDF).
*
* \par
* Copyright (C)
* See README.txt in the root directory of the OGDF installation for details.
*
* \par
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* Version 2 or 3 as published by the Free Software Foundation;
* see the file LICENSE.txt included in the packaging of this file
* for details.
*
* \par
* This program 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 General Public License for more details.
*
* \par
* You should have received a copy of the GNU General Public
* License along with this program; if not, write to the Free
* Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*
* \see http://www.gnu.org/copyleft/gpl.html
***************************************************************/
#ifdef _MSC_VER
#pragma once
#endif
#ifndef OGDF_FACE_SET_H
#define OGDF_FACE_SET_H
#include "FaceArray.h"
#include "List.h"
namespace ogdf {
//! Maintains a subset S of the faces contained in an associated combinatorial embedding E
/** (only insertion of elements and clear operation)
*/
class OGDF_EXPORT FaceSetSimple {
public:
//! creates a new empty face set associated with combinatorial embedding E
FaceSetSimple(const CombinatorialEmbedding &E) : m_isContained(E,false) { }
//! destructor
~FaceSetSimple() { }
//! inserts face f into set S
/** running time: O(1)
* Precond.: f is a face in the associated combinatorial embedding
*/
void insert(face f) {
OGDF_ASSERT(f->embeddingOf() == m_isContained.embeddingOf());
bool &isContained = m_isContained[f];
if (isContained == false) {
isContained = true;
m_faces.pushFront(f);
}
}
//! removes all faces from set S
/** running time: O(|S|)
*/
void clear() {
SListIterator it;
for(it = m_faces.begin(); it.valid(); ++it) {
m_isContained[*it] = false;
}
m_faces.clear();
}
//! returns true iff face f is contained in S
/** running time: O(1)
* Precond.: f is a face in the asociated embedding
*/
bool isMember(face f) const {
OGDF_ASSERT(f->embeddingOf() == m_isContained.embeddingOf());
return m_isContained[f];
}
//! returns the list of faces contained in S
const SListPure &faces() const {
return m_faces;
}
private:
//! m_isContained[f] is true <=> f is contained in S
FaceArray m_isContained;
//! list of faces contained in S
SListPure m_faces;
};
//! maintains a subset S of the faces contained in an associated combinatorial embedding E
/** (no efficient access to size of S)
*/
class OGDF_EXPORT FaceSetPure {
public:
//! creates a new empty face set associated with combinatorial embedding E
FaceSetPure(const CombinatorialEmbedding &E) : m_it(E,ListIterator()) { }
//! destructor
~FaceSetPure() { }
//! inserts face f into set S
/** running time: O(1)
* Precond.: f is a face in the associated combinatorial embedding
*/
void insert(face f) {
OGDF_ASSERT(f->embeddingOf() == m_it.embeddingOf());
ListIterator &itF = m_it[f];
if (!itF.valid())
itF = m_faces.pushBack(f);
}
//! removes face f from set S
/** running time: O(1)
* Precond.: f is a face in the asociated embedding
*/
void remove(face f) {
OGDF_ASSERT(f->embeddingOf() == m_it.embeddingOf());
ListIterator &itF = m_it[f];
if (itF.valid()) {
m_faces.del(itF);
itF = ListIterator();
}
}
//! removes all faces from set S
/** running time: O(|S|)
*/
void clear() {
ListIterator it;
for(it = m_faces.begin(); it.valid(); ++it) {
m_it[*it] = ListIterator();
}
m_faces.clear();
}
//! returns true iff face f is contained in S
/** running time: O(1)
* Precond.: f is a face in the asociated embedding
*/
bool isMember(face f) const {
OGDF_ASSERT(f->embeddingOf() == m_it.embeddingOf());
return m_it[f].valid();
}
//! returns the list of faces contained in S
const ListPure &faces() const {
return m_faces;
}
private:
//! m_it[f] contains list iterator pointing to f if f is contained in S, an invalid list iterator otherwise
FaceArray > m_it;
//! list of faces contained in S
ListPure m_faces;
};
//! maintains a subset S of the faces contained in an associated combinatorial embedding E
class OGDF_EXPORT FaceSet {
public:
//! creates a new empty face set associated with combinatorial embedding E
FaceSet(const CombinatorialEmbedding &E) : m_it(E,ListIterator()) { }
//! destructor
~FaceSet() { }
//! inserts face f into set S
/** running time: O(1)
* Precond.: f is a face in the associated combinatorial embedding
*/
void insert(face f) {
OGDF_ASSERT(f->embeddingOf() == m_it.embeddingOf());
ListIterator &itF = m_it[f];
if (!itF.valid())
itF = m_faces.pushBack(f);
}
//! removes face f from set S
/* running time: O(1)
* Precond.: f is a face in the asociated embedding
*/
void remove(face f) {
OGDF_ASSERT(f->embeddingOf() == m_it.embeddingOf());
ListIterator &itF = m_it[f];
if (itF.valid()) {
m_faces.del(itF);
itF = ListIterator();
}
}
//! removes all faces from set S
/** running time: O(|S|)
*/
void clear() {
ListIterator it;
for(it = m_faces.begin(); it.valid(); ++it) {
m_it[*it] = ListIterator();
}
m_faces.clear();
}
//! returns true iff face f is contained in S
/** running time: O(1)
* Precond.: f is a face in the asociated embedding
*/
bool isMember(face f) const {
OGDF_ASSERT(f->embeddingOf() == m_it.embeddingOf());
return m_it[f].valid();
}
//! returns the size of set S
/** running time: O(1)
*/
int size() const {
return m_faces.size();
}
//! returns the list of faces contained in S
const List &faces() const {
return m_faces;
}
private:
//! m_it[f] contains list iterator pointing to f if f is contained in S,an invalid list iterator otherwise
FaceArray > m_it;
//! list of faces contained in S
List m_faces;
};
} // end namespace ogdf
#endif