NullTerminatorTemplate< Node, Edge, Graph > Class Template Reference

Null implementation of Terminator. More...

#include <Terminator.hpp>

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

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

Static Public Member Functions
static TerminatorTemplate< Node, Edge, Graph > &	singleton ()

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::NullTerminatorTemplate< Node, Edge, Graph >

Null implementation of Terminator.

This class provides a null implementation, which means that no marks are done.

Member Function Documentation

virtual void dump ( )

inlinevirtual

Dump (for debug purpose).

Implements TerminatorTemplate< Node, Edge, Graph >.

virtual bool is_branching ( Node &  node ) const

inlinevirtual

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 >.

virtual bool is_marked ( Edge &  edge ) const

inlinevirtual

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 >.

virtual bool is_marked ( Node &  node ) const

inlinevirtual

Implements TerminatorTemplate< Node, Edge, Graph >.

virtual bool is_marked_branching ( Node &  node ) const

inlinevirtual

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 >.

virtual bool isEnabled ( ) const

inlinevirtual

Tells whether marking nodes is allowed or not

Returns

true if marking nodes is allowed, false otherwise.

Reimplemented from TerminatorTemplate< Node, Edge, Graph >.

virtual void mark ( Edge &  edge )

inlinevirtual

Mark the provided edge

Parameters

[in]

edge

: edge to be marked.

Implements TerminatorTemplate< Node, Edge, Graph >.

virtual void mark ( Node &  node )

inlinevirtual

Implements TerminatorTemplate< Node, Edge, Graph >.

virtual void reset ( )

inlinevirtual

Reset the current marked nodes/edges.

Implements TerminatorTemplate< Node, Edge, Graph >.

static TerminatorTemplate<Node,Edge,Graph>& singleton ( )

inlinestatic

Singleton method.

Returns

a singleton instance.

---

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

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