JSC.h File Reference

Compression and lookup utilities for the JS8Call wordlist. More...

#include <QList>
#include <QMap>
#include <QPair>
#include <QStringList>
#include <QTextStream>
#include <QVector>

Include dependency graph for JSC.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	Tuple
	Small mapping tuple used in the static lookup arrays. More...
class	JSC
	Static compressor/lookup helper for JS8Call. More...

Typedefs
typedef QPair< QVector< bool >, quint32 >	CodewordPair
	Tuple containing a codeword bit-vector and an associated integer.
typedef QVector< bool >	Codeword
	Codeword bit-vector type.
typedef struct Tuple	Tuple
	Small mapping tuple used in the static lookup arrays.

Detailed Description

Compression and lookup utilities for the JS8Call wordlist.

The JSC utilities implement static helpers used to compress and decompress strings to and from a compact bit-oriented codeword representation. The header exposes small convenience types and the in-memory lookup tables used by the compressor.

Author

Jordan Sherer keybo.nosp@m.ard@.nosp@m.shere.nosp@m.r.or.nosp@m.g

Copyright

(c) 2018 Jordan Sherer

Typedef Documentation

Codeword

typedef QVector<bool> Codeword

Codeword bit-vector type.

Codeword bit-vector type.

Represents a sequence of bits composing a compressed codeword. It is implemented as a QVector<bool> and used throughout the compressor and decompressor APIs.

CodewordPair

typedef QPair<QVector<bool>, quint32> CodewordPair

Tuple containing a codeword bit-vector and an associated integer.

Tuple(Codeword, N) where N is the number of characters

This typedef aliases a QPair<Codeword, quint32> and is used to represent a codeword together with an auxiliary integer value such as the character count or an index. The first element is the bit-vector representation and the second is the associated unsigned integer.