vg
tools for working with variation graphs
Public Member Functions | Public Attributes | List of all members
handlegraph::net_handle_t Struct Reference

#include <types.hpp>

Public Member Functions

bool operator== (const net_handle_t &other) const
 Define equality on net handles. More...
 
bool operator!= (const net_handle_t &other) const
 Define inequality on net handles. More...
 

Public Attributes

char data [sizeof(nid_t)]
 

Detailed Description

A net handle is an opaque reference to a category of traversals of a single node, a chain, or the interior of a snarl, in the snarl decomposition of a graph.

Snarls and chains are bounded by two particular points, but the traversal may not visit both or any of them (as is the case for traversals between internal tips).

The handle refers to the snarl or chain itself and also a particular category of traversals of it. Each of the start and end of the traversal can be the start of the snarl/chain, the end of the snarl/chain, or some internal tip, for 6 distinct combinations.

For single nodes, we only have forward and reverse.

Member Function Documentation

◆ operator!=()

bool handlegraph::net_handle_t::operator!= ( const net_handle_t other) const

Define inequality on net handles.

◆ operator==()

bool handlegraph::net_handle_t::operator== ( const net_handle_t other) const

Define equality on net handles.

Member Data Documentation

◆ data

char handlegraph::net_handle_t::data[sizeof(nid_t)]

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