Octane v1.01.20 - The Open Compression Toolkit for C++ http://octane.sourceforge.net/
Homepage | Main | Modules | Class Hierarchy | Compound List | File List | Compound Members | Related Pages

Octane Compound List

Here are the classes, structs, unions and interfaces with brief descriptions:
array_bitreaderSpecialization for C pointer to char
array_bitwriterSpecialization for C pointer to char
BitParserSample parser class is just character based, uses one symbol for each ascii character plus one for end-of-stream
bitreaderBase class for bit input wrappers
bitwriterBase class for bit output wrappers
CompressorManagerThe CompressorManager classes holds a collection of Compressor derived classes and is used for runtime selection of which algorithm to test
CompressorManager_SingletonInsurerThis is a sneaky little class which allows us to create self-registering compressors
file_bitreaderSpecialization for files
file_bitwriterSpecialization for files
HuffmanCoderDuring compression, the job of the Coder class is use probability information from the modeler to figure out the optimal bitcodes to use when writing symbols into the output stream
HuffNodeThe base HuffNode class is used to represent both leaf and internal HuffNodes
HuffNode_LeafThe leaves of the huffman tree contains actual symbol information
HuffNode_MiddleA derived huffman node for a node in the middle of the tree
mtfllCompressorExperimental move to front encoding using a linked list instead of tracing the array
null_bitreaderSpecialization without data
null_bitwriterSpecialization without data
OctaneClassBase class from which most octane classes derive (including parser,coder,modeler,etc)
OctaneCoderDuring compression, the job of the Coder class is use probability information from the modeler to figure out the optimal bitcodes to use when writing symbols into the output stream
OctaneCompressorThe Base Compressor class implements our generic interface to all compressors, and includes wrappers to measure compression/decompression times and diskspace
OctaneCompressor_StatisticalThe Statistical compressor class is a base class from which to derive specific statistical compressors that make use of the parser/modeler/coder framework
OctaneModelerThe Modeler class is for statistical compression methods
OctaneModeler_WeightVectoredThis is a derived modeler class which has some default functions for modelers which work with a vector of weights as probabilities (very common)
OctaneParserThe Base Parser class is responsible for dividing the input stream into a series of numerical symbols, and for converting symbol numbers to their symbol texts during decompression
OctaneScopeTimerSimple timer, measuring time from construction to destruction
OctaneTesterFunctions for testing compressors and providing a commandline and interactive interface to octane functions
OctaneTimerSimple class for timing code (low resolution)
PQWeightGreater< T >We need to make a special Greater<> classes used during sorting, since our collection stl elements are built from pointers, and the default sort will be done on pointer addresses instead of weights if we don't
SampleCoderThe Sample Coder is useful only as an example of how coders work
SampleCompressorThis Sample Statistical Compressor is a minimal example of how to coordinate the 3 components of the statistical compressor framework, a sample parser,modeler,and coder
SampleModelerThis is a sample modeler which simply ignores all 'training' information and assigns equal probability to each symbol in the parser (sometimes called a -1 order model)
SampleParserSample parser class is just character based, uses one symbol for each ascii character plus one for end-of-stream
SampleStatCompressorThis Sample Statistical Compressor is a minimal example of how to coordinate the 3 components of the statistical compressor framework, a sample parser,modeler,and coder
stream_bitreaderSpecialization for streams
stream_bitwriterSpecialization for streams
string_bitreaderSpecialization for string
string_bitwriterSpecialization for string
stringparserSimple string parser
SubStrHuffCompressorThe SubStrHuff Compressor is a basic Statistical compressor, that instantiates a Zero-order modeler, with a huffman coder, and a SubString parser
SubstringParserFlexible parser, which uses arbitrarily long substrings of text as symbols
SubstringSymbolThe SubString Symbol class represents the primitive symbols used by the SubString parser
SymbolWeightVectorHelper class which holds a vector of probabilities, typically associated with a modeler
TSubstringSymbolStringGreater< T >Greater operator for comparing strings of symbol pointers alphabetically
TSubstringSymbolWeightGreater< T >Greater operator for comparing weights of symbol pointers
vector_bitreaderSpecialization for vector<char>
vector_bitwriterSpecialization for vector<char>
ZeroOrderModelerA simple zero-order modeler, that builds its probability model by counting frequencies in a training file
zleCompressorThis is a zero-length-encoder, it performs run-length-encoding for 0 bytes only
 
Generated on 20 May 2004 by doxygen 1.3.3