bioprocessing  5.1.2
bio::BaseGraphRef< E > Class Template Reference

Reference to a BaseGraph. More...

#include <bioprocessing/graph/basegraph.h>

Inheritance diagram for bio::BaseGraphRef< E >:
Collaboration diagram for bio::BaseGraphRef< E >:

Public Types

typedef Pointed::Vertex Vertex
 
typedef Pointed::Edge Edge
 
typedef Pointed::Graph Graph
 

Public Member Functions

 BaseGraphRef ()
 
 BaseGraphRef (Pointed *g)
 
 BaseGraphRef (const Base &other)
 
virtual ~BaseGraphRef ()
 
virtual void insert (Vertex v)
 
virtual void insert (Edge e)
 
virtual bool contains (const Vertex &v) const
 
virtual bool contains (const Edge &e) const
 
virtual bool empty () const
 
virtual void clear ()
 
virtual bool operator== (const This &other) const
 
virtual bool operator!= (const This &other) const
 
virtual bool operator> (const This &other) const
 
virtual bool operator< (const This &other) const
 
virtual bool operator>= (const This &other) const
 
virtual bool operator<= (const This &other) const
 
virtual bool isAdjacent (const Vertex &x, const Vertex &y) const
 
virtual bool isLinked (const Vertex &x, const Vertex &y) const
 
virtual bool isSubGraph (const Graph &g) const
 
virtual bool isConnectedComponent (const Graph &g) const
 
virtual bool isAdjacentTo (const Vertex &v, const Graph &g) const
 
virtual bool isAdjacentFrom (const Vertex &v, const Graph &g) const
 
virtual bool isAdjacent (const Edge &e) const
 
virtual bool isLinked (const Vertex &v) const
 
virtual bool isExtension (const Graph &h, const Graph &g) const
 
virtual bool isForestRelativeTo (const Graph &h, const Graph &g) const
 
virtual bool isSpanningForestRelativeTo (const Graph &h, const Graph &g) const
 
virtual bool isTree (const Graph &g) const
 
virtual bool isSpanningTree (const Graph &g) const
 
virtual bool isForest (const Graph &g) const
 
virtual bool isSpanningForest (const Graph &g) const
 
template<typename EdgeIterator >
bool isGraphCut (EdgeIterator begin, EdgeIterator end, const Graph &g) const
 
template<typename EdgeSet >
bool isGraphCut (const EdgeSet &es, const Graph &g) const
 

Static Public Member Functions

static Graph none ()
 
template<typename Set >
static Set getComplement (const Set &s, const Set &e)
 

Protected Types

typedef carto::rc_ptr< BaseGraph< E > > Base
 
typedef BaseGraph< E > Pointed
 
typedef BaseGraphRef< E > This
 

Friends

class BaseGraph< E >
 

Detailed Description

template<typename E>
class bio::BaseGraphRef< E >

Reference to a BaseGraph.

This utility class is the entry point to graphs. It permits to avoid unnecessary copys of big structures, while giving access to all the necessary methods.

Definition at line 311 of file basegraph.h.

Member Typedef Documentation

◆ Base

template<typename E >
typedef carto::rc_ptr<BaseGraph<E> > bio::BaseGraphRef< E >::Base
protected

Definition at line 315 of file basegraph.h.

◆ Edge

template<typename E >
typedef Pointed::Edge bio::BaseGraphRef< E >::Edge

Definition at line 320 of file basegraph.h.

◆ Graph

template<typename E >
typedef Pointed::Graph bio::BaseGraphRef< E >::Graph

Definition at line 321 of file basegraph.h.

◆ Pointed

template<typename E >
typedef BaseGraph<E> bio::BaseGraphRef< E >::Pointed
protected

Definition at line 316 of file basegraph.h.

◆ This

template<typename E >
typedef BaseGraphRef<E> bio::BaseGraphRef< E >::This
protected

Definition at line 317 of file basegraph.h.

◆ Vertex

template<typename E >
typedef Pointed::Vertex bio::BaseGraphRef< E >::Vertex

Definition at line 319 of file basegraph.h.

