#include <identity_overlay.hpp>

Inheritance diagram for vg::IdentityOverlay:

Public Member Functions
	IdentityOverlay (const HandleGraph *graph)
	IdentityOverlay ()=default
	Default constructor – not actually functional.
	~IdentityOverlay ()=default
	Default destructor.
bool	has_node (id_t node_id) const
	HandleGraph interface.
handle_t	get_handle (const id_t &node_id, bool is_reverse=false) const
	Look up the handle for the node with the given ID in the given orientation.
id_t	get_id (const handle_t &handle) const
	Get the ID from a handle.
bool	get_is_reverse (const handle_t &handle) const
	Get the orientation of a handle.
handle_t	flip (const handle_t &handle) const
	Invert the orientation of a handle (potentially without getting its ID).
size_t	get_length (const handle_t &handle) const
	Get the length of a node.
string	get_sequence (const handle_t &handle) const
bool	follow_edges_impl (const handle_t &handle, bool go_left, const function< bool(const handle_t &)> &iteratee) const
bool	for_each_handle_impl (const function< bool(const handle_t &)> &iteratee, bool parallel=false) const
size_t	get_node_count () const
	Return the number of nodes in the graph.
id_t	min_node_id () const
id_t	max_node_id () const
handle_t	get_underlying_handle (const handle_t &handle) const
	ExpandingOverlayGraph interface.

Private Attributes
const HandleGraph *	graph = nullptr
	The underlying graph.

Detailed Description

A HandleGraph overlay that does not modify the underlying graph but is still useful for providing a uniform interface when choosing between overlays.

Constructor & Destructor Documentation

◆ IdentityOverlay() [1/2]

vg::IdentityOverlay::IdentityOverlay ( const HandleGraph * graph )

Initialize as the reverse version of another graph, optionally also complementing

◆ IdentityOverlay() [2/2]

vg::IdentityOverlay::IdentityOverlay ( )

default

Default constructor – not actually functional.

◆ ~IdentityOverlay()

vg::IdentityOverlay::~IdentityOverlay ( )

default

Default destructor.

Member Function Documentation

◆ flip()

handle_t vg::IdentityOverlay::flip ( const handle_t & handle ) const

Invert the orientation of a handle (potentially without getting its ID).

◆ follow_edges_impl()

bool vg::IdentityOverlay::follow_edges_impl	(	const handle_t &	handle,
		bool	go_left,
		const function< bool(const handle_t &)> &	iteratee ) const

Loop over all the handles to next/previous (right/left) nodes. Passes them to a callback which returns false to stop iterating and true to continue. Returns true if we finished and false if we stopped early.

◆ for_each_handle_impl()

bool vg::IdentityOverlay::for_each_handle_impl	(	const function< bool(const handle_t &)> &	iteratee,
		bool	parallel = false ) const

Loop over all the nodes in the graph in their local forward orientations, in their internal stored order. Stop if the iteratee returns false. Can be told to run in parallel, in which case stopping after a false return value is on a best-effort basis and iteration order is not defined.

◆ get_handle()

handle_t vg::IdentityOverlay::get_handle	(	const id_t &	node_id,
		bool	is_reverse = false ) const

Look up the handle for the node with the given ID in the given orientation.

◆ get_id()

id_t vg::IdentityOverlay::get_id ( const handle_t & handle ) const

Get the ID from a handle.

◆ get_is_reverse()

bool vg::IdentityOverlay::get_is_reverse ( const handle_t & handle ) const

Get the orientation of a handle.

◆ get_length()

size_t vg::IdentityOverlay::get_length ( const handle_t & handle ) const

Get the length of a node.

◆ get_node_count()

size_t vg::IdentityOverlay::get_node_count ( ) const

Return the number of nodes in the graph.

◆ get_sequence()

string vg::IdentityOverlay::get_sequence ( const handle_t & handle ) const

Get the sequence of a node, presented in the handle's local forward orientation.

◆ get_underlying_handle()

handle_t vg::IdentityOverlay::get_underlying_handle ( const handle_t & handle ) const

ExpandingOverlayGraph interface.

Returns the handle in the underlying graph that corresponds to a handle in the overlay

◆ has_node()

bool vg::IdentityOverlay::has_node ( id_t node_id ) const

HandleGraph interface.

◆ max_node_id()

id_t vg::IdentityOverlay::max_node_id ( ) const

Return the largest ID in the graph, or some larger number if the largest ID is unavailable. Return value is unspecified if the graph is empty.

◆ min_node_id()

id_t vg::IdentityOverlay::min_node_id ( ) const

Return the smallest ID in the graph, or some smaller number if the smallest ID is unavailable. Return value is unspecified if the graph is empty.

Member Data Documentation

◆ graph

const HandleGraph* vg::IdentityOverlay::graph = nullptr

private

The underlying graph.

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

src/identity_overlay.hpp
src/identity_overlay.cpp

Public Member Functions

Private Attributes