NVBIO
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Methods | List of all members
nvbio::BWTBGZWriter Struct Reference

Detailed description

A class to output the BWT to an BGZ-compressed binary file

Definition at line 75 of file file_bwt_bgz.h.

#include <file_bwt_bgz.h>

Public Methods

 BWTBGZWriter ()
 
 ~BWTBGZWriter ()
 
void open (const char *output_name, const char *index_name, const char *compression)
 open More...
 
uint32 bwt_write (const uint32 n_bytes, const void *buffer)
 
uint32 index_write (const uint32 n_bytes, const void *buffer)
 
bool is_ok () const
 

Constructor & Destructor Documentation

nvbio::BWTBGZWriter::BWTBGZWriter ( )

constructor

nvbio::BWTBGZWriter::~BWTBGZWriter ( )

destructor

Member Function Documentation

uint32 nvbio::BWTBGZWriter::bwt_write ( const uint32  n_bytes,
const void *  buffer 
)

write to the bwt

uint32 nvbio::BWTBGZWriter::index_write ( const uint32  n_bytes,
const void *  buffer 
)

write to the index

bool nvbio::BWTBGZWriter::is_ok ( ) const

return whether the file is in a good state

void nvbio::BWTBGZWriter::open ( const char *  output_name,
const char *  index_name,
const char *  compression 
)

open


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