Graph (directed or undirected). More...

#include <Graph.h>

Inheritance diagram for utl::Graph:

[legend]

Public Member Functions
	Graph (bool owner, bool directed=true)
	Constructor. More...

virtual void	serialize (Stream &stream, uint_t io, uint_t mode=ser_default)
	Serialize to or from a stream. More...

void	clear ()
	Remove all vertices, clear the start vertex. More...

Accessors
bool	isDirected () const
	Get the directed flag. More...

void	setDirected (bool directed)
	Set the directed flag. More...

Vertex *	getStart () const
	Return the start vertex. More...

void	setStart (Vertex *start)
	Set the start vertex. More...

Edges
bool	addEdge (const Object &lhsKey, const Object &rhsKey)
	Add an edge. More...

bool	removeEdge (const Object &lhsKey, const Object &rhsKey)
	Remove an edge. More...

Public Member Functions inherited from utl::TCollection< Vertex >
	TCollection (Collection *col)
	Constructor. More...

Public Member Functions inherited from utl::Object
void	clear ()
	Revert to initial state. More...

virtual void	vclone (const Object &rhs)
	Make an exact copy of another instance. More...

virtual void	steal (Object &rhs)
	"Steal" the internal representation from another instance. More...

void	dumpWithClassName (Stream &os, uint_t indent=4, uint_t level=uint_t_max) const
	Front-end for dump() that prints the object's class name. More...

virtual const Object &	getKey () const
	Get the key for this object. More...

bool	hasKey () const
	Determine whether or not the object has a key. More...

virtual const Object &	getProxiedObject () const
	Get the proxied object (= self if none). More...

virtual Object &	getProxiedObject ()
	Get the proxied object (= self if none). More...

virtual size_t	hash (size_t size) const
	Get the hash code for the object. More...

bool	_isA (const RunTimeClass *runTimeClass) const
	Determine whether self's class is a descendent of the given class. More...

	operator String () const
	Conversion to String. More...

size_t	allocatedSize () const
	Get the total allocated size of this object. More...

virtual size_t	innerAllocatedSize () const
	Get the "inner" allocated size. More...

virtual void	addOwnedIt (const class FwdIt *it) const
	Notify self that it owns the given iterator. More...

virtual void	removeOwnedIt (const class FwdIt *it) const
	Notify self that the given owned iterator has been destroyed. More...

bool	operator< (const Object &rhs) const
	Less-than operator. More...

bool	operator<= (const Object &rhs) const
	Less-than-or-equal-to operator. More...

bool	operator> (const Object &rhs) const
	Greater-than operator. More...

bool	operator>= (const Object &rhs) const
	Greater-than-or-equal-to operator. More...

bool	operator== (const Object &rhs) const
	Equal-to operator. More...

bool	operator!= (const Object &rhs) const
	Unequal-to operator. More...

void	serializeIn (Stream &is, uint_t mode=ser_default)
	Serialize from an input stream. More...

void	serializeOut (Stream &os, uint_t mode=ser_default) const
	Serialize to an output stream. More...

void	serializeOutBoxed (Stream &os, uint_t mode=ser_default) const
	Serialize a boxed object to an output stream. More...

Additional Inherited Members
Static Public Member Functions inherited from utl::Object
static Object *	serializeInNullable (Stream &is, uint_t mode=ser_default)
	Serialize a nullptr-able object from an input stream. More...

static void	serializeOutNullable (const Object *object, Stream &os, uint_t mode=ser_default)
	Serialize a nullptr-able object to an output stream. More...

static void	serializeNullable (Object *&object, Stream &stream, uint_t io, uint_t mode=ser_default)
	Serialize a nullptr-able object to or from a stream. More...

static Object *	serializeInBoxed (Stream &is, uint_t mode=ser_default)
	Serialize a boxed object from an input stream. More...

static void	serializeBoxed (Object *&object, Stream &stream, uint_t io, uint_t mode=ser_default)
	Serialize a boxed object to or from a stream. More...

Protected Member Functions inherited from utl::FlagsMI
	FlagsMI ()
	Constructor. More...

