huffman

package

v0.0.0-...-ecf7a0d Latest Latest Go to latest Published: Apr 5, 2016 License: MIT Imports: 2 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package huffman implements Huffman prefix coding.

View Source

const TreeSelectionLimit = 50

TreeSelectionLimit is the symbol limit for each tree selection.

This section is empty.

This section is empty.

type Code struct {
	Len  int
	Bits uint64
}

Code contains the bit code for a symbol.

type Node struct {
	Left  *Node
	Right *Node

	Value     uint16
	Frequency int
}

Node is a single node in the tree.

func (n Node) Leaf() bool

Leaf is used to check if the node has children.

type NodeQueue []*Node

NodeQueue is a priority queue that keeps track of nodes.

func (nq NodeQueue) Len() int

Len gets the number of nodes in the queue.

func (nq NodeQueue) Less(i, j int) bool

Less checks if the priority of node i is less than the priority of node j.

func (nq *NodeQueue) Pop() interface{}

Pop pops the lowest priority node from the queue.

func (nq *NodeQueue) Push(x interface{})

Push pushes a new node to the queue.

func (nq NodeQueue) Swap(i, j int)

Swap swaps the nodes i and j.

type Tree struct {
	Codes []*Code
	// contains filtered or unexported fields
}

Tree is a binary tree that is navigated to produce bits for the frequencies of symbols.

func GenerateTrees(freqs rle2.Frequencies, src []uint16) ([]*Tree, []int)

GenerateTrees creates the trees required to encode the data, and which tree to use for each 50 symbol block of data in src.

func NewTree(freqs rle2.Frequencies) *Tree

NewTree creates a huffman tree and gets the codes for the symbol frequencies given.