BranchingTerminatorTemplate< Node, Edge, Graph > Class Template Reference

Implementation of Terminator that marks branching nodes. More...

#include <Terminator.hpp>

Inheritance diagram for BranchingTerminatorTemplate< Node, Edge, Graph >:

Public Member Functions
	BranchingTerminatorTemplate (const Graph &graph)
	BranchingTerminatorTemplate (const BranchingTerminatorTemplate &terminator)
	~BranchingTerminatorTemplate ()
void	mark (Edge &edge)
bool	is_marked (Edge &edge) const
void	mark (Node &node)
bool	is_marked (Node &node) const
bool	is_marked_branching (Node &node) const
bool	is_branching (Node &node) const
void	reset ()
void	dump ()
Public Member Functions inherited from TerminatorTemplate< Node, Edge, Graph >
	TerminatorTemplate (const Graph &graph)
virtual	~TerminatorTemplate ()
const Graph &	getGraph () const
virtual bool	isEnabled () const
Public Member Functions inherited from SmartPointer
void	use ()
void	forget ()
Public Member Functions inherited from ISmartPointer
virtual	~ISmartPointer ()

Additional Inherited Members
Protected Member Functions inherited from SmartPointer
	SmartPointer ()
virtual	~SmartPointer ()

Detailed Description

template<typename Node, typename Edge, typename Graph>
class gatb::core::debruijn::impl::BranchingTerminatorTemplate< Node, Edge, Graph >

Implementation of Terminator that marks branching nodes.

Constructor & Destructor Documentation

BranchingTerminatorTemplate

(

const Graph &

graph

)

Constructor

Parameters

[in]

graph

: the graph

BranchingTerminatorTemplate

(

const BranchingTerminatorTemplate< Node, Edge, Graph > &

terminator

)

Copy constructor

Parameters

[in]

terminator

the graph

~BranchingTerminatorTemplate

(

)

Destructor.

Member Function Documentation

void dump ( )

virtual

Dump (for debug purpose).

Implements TerminatorTemplate< Node, Edge, Graph >.

bool is_branching ( Node &  node ) const

virtual

Tells whether a node is branching

Parameters

[in]

node

: node to be checked

Returns

true if the node is branching, false otherwise.

Implements TerminatorTemplate< Node, Edge, Graph >.

bool is_marked ( Edge &  edge ) const

virtual

Tells whether an edge is marked

Parameters

[in]

edge

: edge to be checked

Returns

true if the edge is marked, false otherwise

Implements TerminatorTemplate< Node, Edge, Graph >.

bool is_marked ( Node &  node ) const

virtual

Implements TerminatorTemplate< Node, Edge, Graph >.

bool is_marked_branching ( Node &  node ) const

virtual

Tells whether a branching node is marked

Parameters

[in]

node

: node to be checked

Returns

true if the node is marked, false otherwise

Implements TerminatorTemplate< Node, Edge, Graph >.

void mark ( Edge &  edge )

virtual

Mark the provided edge

Parameters

[in]

edge

: edge to be marked.

Implements TerminatorTemplate< Node, Edge, Graph >.

void mark ( Node &  node )

virtual

Implements TerminatorTemplate< Node, Edge, Graph >.

void reset ( )

virtual

Reset the current marked nodes/edges.

Implements TerminatorTemplate< Node, Edge, Graph >.

---

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

• /builds/workspace/publish-doc-api-gitlab/gatb-core/src/gatb/debruijn/impl/Terminator.hpp
• /builds/workspace/publish-doc-api-gitlab/gatb-core/src/gatb/debruijn/impl/Terminator.cpp