The huffman Reference Manual

3.1.1 huffman/huffman.asd

Source

huffman.asd.

Parent Component

huffman (system).

ASDF Systems

huffman.

Packages

huffman-asd.

---

3.1.2 huffman/huffman.lisp

Source

huffman.asd.

Parent Component

huffman (system).

Packages

huffman.

Public Interface

• huffman-coding-map (reader method).
• huffman-coding-sequence (reader method).
• huffman-decode (function).
• huffman-encode (function).
• huffman-map-sequence (function).
• print-object (method).

Internals

• copy-node (function).
• huffman-coding (class).
• huffman-coding-type (reader method).
• make-leaf (function).
• make-node (function).
• make-root (function).
• make-tree (function).
• map-of-tree (function).
• node (structure).
• node-count (reader).
• (setf node-count) (writer).
• node-leaf (reader).
• (setf node-leaf) (writer).
• node-left (reader).
• (setf node-left) (writer).
• node-p (function).
• node-right (reader).
• (setf node-right) (writer).
• node-value (reader).
• (setf node-value) (writer).
• tree-of-map (function).

---

5.1.1 Ordinary functions

Function: huffman-decode (coding) ¶

Decode a bit vector with a Huffman encoding map.

Package

huffman.

Source

huffman.lisp.

Function: huffman-encode (seq &optional map) ¶

Generate a Huffman map of values to bit encodings and encode the sequence.

Package

huffman.

Source

huffman.lisp.

Function: huffman-map-sequence (seq) ¶

Return a hash-table of Huffman codes from a sequence.

Package

huffman.

Source

huffman.lisp.

---

5.1.2 Generic functions

Generic Reader: huffman-coding-map (object) ¶

Package

huffman.

Methods

Reader Method: huffman-coding-map ((huffman-coding huffman-coding)) ¶

automatically generated reader method

Source

huffman.lisp.

Target Slot

map.

Generic Reader: huffman-coding-sequence (object) ¶

Package

huffman.

Methods

Reader Method: huffman-coding-sequence ((huffman-coding huffman-coding)) ¶

automatically generated reader method

Source

huffman.lisp.

Target Slot

coding.

---

5.1.3 Standalone methods

Method: print-object ((obj huffman-coding) stream) ¶

Output a Huffman coding.

Source

huffman.lisp.

---

5.2.1 Ordinary functions

Function: copy-node (instance) ¶

Package

huffman.

Source

huffman.lisp.

Function: make-leaf (value &optional count) ¶

Create a Huffman tree leaf node.

Package

huffman.

Source

huffman.lisp.

Function: make-node (&key count leaf value left right) ¶

Package

huffman.

Source

huffman.lisp.

Function: make-root (left right) ¶

Create a Huffman tree root node.

Package

huffman.

Source

huffman.lisp.

Function: make-tree (seq) ¶

Generate a Huffman tree from a sequence of data.

Package

huffman.

Source

huffman.lisp.

Function: map-of-tree (tree) ¶

Return a hash-table mapping of values to bit-vector codes.

Package

huffman.

Source

huffman.lisp.

Reader: node-count (instance) ¶

Writer: (setf node-count) (instance) ¶

Package

huffman.

Source

huffman.lisp.

Target Slot

count.

Reader: node-leaf (instance) ¶

Writer: (setf node-leaf) (instance) ¶

Package

huffman.

Source

huffman.lisp.

Target Slot

leaf.

Reader: node-left (instance) ¶

Writer: (setf node-left) (instance) ¶

Package

huffman.

Source

huffman.lisp.

Target Slot

left.

Function: node-p (object) ¶

Package

huffman.

Source

huffman.lisp.

Reader: node-right (instance) ¶

Writer: (setf node-right) (instance) ¶

Package

huffman.

Source

huffman.lisp.

Target Slot

right.

Reader: node-value (instance) ¶

Writer: (setf node-value) (instance) ¶

Package

huffman.

Source

huffman.lisp.

Target Slot

value.

Function: tree-of-map (map) ¶

Return a binary tree of Huffman codes from a hash map.

Package

huffman.

Source

huffman.lisp.

---

5.2.2 Generic functions

Generic Reader: huffman-coding-type (object) ¶

Package

huffman.

Methods

Reader Method: huffman-coding-type ((huffman-coding huffman-coding)) ¶

automatically generated reader method

Source

huffman.lisp.

Target Slot

type.

---

5.2.3 Structures

Structure: node ¶

Huffman tree node.

Package

huffman.

Source

huffman.lisp.

Direct superclasses

structure-object.

Direct slots

Slot: count ¶

Package

common-lisp.

Readers

node-count.

Writers

(setf node-count).

Slot: leaf ¶

Readers

node-leaf.

Writers

(setf node-leaf).

Slot: value ¶

Readers

node-value.

Writers

(setf node-value).

Slot: left ¶

Readers

node-left.

Writers

(setf node-left).

Slot: right ¶

Readers

node-right.

Writers

(setf node-right).

---

5.2.4 Classes

Class: huffman-coding ¶

Return value from huffman-encode.

Package

huffman.

Source

huffman.lisp.

Direct methods

• huffman-coding-map.
• huffman-coding-sequence.
• huffman-coding-type.
• print-object.

Direct slots

Slot: coding ¶

Initargs

:coding

Readers

huffman-coding-sequence.

Writers

This slot is read-only.

Slot: map ¶

Package

common-lisp.

Initargs

:map

Readers

huffman-coding-map.

Writers

This slot is read-only.

Slot: type ¶

Package

common-lisp.

Initargs

:type

Readers

huffman-coding-type.

Writers

This slot is read-only.

---