gatb.core-API-0.0.0
Public Member Functions | Public Attributes | List of all members
Edge_t< Node_t > Struct Template Reference

Definition of an Edge, ie a transition between two nodes in the De Bruijn graph. More...

#include <Graph.hpp>

Inheritance diagram for Edge_t< Node_t >:
Inheritance graph

Public Member Functions

bool operator< (const Edge_t< Node_t > &other) const
 
void set (const typename Node_t::Value &kmer_from, kmer::Strand strand_from, const typename Node_t::Value &kmer_to, kmer::Strand strand_to, kmer::Nucleotide n, Direction dir)
 

Public Attributes

Node_t from
 
Node_t to
 
kmer::Nucleotide nt
 
Direction direction
 

Detailed Description

template<typename Node_t>
struct gatb::core::debruijn::impl::Edge_t< Node_t >

Definition of an Edge, ie a transition between two nodes in the De Bruijn graph.

The Edge structure represents an oriented transition between two nodes. Therefore, it holds:

  • the 'from' node
  • the 'to' node
  • the direction of the transition
  • the nucleotide that decorates the transition

The Edge objects are mainly provided by the Graph class, for instance when neighbors of a node are needed.

The Edge structure may be used as a template specialization type for some Graph class methods.

Member Function Documentation

bool operator< ( const Edge_t< Node_t > &  other) const
inline

Overload of operator <. May not really mean much to compare edges, but is used in Minia's graph simplifications

void set ( const typename Node_t::Value &  kmer_from,
kmer::Strand  strand_from,
const typename Node_t::Value &  kmer_to,
kmer::Strand  strand_to,
kmer::Nucleotide  n,
Direction  dir 
)
inline

Setter for some attributes of the Edge object.

Parameters
[in]kmer_from: kmer value of the 'from' Node
[in]strand_from: strand of the 'from' Node
[in]kmer_to: kmer value of the 'to' Node
[in]strand_to: strand of the 'to' Node
[in]n: the transition nucleotide
[in]dir: direction of the transition.

Member Data Documentation

Direction direction

The direction of the transition.

Node_t from

The source node of the edge.

kmer::Nucleotide nt

The transition nucleotide.

Node_t to

The target node of the edge.

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