Constructor & Destructor Documentation

◆ BaseGraphRef() [1/3]

template<typename E >
bio::BaseGraphRef< E >::BaseGraphRef ( )
inline

Definition at line 325 of file basegraph.h.

◆ BaseGraphRef() [2/3]

template<typename E >
bio::BaseGraphRef< E >::BaseGraphRef ( Pointed g)
inline

Definition at line 326 of file basegraph.h.

◆ BaseGraphRef() [3/3]

template<typename E >
bio::BaseGraphRef< E >::BaseGraphRef ( const Base other)
inline

Definition at line 327 of file basegraph.h.

◆ ~BaseGraphRef()

template<typename E >
virtual bio::BaseGraphRef< E >::~BaseGraphRef ( )
inlinevirtual

Definition at line 328 of file basegraph.h.

Member Function Documentation

◆ clear()

template<typename E >
virtual void bio::BaseGraphRef< E >::clear ( )
inlinevirtual

Definition at line 341 of file basegraph.h.

◆ contains() [1/2]

template<typename E >
virtual bool bio::BaseGraphRef< E >::contains ( const Edge e) const
inlinevirtual

Definition at line 339 of file basegraph.h.

◆ contains() [2/2]

template<typename E >
virtual bool bio::BaseGraphRef< E >::contains ( const Vertex v) const
inlinevirtual

Definition at line 338 of file basegraph.h.

◆ empty()

template<typename E >
virtual bool bio::BaseGraphRef< E >::empty ( ) const
inlinevirtual

Definition at line 340 of file basegraph.h.

◆ getComplement()

template<typename E >
template<typename Set >
static Set bio::BaseGraphRef< E >::getComplement ( const Set &  s,
const Set &  e 
)
inlinestatic

Definition at line 406 of file basegraph.h.

◆ insert() [1/2]

template<typename E >
virtual void bio::BaseGraphRef< E >::insert ( Edge  e)
inlinevirtual

Definition at line 337 of file basegraph.h.

◆ insert() [2/2]

template<typename E >
virtual void bio::BaseGraphRef< E >::insert ( Vertex  v)
inlinevirtual

Definition at line 336 of file basegraph.h.

◆ isAdjacent() [1/2]

template<typename E >
virtual bool bio::BaseGraphRef< E >::isAdjacent ( const Edge e) const
inlinevirtual

Definition at line 389 of file basegraph.h.

◆ isAdjacent() [2/2]

template<typename E >
virtual bool bio::BaseGraphRef< E >::isAdjacent ( const Vertex x,
const Vertex y 
) const
inlinevirtual

Reimplemented in bio::VolumeGraphRef< T, P >, and bio::VolumeGraphRef< T, Point >.

Definition at line 383 of file basegraph.h.

◆ isAdjacentFrom()

template<typename E >
virtual bool bio::BaseGraphRef< E >::isAdjacentFrom ( const Vertex v,
const Graph g 
) const
inlinevirtual

Reimplemented in bio::VolumeGraphRef< T, P >, and bio::VolumeGraphRef< T, Point >.

Definition at line 388 of file basegraph.h.

◆ isAdjacentTo()

template<typename E >
virtual bool bio::BaseGraphRef< E >::isAdjacentTo ( const Vertex v,
const Graph g 
) const
inlinevirtual

Reimplemented in bio::VolumeGraphRef< T, P >, and bio::VolumeGraphRef< T, Point >.

Definition at line 387 of file basegraph.h.

◆ isConnectedComponent()

template<typename E >
virtual bool bio::BaseGraphRef< E >::isConnectedComponent ( const Graph g) const
inlinevirtual

Reimplemented in bio::VolumeGraphRef< T, P >, and bio::VolumeGraphRef< T, Point >.

Definition at line 386 of file basegraph.h.

◆ isExtension()

template<typename E >
virtual bool bio::BaseGraphRef< E >::isExtension ( const Graph h,
const Graph g 
) const
inlinevirtual

Definition at line 391 of file basegraph.h.

◆ isForest()

