#include <ogdf/hypergraph/Hypergraph.h>

Inheritance diagram for ogdf::Hypergraph:

Public Member Functions
	Hypergraph ()
	Constructs an empty hypergraph.

	Hypergraph (const Hypergraph &H)
	Constructs a hypergraph that is a copy of `H`.

	~Hypergraph ()
	Destructor.

template<class LIST >
void	allHyperedges (LIST &hyperedgeList) const
	Returns a list with all hyperedges of the hypergraph.

template<class LIST >
void	allHypernodes (LIST &hypernodeList) const
	Returns a list with all hypernodes of the hypergraph.

void	clear ()
	Removes all hypernodes and all hyperedges from the hypergraph.

bool	consistency () const
	Checks the consistency of the data structure.

void	delHyperedge (hyperedge e)
	Removes hyperedge `e` from the hypergraph.

void	delHypernode (hypernode v)
	Removes hypernode `v` and all incident hyperedges from the hypergraph.

bool	empty () const
	Returns true iff the hypergraph is empty (ie. contains no hypernodes).

hyperedge	firstHyperedge () const
	Returns the first hyperedge in the list of all hyperedges.

hypernode	firstHypernode () const
	Returns the first hypernode in the list of all hypernodes.

HypergraphRegistry< HyperedgeElement > &	hyperedgeRegistry ()
	Returns a reference to the registry of hyperedge arrays associated with this hypergraph.

const HypergraphRegistry< HyperedgeElement > &	hyperedgeRegistry () const
	Returns a const reference to the registry of hyperedge arrays associated with this hypergraph.

const internal::GraphList< HyperedgeElement > &	hyperedges () const
	Returns the list of all hyperedges.

HypergraphRegistry< HypernodeElement > &	hypernodeRegistry ()
	Returns a reference to the registry of hypernode arrays associated with this hypergraph.

const HypergraphRegistry< HypernodeElement > &	hypernodeRegistry () const
	Returns a const reference to the registry of hypernode arrays associated with this hypergraph.

const internal::GraphList< HypernodeElement > &	hypernodes () const
	Returns the list of all hypernodes.

hyperedge	lastHyperEdge () const
	Returns the last hyperedge in the list of all hyperedges.

hypernode	lastHypernode () const
	Returns the last hypernode in the list of all hypernodes.

void	loadPlaHypergraph (const char *fileName)
	Reads hypergraph in pla format from the file.

int	maxHyperedgeIndex () const
	Returns the largest used hyperedge index.

int	maxHypernodeIndex () const
	Returns the largest used hypernode index.

hyperedge	newHyperedge (int pIndex, List< hypernode > &hypernodes)
	Creates a new hyperedge between `hypernodes` and returns it.

hyperedge	newHyperedge (List< hypernode > &hypernodes)
	Creates a new hyperedge btween `hypernodes` and returns it.

hypernode	newHypernode ()
	Creates a new hypernode and returns it.

hypernode	newHypernode (HypernodeElement::Type pType)
	Creates a new hypernode with given `pType` and returns it.

hypernode	newHypernode (int pIndex)
	Creates a new hypernode with given `pIndex` and returns it.

hypernode	newHypernode (int pIndex, HypernodeElement::Type pType)
	Creates a new hypernode with given `pIndex` and `pType` and returns it.

int	numberOfHyperedges () const
	Returns the number of hyperedges in the hypergraph.

int	numberOfHypernodes () const
	Returns the number of hypernodes in the hypergraph.

	operator const HypergraphRegistry< HyperedgeElement > & () const

	operator const HypergraphRegistry< HypernodeElement > & () const

Hypergraph &	operator= (const Hypergraph &H)

hyperedge	randomHyperedge () const
	Returns a randomly chosen hyperedge.

hypernode	randomHypernode () const
	Returns a randomly chosen hypergraph.

void	readBenchHypergraph (const char *filename)
	Reads hypergraph in bench format from the file.

void	readBenchHypergraph (std::istream &is)
	Reads hypergraph in bench format from the input stream.

void	readPlaHypergraph (std::istream &is)
	Reads hypergraph in pla format from the input stream.

Public Member Functions inherited from ogdf::Observable< HypergraphObserver, Hypergraph >
	Observable ()=default

	Observable (const Observable &copy)=delete
	If you want to copy a subclass of Observable, call the default Observable() constructor.

	Observable (Observable &&move)=delete
	If you want to move a subclass of Observable, call the default Observable() constructor.

