#include <path_subgraph.hpp>

Inheritance diagram for vg::PathSubgraph:

Public Member Functions
	PathSubgraph (const HandleGraph *base, const Path &path)

vector< handle_t >	get_topological_order () const
	Get a topological order very easily, since the path defines one. More...

virtual bool	has_node (id_t node_id) const
	HandleGraph interface. More...

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

virtual id_t	get_id (const handle_t &handle) const
	Get the ID from a handle. More...

virtual bool	get_is_reverse (const handle_t &handle) const
	Get the orientation of a handle. More...

virtual handle_t	flip (const handle_t &handle) const
	Invert the orientation of a handle (potentially without getting its ID) More...

virtual size_t	get_length (const handle_t &handle) const
	Get the length of a node. More...

virtual string	get_sequence (const handle_t &handle) const

virtual size_t	get_node_count () const
	Return the number of nodes in the graph. More...

virtual id_t	min_node_id () const

virtual id_t	max_node_id () const

virtual handle_t	get_underlying_handle (const handle_t &handle) const
	ExpandingOverlayGraph interface. More...

Path	translate_down (const Path &path_against_subgraph) const
	Additional Interface. More...

Public Member Functions inherited from handlegraph::ExpandingOverlayGraph
virtual	~ExpandingOverlayGraph ()=default

Public Member Functions inherited from handlegraph::HandleGraph
virtual	~HandleGraph ()=default

template<typename Iteratee >
bool	follow_edges (const handle_t &handle, bool go_left, const Iteratee &iteratee) const

template<typename Iteratee >
bool	for_each_handle (const Iteratee &iteratee, bool parallel=false) const

virtual size_t	get_degree (const handle_t &handle, bool go_left) const

virtual bool	has_edge (const handle_t &left, const handle_t &right) const

bool	has_edge (const edge_t &edge) const
	Convenient wrapper of has_edge for edge_t argument. More...

virtual size_t	get_edge_count () const

virtual size_t	get_total_length () const

virtual char	get_base (const handle_t &handle, size_t index) const

virtual std::string	get_subsequence (const handle_t &handle, size_t index, size_t size) const

handle_t	forward (const handle_t &handle) const
	Get the locally forward version of a handle. More...

edge_t	edge_handle (const handle_t &left, const handle_t &right) const

handle_t	traverse_edge_handle (const edge_t &edge, const handle_t &left) const

template<typename Iteratee >
bool	for_each_edge (const Iteratee &iteratee, bool parallel=false) const

Protected Member Functions
virtual bool	follow_edges_impl (const handle_t &handle, bool go_left, const function< bool(const handle_t &)> &iteratee) const

virtual bool	for_each_handle_impl (const function< bool(const handle_t &)> &iteratee, bool parallel=false) const

Protected Member Functions inherited from handlegraph::HandleGraph
virtual bool	follow_edges_impl (const handle_t &handle, bool go_left, const std::function< bool(const handle_t &)> &iteratee) const =0

virtual bool	for_each_handle_impl (const std::function< bool(const handle_t &)> &iteratee, bool parallel=false) const =0

Private Attributes
const HandleGraph *	super = nullptr

Path	defining_path

Detailed Description

A HandleGraph implementation that represents a subgraph of another HandleGraph, defined by a Path. The leading and trailing nodes are cut according to the Path. Supports translation of other Paths from this graph into the base graph.

Nodes are numbered 1 to n along the path; multiple visits on the path to the same backing node will become distinct.

Constructor & Destructor Documentation

◆ PathSubgraph()

vg::PathSubgraph::PathSubgraph	(	const HandleGraph *	base,
		const Path &	path
	)

Create a PathSubgraph describing the subgraph of the given graph defined by the given path. The path must not be empty. The path can take part of the start and end nodes, but all mappings must be perfect matches, and all adjacent mappings must properly cross a real edge.

Member Function Documentation

◆ flip()

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

virtual

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

Implements handlegraph::HandleGraph.

◆ follow_edges_impl()

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

protectedvirtual

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::PathSubgraph::for_each_handle_impl	(	const function< bool(const handle_t &)> &	iteratee,
		bool	parallel = `false`
	)		const

protectedvirtual

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::PathSubgraph::get_handle	(	const id_t &	node_id,
		bool	is_reverse = `false`
	)		const

virtual

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

Implements handlegraph::HandleGraph.

◆ get_id()

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

virtual

Get the ID from a handle.

Implements handlegraph::HandleGraph.

◆ get_is_reverse()

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

virtual

Get the orientation of a handle.

Implements handlegraph::HandleGraph.

◆ get_length()

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

virtual

Get the length of a node.

Implements handlegraph::HandleGraph.

◆ get_node_count()

size_t vg::PathSubgraph::get_node_count ( ) const

virtual

Return the number of nodes in the graph.

Implements handlegraph::HandleGraph.

◆ get_sequence()

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

virtual

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

Implements handlegraph::HandleGraph.

◆ get_topological_order()

vector< handle_t > vg::PathSubgraph::get_topological_order ( ) const

Get a topological order very easily, since the path defines one.

◆ get_underlying_handle()

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

virtual

ExpandingOverlayGraph interface.

Get the handle in the backing graph that the given handle in this graph represents.

Implements handlegraph::ExpandingOverlayGraph.

◆ has_node()

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

virtual

HandleGraph interface.

Method to check if a node exists by ID

Implements handlegraph::HandleGraph.

◆ max_node_id()

id_t vg::PathSubgraph::max_node_id ( ) const

virtual

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.

Implements handlegraph::HandleGraph.

◆ min_node_id()

id_t vg::PathSubgraph::min_node_id ( ) const

virtual

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.

Implements handlegraph::HandleGraph.

◆ translate_down()

Path vg::PathSubgraph::translate_down ( const Path & path_against_subgraph ) const

Additional Interface.

Translate a Path against us to a Path against the base graph

Member Data Documentation

◆ defining_path

Path vg::PathSubgraph::defining_path

private

◆ super

const HandleGraph* vg::PathSubgraph::super = nullptr

private

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

src/path_subgraph.hpp
src/path_subgraph.cpp

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PathSubgraph()

Member Function Documentation

◆ flip()

◆ follow_edges_impl()

◆ for_each_handle_impl()

◆ get_handle()

◆ get_id()

◆ get_is_reverse()

◆ get_length()

◆ get_node_count()

◆ get_sequence()

◆ get_topological_order()

◆ get_underlying_handle()

◆ has_node()

◆ max_node_id()

◆ min_node_id()

◆ translate_down()

Member Data Documentation

◆ defining_path

◆ super