vg
tools for working with variation graphs
Loading...
Searching...
No Matches
vg::ZipCodeTree::seed_result_t Struct Reference

#include <zip_code_tree.hpp>

Inheritance diagram for vg::ZipCodeTree::seed_result_t:
vg::ZipCodeTree::oriented_seed_t

Public Member Functions

 seed_result_t (size_t distance, size_t seed_index, bool is_reversed)
 Raw value constructor.
bool operator== (const seed_result_t &other) const
 Compare to other instances. TODO: Use default when we get C++20.
bool operator!= (const seed_result_t &other) const
 Compare to other instances. TODO: Use default when we get C++20.
Public Member Functions inherited from vg::ZipCodeTree::oriented_seed_t
 oriented_seed_t (size_t seed_index, bool is_reversed)
 Raw value constructor.
bool operator== (const oriented_seed_t &other) const
 Compare to other instances. TODO: Use default when we get C++20.
bool operator!= (const oriented_seed_t &other) const
 Compare to other instances. TODO: Use default when we get C++20.

Public Attributes

size_t distance
 The distance to the seed from some reference position.
Public Attributes inherited from vg::ZipCodeTree::oriented_seed_t
size_t seed
 The index of the seed in the seeds vector.
bool is_reversed
 Is the seed traversed backwards in the tree?

Detailed Description

Exposed type for a reference to an oriented seed at a distance

Constructor & Destructor Documentation

◆ seed_result_t()

vg::ZipCodeTree::seed_result_t::seed_result_t ( size_t distance,
size_t seed_index,
bool is_reversed )
inline

Raw value constructor.

Member Function Documentation

◆ operator!=()

bool vg::ZipCodeTree::seed_result_t::operator!= ( const seed_result_t & other) const
inline

Compare to other instances. TODO: Use default when we get C++20.

◆ operator==()

bool vg::ZipCodeTree::seed_result_t::operator== ( const seed_result_t & other) const
inline

Compare to other instances. TODO: Use default when we get C++20.

Member Data Documentation

◆ distance

size_t vg::ZipCodeTree::seed_result_t::distance

The distance to the seed from some reference position.


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