template<typename E >
virtual bool bio::BaseGraphRef< E >::isForest ( const Graph g) const
inlinevirtual

Definition at line 396 of file basegraph.h.

◆ isForestRelativeTo()

template<typename E >
virtual bool bio::BaseGraphRef< E >::isForestRelativeTo ( const Graph h,
const Graph g 
) const
inlinevirtual

Definition at line 392 of file basegraph.h.

◆ isGraphCut() [1/2]

template<typename E >
template<typename EdgeSet >
bool bio::BaseGraphRef< E >::isGraphCut ( const EdgeSet &  es,
const Graph g 
) const
inline

Definition at line 401 of file basegraph.h.

◆ isGraphCut() [2/2]

template<typename E >
template<typename EdgeIterator >
bool bio::BaseGraphRef< E >::isGraphCut ( EdgeIterator  begin,
EdgeIterator  end,
const Graph g 
) const
inline

Definition at line 399 of file basegraph.h.

◆ isLinked() [1/2]

template<typename E >
virtual bool bio::BaseGraphRef< E >::isLinked ( const Vertex v) const
inlinevirtual

Definition at line 390 of file basegraph.h.

◆ isLinked() [2/2]

template<typename E >
virtual bool bio::BaseGraphRef< E >::isLinked ( const Vertex x,
const Vertex y 
) const
inlinevirtual

Reimplemented in bio::VolumeGraphRef< T, P >, and bio::VolumeGraphRef< T, Point >.

Definition at line 384 of file basegraph.h.

◆ isSpanningForest()

template<typename E >
virtual bool bio::BaseGraphRef< E >::isSpanningForest ( const Graph g) const
inlinevirtual

Definition at line 397 of file basegraph.h.

◆ isSpanningForestRelativeTo()

template<typename E >
virtual bool bio::BaseGraphRef< E >::isSpanningForestRelativeTo ( const Graph h,
const Graph g 
) const
inlinevirtual

Definition at line 393 of file basegraph.h.

◆ isSpanningTree()

template<typename E >
virtual bool bio::BaseGraphRef< E >::isSpanningTree ( const Graph g) const
inlinevirtual

Definition at line 395 of file basegraph.h.

◆ isSubGraph()

template<typename E >
virtual bool bio::BaseGraphRef< E >::isSubGraph ( const Graph g) const
inlinevirtual

Reimplemented in bio::VolumeGraphRef< T, P >, and bio::VolumeGraphRef< T, Point >.

Definition at line 385 of file basegraph.h.

◆ isTree()

template<typename E >
virtual bool bio::BaseGraphRef< E >::isTree ( const Graph g) const
inlinevirtual

Definition at line 394 of file basegraph.h.

◆ none()

template<typename E >
static Graph bio::BaseGraphRef< E >::none ( )
inlinestatic

Definition at line 332 of file basegraph.h.

◆ operator!=()

template<typename E >
virtual bool bio::BaseGraphRef< E >::operator!= ( const This other) const
inlinevirtual

Definition at line 354 of file basegraph.h.

◆ operator<()

template<typename E >
virtual bool bio::BaseGraphRef< E >::operator< ( const This other) const
inlinevirtual

Definition at line 365 of file basegraph.h.

◆ operator<=()

template<typename E >
virtual bool bio::BaseGraphRef< E >::operator<= ( const This other) const
inlinevirtual

Definition at line 376 of file basegraph.h.

◆ operator==()

template<typename E >
virtual bool bio::BaseGraphRef< E >::operator== ( const This other) const
inlinevirtual

Definition at line 345 of file basegraph.h.

◆ operator>()

template<typename E >
virtual bool bio::BaseGraphRef< E >::operator> ( const This other) const
inlinevirtual

Definition at line 358 of file basegraph.h.

◆ operator>=()

template<typename E >
virtual bool bio::BaseGraphRef< E >::operator>= ( const This other) const
inlinevirtual

Definition at line 372 of file basegraph.h.

Friends And Related Function Documentation

◆ BaseGraph< E >

template<typename E >
friend class BaseGraph< E >
friend

Definition at line 406 of file basegraph.h.


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