#include <path_position_handle_graph.hpp>
Inheritance diagram for handlegraph::PathPositionHandleGraph:
Public Member Functions | |
| virtual | ~PathPositionHandleGraph ()=default |
| virtual size_t | get_path_length (const path_handle_t &path_handle) const =0 |
| Returns the length of a path measured in bases of sequence. More... | |
| virtual size_t | get_position_of_step (const step_handle_t &step) const =0 |
| virtual step_handle_t | get_step_at_position (const path_handle_t &path, const size_t &position) const =0 |
| virtual bool | for_each_step_position_on_handle (const handle_t &handle, const std::function< bool(const step_handle_t &, const bool &, const size_t &)> &iteratee) const |
 Public Member Functions inherited from handlegraph::PathHandleGraph | |
| virtual | ~PathHandleGraph ()=default |
| virtual size_t | get_path_count () const =0 |
| Returns the number of paths stored in the graph. More... | |
| virtual bool | has_path (const std::string &path_name) const =0 |
| Determine if a path name exists and is legal to get a path handle for. More... | |
| virtual path_handle_t | get_path_handle (const std::string &path_name) const =0 |
| virtual std::string | get_path_name (const path_handle_t &path_handle) const =0 |
| Look up the name of a path from a handle to it. More... | |
| virtual bool | get_is_circular (const path_handle_t &path_handle) const =0 |
| Look up whether a path is circular. More... | |
| virtual size_t | get_step_count (const path_handle_t &path_handle) const =0 |
| Returns the number of node steps in the path. More... | |
| virtual size_t | get_step_count (const handle_t &handle) const |
| Returns the number of node steps on a handle. More... | |
| virtual handle_t | get_handle_of_step (const step_handle_t &step_handle) const =0 |
| Get a node handle (node ID and orientation) from a handle to an step on a path. More... | |
| virtual path_handle_t | get_path_handle_of_step (const step_handle_t &step_handle) const =0 |
| Returns a handle to the path that an step is on. More... | |
| virtual step_handle_t | path_begin (const path_handle_t &path_handle) const =0 |
| virtual step_handle_t | path_end (const path_handle_t &path_handle) const =0 |
| virtual step_handle_t | path_back (const path_handle_t &path_handle) const =0 |
| virtual step_handle_t | path_front_end (const path_handle_t &path_handle) const =0 |
| virtual bool | has_next_step (const step_handle_t &step_handle) const =0 |
| Returns true if the step is not the last step in a non-circular path. More... | |
| virtual bool | has_previous_step (const step_handle_t &step_handle) const =0 |
| Returns true if the step is not the first step in a non-circular path. More... | |
| virtual step_handle_t | get_next_step (const step_handle_t &step_handle) const =0 |
| virtual step_handle_t | get_previous_step (const step_handle_t &step_handle) const =0 |
| template<typename Iteratee > | |
| bool | for_each_path_handle (const Iteratee &iteratee) const |
| template<typename Iteratee > | |
| bool | for_each_step_on_handle (const handle_t &handle, const Iteratee &iteratee) const |
| virtual std::vector< step_handle_t > | steps_of_handle (const handle_t &handle, bool match_orientation=false) const |
| virtual bool | is_empty (const path_handle_t &path_handle) const |
| Returns true if the given path is empty, and false otherwise. More... | |
| PathForEachSocket | scan_path (const path_handle_t &path) const |
| template<typename Iteratee > | |
| bool | for_each_step_in_path (const path_handle_t &path, const Iteratee &iteratee) const |
| Public Member Functions inherited from handlegraph::HandleGraph | |
| virtual | ~HandleGraph ()=default |
| virtual bool | has_node (nid_t node_id) const =0 |
| Method to check if a node exists by ID. More... | |
| virtual handle_t | get_handle (const nid_t &node_id, bool is_reverse=false) const =0 |
| Look up the handle for the node with the given ID in the given orientation. More... | |
| virtual nid_t | get_id (const handle_t &handle) const =0 |
| Get the ID from a handle. More... | |
| virtual bool | get_is_reverse (const handle_t &handle) const =0 |
| Get the orientation of a handle. More... | |
| virtual handle_t | flip (const handle_t &handle) const =0 |
| Invert the orientation of a handle (potentially without getting its ID) More... | |
| virtual size_t | get_length (const handle_t &handle) const =0 |
| Get the length of a node. More... | |
| virtual std::string | get_sequence (const handle_t &handle) const =0 |
| virtual size_t | get_node_count () const =0 |
| Return the number of nodes in the graph. More... | |
| virtual nid_t | min_node_id () const =0 |
| virtual nid_t | max_node_id () const =0 |
| 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 |
| Public Member Functions inherited from handlegraph::PathMetadata | |
| virtual | ~PathMetadata ()=default |
| virtual PathSense | get_sense (const path_handle_t &handle) const |
| What is the given path meant to be representing? More... | |
| virtual std::string | get_sample_name (const path_handle_t &handle) const |
| virtual std::string | get_locus_name (const path_handle_t &handle) const |
| virtual size_t | get_haplotype (const path_handle_t &handle) const |
| virtual size_t | get_phase_block (const path_handle_t &handle) const |
| virtual subrange_t | get_subrange (const path_handle_t &handle) const |
| template<typename Iteratee > | |
| bool | for_each_path_of_sense (const PathSense &sense, const Iteratee &iteratee) const |
| template<typename Iteratee > | |
| bool | for_each_path_of_sample (const std::string &sample, const Iteratee &iteratee) const |
| template<typename Iteratee > | |
| bool | for_each_path_matching (const std::unordered_set< PathSense > *senses, const std::unordered_set< std::string > *samples, const std::unordered_set< std::string > *loci, const Iteratee &iteratee) const |
| template<typename Iteratee > | |
| bool | for_each_path_matching (const std::unordered_set< PathSense > &senses, const std::unordered_set< std::string > &samples, const std::unordered_set< std::string > &loci, const Iteratee &iteratee) const |
| template<typename Iteratee > | |
| bool | for_each_step_of_sense (const handle_t &visited, const PathSense &sense, const Iteratee &iteratee) const |
Additional Inherited Members | |
| Static Public Member Functions inherited from handlegraph::PathMetadata | |
| static PathSense | parse_sense (const std::string &path_name) |
| static std::string | parse_sample_name (const std::string &path_name) |
| static std::string | parse_locus_name (const std::string &path_name) |
| static size_t | parse_haplotype (const std::string &path_name) |
| static size_t | parse_phase_block (const std::string &path_name) |
| static subrange_t | parse_subrange (const std::string &path_name) |
| static void | parse_path_name (const std::string &path_name, PathSense &sense, std::string &sample, std::string &locus, size_t &haplotype, size_t &phase_block, subrange_t &subrange) |
| Decompose a formatted path name into metadata. More... | |
| static std::string | create_path_name (const PathSense &sense, const std::string &sample, const std::string &locus, const size_t &haplotype, const size_t &phase_block, const subrange_t &subrange) |
| Static Public Attributes inherited from handlegraph::PathMetadata | |
| static const std::string | NO_SAMPLE_NAME = "" |
| static const std::string | NO_LOCUS_NAME = "" |
| static const size_t | NO_HAPLOTYPE = std::numeric_limits<size_t>::max() |
| static const size_t | NO_PHASE_BLOCK = std::numeric_limits<size_t>::max() |
| static const subrange_t | NO_SUBRANGE {PathMetadata::NO_END_POSITION, PathMetadata::NO_END_POSITION} |
| static const offset_t | NO_END_POSITION = std::numeric_limits<offset_t>::max() |
| Protected Member Functions inherited from handlegraph::PathHandleGraph | |
| virtual bool | for_each_path_handle_impl (const std::function< bool(const path_handle_t &)> &iteratee) const =0 |
| virtual bool | for_each_step_on_handle_impl (const handle_t &handle, const std::function< bool(const step_handle_t &)> &iteratee) const =0 |
| 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 |
| Protected Member Functions inherited from handlegraph::PathMetadata | |
| virtual bool | for_each_path_matching_impl (const std::unordered_set< PathSense > *senses, const std::unordered_set< std::string > *samples, const std::unordered_set< std::string > *loci, const std::function< bool(const path_handle_t &)> &iteratee) const |
| virtual bool | for_each_step_of_sense_impl (const handle_t &visited, const PathSense &sense, const std::function< bool(const step_handle_t &)> &iteratee) const |
Detailed Description
This is the interface for a path handle graph with path positions
Constructor & Destructor Documentation
◆ ~PathPositionHandleGraph()
|
virtualdefault |
Member Function Documentation
◆ for_each_step_position_on_handle()
|
virtual |
Execute an iteratee on each step on a path, along with its orientation relative to the path (true if it is reverse the orientation of the handle on the path), and its position measured in bases of sequence along the path. Positions are always measured on the forward strand.
Iteration will stop early if the iteratee returns false. This method returns false if iteration was stopped early, else true
Reimplemented in vg::MemoizingGraph.
◆ get_path_length()
|
pure virtual |
Returns the length of a path measured in bases of sequence.
Implemented in xg::XG, and vg::MemoizingGraph.
◆ get_position_of_step()
|
pure virtual |
Returns the position along the path of the beginning of this step measured in bases of sequence. In a circular path, positions start at the step returned by path_begin().
Implemented in xg::XG, and vg::MemoizingGraph.
◆ get_step_at_position()
|
pure virtual |
Returns the step at this position, measured in bases of sequence starting at the step returned by path_begin(). If the position is past the end of the path, returns path_end().
Implemented in xg::XG, and vg::MemoizingGraph.
The documentation for this class was generated from the following files:
- deps/libhandlegraph/src/include/handlegraph/path_position_handle_graph.hpp
- deps/libhandlegraph/src/path_position_handle_graph.cpp
