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

Detailed description

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

Definition at line 69 of file file_bwt_lz4.h.

#include <file_bwt_lz4.h>

Public Methods

 BWTLZ4Writer ()
 
 ~BWTLZ4Writer ()
 
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::BWTLZ4Writer::BWTLZ4Writer ( )

constructor

nvbio::BWTLZ4Writer::~BWTLZ4Writer ( )

destructor

Member Function Documentation

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

write to the bwt

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

write to the index

bool nvbio::BWTLZ4Writer::is_ok ( ) const

return whether the file is in a good state

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

open


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