virtual	~Observable ()
	Note that all Observers must already be removed once the destructor of this base class is invoked (e.g.

Observable &	operator= (const Observable &copy)=delete

Observable &	operator= (Observable &&move)=delete

Public Attributes
	OGDF_MALLOC_NEW_DELETE

Private Member Functions
HypernodeElement::Type	gateType (string gate)

void	initArrays ()

int	nextEntry (char *buffer, int from, string stop)

Private Attributes
int	m_hyperedgeIdCount
	The Index that will be assigned to the next created hyperedge.

internal::GraphList< HyperedgeElement >	m_hyperedges
	The list of all hyperedges.

int	m_hypernodeIdCount
	The Index that will be assigned to the next created hypernode.

internal::GraphList< HypernodeElement >	m_hypernodes
	The list of all hypernodes.

int	m_nHyperedges
	The number of hyperedges in the hypergraph.

int	m_nHypernodes
	The number of hypernodes in the hypergraph.

HypergraphRegistry< HyperedgeElement >	m_regHyperedgeArrays
	The registered hyperedge arrays.

HypergraphRegistry< HypernodeElement >	m_regHypernodeArrays
	The registered hypernode arrays.

Friends
std::ostream &	operator<< (std::ostream &os, ogdf::Hypergraph &H)

std::istream &	operator>> (std::istream &is, ogdf::Hypergraph &H)

Additional Inherited Members
Protected Member Functions inherited from ogdf::Observable< HypergraphObserver, Hypergraph >
void	clearObservers ()

const ListPure< HypergraphObserver * > &	getObservers () const

ListPure< HypergraphObserver * >::iterator	registerObserver (HypergraphObserver *obs) const
	Registers an observer.

void	unregisterObserver (typename ListPure< HypergraphObserver * >::iterator it) const
	Unregisters an observer.

Detailed Description

Definition at line 413 of file Hypergraph.h.

Constructor & Destructor Documentation

◆ Hypergraph() [1/2]

ogdf::Hypergraph::Hypergraph ( )

Constructs an empty hypergraph.

◆ Hypergraph() [2/2]

ogdf::Hypergraph::Hypergraph ( const Hypergraph & H )

Constructs a hypergraph that is a copy of H.

◆ ~Hypergraph()

ogdf::Hypergraph::~Hypergraph ( )

Destructor.

Member Function Documentation

◆ allHyperedges()

template<class LIST >

void ogdf::Hypergraph::allHyperedges ( LIST & hyperedgeList ) const

inline

Returns a list with all hyperedges of the hypergraph.

Definition at line 540 of file Hypergraph.h.

◆ allHypernodes()

template<class LIST >

void ogdf::Hypergraph::allHypernodes ( LIST & hypernodeList ) const

inline

Returns a list with all hypernodes of the hypergraph.

Definition at line 531 of file Hypergraph.h.

◆ clear()

void ogdf::Hypergraph::clear ( )

Removes all hypernodes and all hyperedges from the hypergraph.

◆ consistency()

bool ogdf::Hypergraph::consistency ( ) const

Checks the consistency of the data structure.

◆ delHyperedge()

void ogdf::Hypergraph::delHyperedge ( hyperedge e )

Removes hyperedge e from the hypergraph.

Parameters

e	is the hyperegde that will be deleted.

◆ delHypernode()

void ogdf::Hypergraph::delHypernode ( hypernode v )

Removes hypernode v and all incident hyperedges from the hypergraph.

Parameters

v	is the hypernode that will be deleted.

◆ empty()

bool ogdf::Hypergraph::empty ( ) const

inline

Returns true iff the hypergraph is empty (ie. contains no hypernodes).

Definition at line 449 of file Hypergraph.h.

◆ firstHyperedge()

hyperedge ogdf::Hypergraph::firstHyperedge ( ) const

inline

Returns the first hyperedge in the list of all hyperedges.

Definition at line 476 of file Hypergraph.h.

◆ firstHypernode()

hypernode ogdf::Hypergraph::firstHypernode ( ) const

inline

Returns the first hypernode in the list of all hypernodes.

Definition at line 470 of file Hypergraph.h.

◆ gateType()

HypernodeElement::Type ogdf::Hypergraph::gateType ( string gate )

private

◆ hyperedgeRegistry() [1/2]

HypergraphRegistry< HyperedgeElement > & ogdf::Hypergraph::hyperedgeRegistry ( )

inline

Returns a reference to the registry of hyperedge arrays associated with this hypergraph.

Definition at line 573 of file Hypergraph.h.

◆ hyperedgeRegistry() [2/2]

const HypergraphRegistry< HyperedgeElement > & ogdf::Hypergraph::hyperedgeRegistry ( ) const

inline

Returns a const reference to the registry of hyperedge arrays associated with this hypergraph.

Definition at line 576 of file Hypergraph.h.

◆ hyperedges()

const internal::GraphList< HyperedgeElement > & ogdf::Hypergraph::hyperedges ( ) const

inline

Returns the list of all hyperedges.

Definition at line 455 of file Hypergraph.h.

◆ hypernodeRegistry() [1/2]

HypergraphRegistry< HypernodeElement > & ogdf::Hypergraph::hypernodeRegistry ( )

inline

Returns a reference to the registry of hypernode arrays associated with this hypergraph.

Definition at line 563 of file Hypergraph.h.

◆ hypernodeRegistry() [2/2]

const HypergraphRegistry< HypernodeElement > & ogdf::Hypergraph::hypernodeRegistry ( ) const

inline

Returns a const reference to the registry of hypernode arrays associated with this hypergraph.

Definition at line 566 of file Hypergraph.h.

◆ hypernodes()

const internal::GraphList< HypernodeElement > & ogdf::Hypergraph::hypernodes ( ) const

inline

Returns the list of all hypernodes.

Definition at line 452 of file Hypergraph.h.

◆ initArrays()

void ogdf::Hypergraph::initArrays ( )

private

◆ lastHyperEdge()

hyperedge ogdf::Hypergraph::lastHyperEdge ( ) const

inline

Returns the last hyperedge in the list of all hyperedges.

Definition at line 479 of file Hypergraph.h.

◆ lastHypernode()

hypernode ogdf::Hypergraph::lastHypernode ( ) const

inline

Returns the last hypernode in the list of all hypernodes.

Definition at line 473 of file Hypergraph.h.

◆ loadPlaHypergraph()

void ogdf::Hypergraph::loadPlaHypergraph ( const char * fileName )

Reads hypergraph in pla format from the file.

◆ maxHyperedgeIndex()

int ogdf::Hypergraph::maxHyperedgeIndex ( ) const

inline

Returns the largest used hyperedge index.

Definition at line 467 of file Hypergraph.h.

◆ maxHypernodeIndex()

int ogdf::Hypergraph::maxHypernodeIndex ( ) const

inline

Returns the largest used hypernode index.

Definition at line 464 of file Hypergraph.h.

◆ newHyperedge() [1/2]

hyperedge ogdf::Hypergraph::newHyperedge	(	int	pIndex,
		List< hypernode > &	hypernodes
	)

Creates a new hyperedge between hypernodes and returns it.

Parameters

pIndex	is the unique index of the newly created hyperedge.
hypernodes	are the hypernodes of the newly created hyperedge.

Returns: the newly created hyperedge.

◆ newHyperedge() [2/2]

hyperedge ogdf::Hypergraph::newHyperedge ( List< hypernode > & hypernodes )

Creates a new hyperedge btween hypernodes and returns it.

Parameters

hypernodes are the hypernodes of the newly created hyperedge.

Returns: the newly created hyperedge.

◆ newHypernode() [1/4]

hypernode ogdf::Hypergraph::newHypernode ( )

Creates a new hypernode and returns it.

◆ newHypernode() [2/4]

hypernode ogdf::Hypergraph::newHypernode ( HypernodeElement::Type pType )

Creates a new hypernode with given pType and returns it.

◆ newHypernode() [3/4]

hypernode ogdf::Hypergraph::newHypernode ( int pIndex )

Creates a new hypernode with given pIndex and returns it.

◆ newHypernode() [4/4]

hypernode ogdf::Hypergraph::newHypernode	(	int	pIndex,
		HypernodeElement::Type	pType
	)

Creates a new hypernode with given pIndex and pType and returns it.

◆ nextEntry()

int ogdf::Hypergraph::nextEntry	(	char *	buffer,
		int	from,
		string	stop
	)

private

◆ numberOfHyperedges()

int ogdf::Hypergraph::numberOfHyperedges ( ) const

inline

Returns the number of hyperedges in the hypergraph.

Definition at line 461 of file Hypergraph.h.

◆ numberOfHypernodes()

int ogdf::Hypergraph::numberOfHypernodes ( ) const

inline

Returns the number of hypernodes in the hypergraph.

Definition at line 458 of file Hypergraph.h.

◆ operator const HypergraphRegistry< HyperedgeElement > &()

ogdf::Hypergraph::operator const HypergraphRegistry< HyperedgeElement > & ( ) const

inline

Definition at line 580 of file Hypergraph.h.

◆ operator const HypergraphRegistry< HypernodeElement > &()

ogdf::Hypergraph::operator const HypergraphRegistry< HypernodeElement > & ( ) const

inline

Definition at line 570 of file Hypergraph.h.

◆ operator=()

Hypergraph & ogdf::Hypergraph::operator= ( const Hypergraph & H )

◆ randomHyperedge()

hyperedge ogdf::Hypergraph::randomHyperedge ( ) const

Returns a randomly chosen hyperedge.

◆ randomHypernode()

hypernode ogdf::Hypergraph::randomHypernode ( ) const

Returns a randomly chosen hypergraph.

◆ readBenchHypergraph() [1/2]

void ogdf::Hypergraph::readBenchHypergraph ( const char * filename )

Reads hypergraph in bench format from the file.

◆ readBenchHypergraph() [2/2]

void ogdf::Hypergraph::readBenchHypergraph ( std::istream & is )

Reads hypergraph in bench format from the input stream.

◆ readPlaHypergraph()

void ogdf::Hypergraph::readPlaHypergraph ( std::istream & is )

Reads hypergraph in pla format from the input stream.

Friends And Related Symbol Documentation

◆ operator<<

std::ostream & operator<<	(	std::ostream &	os,
		ogdf::Hypergraph &	H
	)

friend

◆ operator>>

std::istream & operator>>	(	std::istream &	is,
		ogdf::Hypergraph &	H
	)

friend

Member Data Documentation

◆ m_hyperedgeIdCount

int ogdf::Hypergraph::m_hyperedgeIdCount

private

The Index that will be assigned to the next created hyperedge.

Definition at line 436 of file Hypergraph.h.

◆ m_hyperedges

internal::GraphList<HyperedgeElement> ogdf::Hypergraph::m_hyperedges

private

The list of all hyperedges.

Definition at line 424 of file Hypergraph.h.

◆ m_hypernodeIdCount

int ogdf::Hypergraph::m_hypernodeIdCount

private

The Index that will be assigned to the next created hypernode.

Definition at line 433 of file Hypergraph.h.

◆ m_hypernodes

internal::GraphList<HypernodeElement> ogdf::Hypergraph::m_hypernodes

private

The list of all hypernodes.

Definition at line 421 of file Hypergraph.h.

◆ m_nHyperedges

int ogdf::Hypergraph::m_nHyperedges

private

The number of hyperedges in the hypergraph.

Definition at line 430 of file Hypergraph.h.

◆ m_nHypernodes

int ogdf::Hypergraph::m_nHypernodes

private

The number of hypernodes in the hypergraph.

Definition at line 427 of file Hypergraph.h.

◆ m_regHyperedgeArrays

HypergraphRegistry<HyperedgeElement> ogdf::Hypergraph::m_regHyperedgeArrays

private

The registered hyperedge arrays.

Definition at line 418 of file Hypergraph.h.

◆ m_regHypernodeArrays

HypergraphRegistry<HypernodeElement> ogdf::Hypergraph::m_regHypernodeArrays

private

The registered hypernode arrays.

Definition at line 415 of file Hypergraph.h.

◆ OGDF_MALLOC_NEW_DELETE

ogdf::Hypergraph::OGDF_MALLOC_NEW_DELETE

Definition at line 588 of file Hypergraph.h.

The documentation for this class was generated from the following file:

include/ogdf/hypergraph/Hypergraph.h

OpenGraph DrawingFramework

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Hypergraph() [1/2]

◆ Hypergraph() [2/2]

◆ ~Hypergraph()

Member Function Documentation

◆ allHyperedges()

◆ allHypernodes()

◆ clear()

◆ consistency()

◆ delHyperedge()

◆ delHypernode()

◆ empty()

◆ firstHyperedge()

◆ firstHypernode()

◆ gateType()

◆ hyperedgeRegistry() [1/2]

◆ hyperedgeRegistry() [2/2]

◆ hyperedges()

◆ hypernodeRegistry() [1/2]

◆ hypernodeRegistry() [2/2]

◆ hypernodes()

◆ initArrays()

◆ lastHyperEdge()

◆ lastHypernode()

◆ loadPlaHypergraph()

◆ maxHyperedgeIndex()

◆ maxHypernodeIndex()

◆ newHyperedge() [1/2]

◆ newHyperedge() [2/2]

◆ newHypernode() [1/4]

◆ newHypernode() [2/4]

◆ newHypernode() [3/4]

◆ newHypernode() [4/4]

◆ nextEntry()

◆ numberOfHyperedges()

◆ numberOfHypernodes()

◆ operator const HypergraphRegistry< HyperedgeElement > &()

◆ operator const HypergraphRegistry< HypernodeElement > &()

◆ operator=()

◆ randomHyperedge()

◆ randomHypernode()

◆ readBenchHypergraph() [1/2]

◆ readBenchHypergraph() [2/2]

◆ readPlaHypergraph()

Friends And Related Symbol Documentation

◆ operator<<

◆ operator>>

Member Data Documentation

◆ m_hyperedgeIdCount

◆ m_hyperedges

◆ m_hypernodeIdCount

◆ m_hypernodes

◆ m_nHyperedges

◆ m_nHypernodes

◆ m_regHyperedgeArrays

◆ m_regHypernodeArrays

◆ OGDF_MALLOC_NEW_DELETE

Open
Graph Drawing
Framework