bpp::ONode Class Reference

Oriented Node interface. More...

#include <Bpp/Graph/ONode.h>

Inheritance diagram for bpp::ONode:

Collaboration diagram for bpp::ONode:

Public Member Functions
Neighbors
virtual const ONode *	getNeighbor (int pos) const =0
	Get a neighbor of this node in const context. More...
virtual ONode *	getNeighbor (int pos)=0
	Get a neighbor of this node. More...
The Clonable interface.
ONode *	clone () const =0
	Create a copy of this object and send a pointer to it. More...
Fathers
virtual const ONode *	getFather (int pos) const =0
	Get a particular father in const environment. More...
virtual ONode *	getFather (int pos)=0
	Get a particular father. More...
virtual bool	hasFathers () const =0
	Tell if this node has one or more father nodes. More...
virtual int	getNumberOfFathers () const =0
	Give the number of father nodes for this node. More...
Sons
virtual const ONode *	getSon (int pos) const =0
	Get a particular son in const environment. More...
virtual ONode *	getSon (int pos)=0
	Get a particular son. More...
virtual bool	hasSons () const =0
	Tell if this node has one or more son nodes. More...
virtual int	getNumberOfSons () const =0
	Give the number of son nodes for this node. More...
Operators
virtual const ONode *	operator[] (int i) const =0
	Direct access to a neighbor in const context. More...
virtual ONode *	operator[] (int i)=0
	Direct access to a neighbor. More...
Neighbors
virtual int	degree () const =0
	Get the degree i.e. the number of neighbors of this node. More...

Detailed Description

Oriented Node interface.

ONode is an interface for oriented nodes aimed to build oriented graphs.

Author

Sylvain Gaillard

Definition at line 53 of file ONode.h.

Member Function Documentation

clone()

ONode* bpp::ONode::clone ( ) const

pure virtual

Create a copy of this object and send a pointer to it.

Returns

A pointer toward the copy object.

Implements bpp::UNode.

Implemented in bpp::BasicTNode, and bpp::TNode.

degree()

virtual int bpp::UNode::degree ( ) const

pure virtualinherited

Get the degree i.e. the number of neighbors of this node.

Implemented in bpp::BasicTNode.

getFather() [1/2]

virtual const ONode* bpp::ONode::getFather ( int  pos ) const

pure virtual

Get a particular father in const environment.

Implemented in bpp::BasicTNode, and bpp::TNode.

getFather() [2/2]

virtual ONode* bpp::ONode::getFather ( int  pos )

pure virtual

Get a particular father.

Implemented in bpp::BasicTNode, and bpp::TNode.

getNeighbor() [1/2]

virtual const ONode* bpp::ONode::getNeighbor ( int  pos ) const

pure virtual

Get a neighbor of this node in const context.

Parameters

pos	the position of the neighbor to get.

Returns

A pointer toward the neighbor node.

Implements bpp::UNode.

Implemented in bpp::BasicTNode, and bpp::TNode.

getNeighbor() [2/2]

virtual ONode* bpp::ONode::getNeighbor ( int  pos )

pure virtual

Get a neighbor of this node.

Parameters

pos	the position of the neighbor to get.

Returns

A pointer toward the neighbor node.

Implements bpp::UNode.

Implemented in bpp::BasicTNode, and bpp::TNode.

getNumberOfFathers()

virtual int bpp::ONode::getNumberOfFathers ( ) const

pure virtual

Give the number of father nodes for this node.

Implemented in bpp::BasicTNode.

getNumberOfSons()

virtual int bpp::ONode::getNumberOfSons ( ) const

pure virtual

Give the number of son nodes for this node.

Implemented in bpp::BasicTNode.

getSon() [1/2]

virtual const ONode* bpp::ONode::getSon ( int  pos ) const

pure virtual

Get a particular son in const environment.

Implemented in bpp::BasicTNode, and bpp::TNode.

getSon() [2/2]

virtual ONode* bpp::ONode::getSon ( int  pos )

pure virtual

Get a particular son.

Implemented in bpp::BasicTNode, and bpp::TNode.

hasFathers()

virtual bool bpp::ONode::hasFathers ( ) const

pure virtual

Tell if this node has one or more father nodes.

Implemented in bpp::BasicTNode.

hasSons()

virtual bool bpp::ONode::hasSons ( ) const

pure virtual

Tell if this node has one or more son nodes.

Implemented in bpp::BasicTNode.

operator[]() [1/2]

virtual const ONode* bpp::ONode::operator[] ( int  i ) const

pure virtual

Direct access to a neighbor in const context.

• a positive i gives access to sons (from 0 to n - 1)
• a negative i gives access to fathers (from 1 to m)

No check is done, you have to ensure that you query an existing neighbor.

Parameters

i	the position of the neighbor

Returns

A pointer toward the neighbor

Implements bpp::UNode.

Implemented in bpp::TNode, and bpp::BasicTNode.

operator[]() [2/2]

virtual ONode* bpp::ONode::operator[] ( int  i )

pure virtual

Direct access to a neighbor.

• a positive i gives access to sons (from 0 to n - 1)
• a negative i gives access to fathers (from 1 to m)

No check is done, you have to ensure that you query an existing neighbor.

Parameters

i	the position of the neighbor

Returns

A pointer toward the neighbor

Implements bpp::UNode.

Implemented in bpp::TNode, and bpp::BasicTNode.

---

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

• Bpp/Graph/ONode.h