Home - jltsiren/gbwtgraph GitHub Wiki

Documentation

• Version history

Public interface

Everything is in namespace gbwtgraph. Use linker option -lgbwtgraph to link against the GBWTGraph library.

Main interface

• gbwtgraph.h: GBWTGraph interface
  • Includes utils.h
• gbz.h: GBZ file format
  • Includes gbwtgraph.h
• minimizer.h: Minimizer index interface
  • Includes utils.h

Construction

• gfa.h: GBWTGraph construction from GFA
  • Includes gbwtgraph.h
• index.h: Minimizer index construction from GBWTGraph
  • Includes gbwtgraph.h
  • Includes minimizer.h
• path_cover.h: GBWT construction from a greedy path cover of a graph
  • Includes gbwtgraph.h

Utilities

• algorithms.h: Graph algorithms
  • Includes gbwtgraph.h
• cached_gbwtgraph.h: Cached GBWTGraph interface
  • Includes gbwtgraph.h
• subgraph.h: Subgraph queries
  • Includes gbz.h
• utils.h: Utilities and definitions