Octane Reference Manual v1.01.20

Generated by Doxygen 1.3.3

Thu May 20 05:47:44 2004

Contents

1 The Open Compression Toolkit for C++ 1

1.1 Contents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

2 Octane Module Index 3

2.1 Octane Modules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

3 Octane Hierarchical Index 5

3.1 Octane Class Hierarchy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

4 Octane Compound Index 7

4.1 Octane Compound List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

5 Octane File Index 9

5.1 Octane File List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

6 Octane Page Index 11

6.1 Octane Related Pages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

7 Octane Module Documentation 13

7.1 bitio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13

7.2 Coders. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15

7.3 Compressors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16

7.4 Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17

7.5 Core . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18

7.6 Modelers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19

7.7 Parsers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20

8 Octane Class Documentation 21

8.1 arraybitreader Class Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

8.2 arraybitwriter Class Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

8.3 BitParser Class Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

ii CONTENTS

8.4 bitreader Class Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

8.5 bitwriter Class Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

8.6 CompressorManager Class Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

8.7 CompressorManagerSingletonInsurer Class Reference. . . . . . . . . . . . . . . . . . . 58

8.8 file bitreader Class Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

8.9 file bitwriter Class Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

8.10 HuffmanCoder Class Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

8.11 HuffNode Class Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

8.12 HuffNodeLeaf Class Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

8.13 HuffNodeMiddle Class Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

8.14 mtfllCompressor Class Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

8.15 null bitreader Class Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

8.16 null bitwriter Class Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

8.17 OctaneClass Class Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

8.18 OctaneCoder Class Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

8.19 OctaneCompressor Class Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

8.20 OctaneCompressorStatistical Class Reference. . . . . . . . . . . . . . . . . . . . . . . .108

8.21 OctaneModeler Class Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .117

8.22 OctaneModelerWeightVectored Class Reference. . . . . . . . . . . . . . . . . . . . . .122

8.23 OctaneParser Class Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .126

8.24 OctaneScopeTimer Class Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . .131

8.25 OctaneTester Class Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .133

8.26 OctaneTimer Class Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .155

8.27 PQWeightGreater< T > Class Template Reference. . . . . . . . . . . . . . . . . . . . .157

8.28 SampleCoder Class Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .158

8.29 SampleCompressor Class Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . .162

8.30 SampleModeler Class Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .169

8.31 SampleParser Class Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .172

8.32 SampleStatCompressor Class Reference. . . . . . . . . . . . . . . . . . . . . . . . . . .178

8.33 streambitreader Class Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .180

8.34 streambitwriter Class Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .182

8.35 stringbitreader Class Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .184

8.36 stringbitwriter Class Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .187

8.37 stringparser Class Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .189

8.38 SubStrHuffCompressor Class Reference. . . . . . . . . . . . . . . . . . . . . . . . . . .191

8.39 SubstringParser Class Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .193

Generated on Thu May 20 05:48:10 2004 for Octane by Doxygen

CONTENTS iii

8.40 SubstringSymbol Class Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .203

8.41 SymbolWeightVector Class Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . .205

8.42 TSubstringSymbolStringGreater< T > Class Template Reference. . . . . . . . . . . . . 210

8.43 TSubstringSymbolWeightGreater< T > Class Template Reference. . . . . . . . . . . . . 211

8.44 vectorbitreader Class Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .212

8.45 vectorbitwriter Class Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .215

8.46 ZeroOrderModeler Class Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . .217

8.47 zleCompressor Class Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .219

9 Octane File Documentation 223

9.1 bitio/bitio.hpp File Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .223

9.2 bitio/bitreader.hpp File Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .224

9.3 bitio/bitreaders.hpp File Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .225

9.4 bitio/bitwriter.cpp File Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .226

9.5 bitio/bitwriter.hpp File Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .227

9.6 bitio/bitwriters.hpp File Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .228

9.7 bitio/file bitreader.hpp File Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . .229

9.8 bitio/file bitwriter.hpp File Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . .230

9.9 coders/coder.cpp File Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .231

9.10 coders/coder.hpp File Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .232

9.11 coders/coderhuffman/huffmancoder.cpp File Reference. . . . . . . . . . . . . . . . . . . 233

9.12 coders/coderhuffman/huffmancoder.hpp File Reference. . . . . . . . . . . . . . . . . . 234

9.13 coders/coderhuffman/huffmannodes.cpp File Reference. . . . . . . . . . . . . . . . . . 235

9.14 coders/coderhuffman/huffmannodes.hpp File Reference. . . . . . . . . . . . . . . . . . 236

9.15 coders/codersample/samplecoder.cpp File Reference. . . . . . . . . . . . . . . . . . . . 238

9.16 coders/codersample/samplecoder.hpp File Reference. . . . . . . . . . . . . . . . . . . . 239

9.17 compressors/compressor.cpp File Reference. . . . . . . . . . . . . . . . . . . . . . . . .240

9.18 compressors/compressor.hpp File Reference. . . . . . . . . . . . . . . . . . . . . . . . .241

9.19 compressors/compressormtfll/mtfll.cpp File Reference. . . . . . . . . . . . . . . . . . . 242

9.20 compressors/compressormtfll/mtfll.hpp File Reference. . . . . . . . . . . . . . . . . . . 243

9.21 compressors/compressorsample/samplecompressor.cpp File Reference. . . . . . . . . . 244

9.22 compressors/compressorsample/samplecompressor.hpp File Reference. . . . . . . . . . 245

9.23 compressors/compressorsample/samplestatcompressor.cpp File Reference. . . . . . . . . 246

9.24 compressors/compressorsample/samplestatcompressor.hpp File Reference. . . . . . . . 247

9.25 compressors/compressorstatistical.cpp File Reference. . . . . . . . . . . . . . . . . . . 248

9.26 compressors/compressorstatistical.hpp File Reference. . . . . . . . . . . . . . . . . . . 249

9.27 compressors/compressorsubstrhuff/substrhuff.cpp File Reference. . . . . . . . . . . . . 250