virtual	~FlagsMI ()
	Destructor. More...

void	copyFlags (const FlagsMI &rhs)
	Copy the given flags. More...

void	copyFlags (const FlagsMI &rhs, uint_t lsb, uint_t msb)
	Copy (some of) the given flags. More...

void	copyFlags (uint64_t flags, uint_t lsb, uint_t msb)
	Copy (some of) the given flags. More...

bool	getFlag (uint_t flagNum) const
	Get a user-defined flag. More...

void	setFlag (uint_t flagNum, bool val)
	Set a user-defined flag. More...

uint64_t	getFlagsNumber (uint64_t mask, uint64_t shift=0)
	Get a multi-bit value in the flags data (which is stored as one 64-bit integer). More...

void	setFlagsNumber (uint64_t mask, uint64_t shift, uint64_t num)
	Set a multi-bit value in the flags data (which is stored as one 64-bit integer). More...

uint64_t	getFlags () const
	Get the flags. More...

void	setFlags (uint64_t flags)
	Set the flags. More...

Detailed Description

Graph (directed or undirected).

A graph is defined by a set of vertices and a set of edges that connect vertices to each other.

Attributes

start vertex : The meaning of the start vertex is user-defined. Generally, it specifies the vertex where traversal of the graph should begin.

directed flag : A graph may be directed or undirected. In a directed graph, edges are added by calling Vertex::addDirectedEdge and removed by calling Vertex::removeDirectedEdge. Likewise, in an undirected graph, edges are added by calling Vertex::addUndirectedEdge and removed by calling Vertex::removeUndirectedEdge.

Author: Adam McKee

Definition at line 36 of file Graph.h.

Constructor & Destructor Documentation

◆ Graph()

utl::Graph::Graph	(	bool	owner,
		bool	directed = `true`
	)

inline

Constructor.

Parameters

owner	owner flag
directed	directed flag

Definition at line 46 of file Graph.h.

References utl::ser_default, and utl::serialize().

Member Function Documentation

◆ serialize()

virtual void utl::Graph::serialize	(	Stream &	stream,
		uint_t	io,
		uint_t	mode = `ser_default`
	)

virtual

Serialize to or from a stream.

This is the only virtual method for serialization. You must override this in any class that has data to be serialized, and ensure that the superclass's serialize() gets called.

Parameters

stream	stream to serialize from/to
io	see utl::io_t
mode	see utl::serialize_t

Reimplemented from utl::TCollection< Vertex >.

◆ clear()

void utl::Graph::clear ( )

inline

Remove all vertices, clear the start vertex.

Definition at line 57 of file Graph.h.

◆ isDirected()

bool utl::Graph::isDirected ( ) const

inline

Get the directed flag.

Definition at line 67 of file Graph.h.

◆ setDirected()

void utl::Graph::setDirected ( bool directed )

inline

Set the directed flag.

Definition at line 74 of file Graph.h.

◆ getStart()

Vertex* utl::Graph::getStart ( ) const

inline

Return the start vertex.

Definition at line 81 of file Graph.h.

◆ setStart()

void utl::Graph::setStart ( Vertex * start )

inline

Set the start vertex.

Definition at line 88 of file Graph.h.

References utl::deInit(), and utl::init().

◆ addEdge()

bool utl::Graph::addEdge	(	const Object &	lhsKey,
		const Object &	rhsKey
	)

Add an edge.

Returns: true if edge successfully added, false otherwise

Parameters

lhsKey	search key for lhs vertex
rhsKey	search key for rhs vertex

◆ removeEdge()

bool utl::Graph::removeEdge	(	const Object &	lhsKey,
		const Object &	rhsKey
	)

Remove an edge.

Returns: true iff edge successfully removed, false otherwise

Parameters

lhsKey	search key for lhs vertex
rhsKey	search key for rhs vertex

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

Graph.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Graph()

Member Function Documentation

◆ serialize()

◆ clear()

◆ isDirected()

◆ setDirected()

◆ getStart()

◆ setStart()

◆ addEdge()

◆ removeEdge()