vg
tools for working with variation graphs
Public Attributes | List of all members
vg::Snarl Struct Reference

Describes a subgraph that is connected to the rest of the graph by two nodes. More...

Public Attributes

SnarlType type = 1
 What type of snarl is this? More...
 
Visit start = 2
 Visits that connect the Snarl to the rest of the graph. More...
 
Visit end = 3
 
Snarl parent = 4
 
string name = 5
 Allows snarls to be named, e.g. by the hash of the VCF variant they come from. More...
 
bool start_self_reachable = 6
 
bool end_self_reachable = 7
 
bool start_end_reachable = 8
 Indicate whether the start of the Snarl is connected through to the end. More...
 
bool directed_acyclic_net_graph = 9
 Indicate whether the snarl's net graph is free of directed cycles. More...
 

Detailed Description

Describes a subgraph that is connected to the rest of the graph by two nodes.

Member Data Documentation

◆ directed_acyclic_net_graph

bool vg::Snarl::directed_acyclic_net_graph = 9

Indicate whether the snarl's net graph is free of directed cycles.

◆ end

Visit vg::Snarl::end = 3

points OUT OF the snarl

◆ end_self_reachable

bool vg::Snarl::end_self_reachable = 7

◆ name

string vg::Snarl::name = 5

Allows snarls to be named, e.g. by the hash of the VCF variant they come from.

◆ parent

Snarl vg::Snarl::parent = 4

If this Snarl is nested in another, this field should be filled in with a Snarl that has the start and end visits filled in (other information is optional/extraneous)

◆ start

Visit vg::Snarl::start = 2

Visits that connect the Snarl to the rest of the graph.

points INTO the snarl

◆ start_end_reachable

bool vg::Snarl::start_end_reachable = 8

Indicate whether the start of the Snarl is connected through to the end.

◆ start_self_reachable

bool vg::Snarl::start_self_reachable = 6

Indicate whether there is a reversing path contained in the Snarl from either the start to itself or the end to itself

◆ type

SnarlType vg::Snarl::type = 1

What type of snarl is this?


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