huffslice

Documentation

Overview

Package huffslice compresses a slice using Huffman encoding.

Index

• type Encoder
  • func NewEncoder[T comparable](ln int, singleToken T) *Encoder[T]
  • func (e *Encoder[T]) Encode() *Slice[T]
• type Slice
  • func (s *Slice[T]) Iter() liter.Iter[T]

Types

type Encoder

type Encoder[T comparable] struct {
	Slice       slice.Slice[T]
	SingleToken T
}

Encoder is used to create the Slice.

func NewEncoder

func NewEncoder[T comparable](ln int, singleToken T) *Encoder[T]

NewEncoder creates a slice with a capacity of ln and sets the values for the single token.

func (*Encoder[T]) Encode

func (e *Encoder[T]) Encode() *Slice[T]

Encode to Slice.

type Slice

type Slice[T comparable] struct {
	huffman.Tree[T]
	Encoded *rye.Bits
	// Values that occure a single time are replaced wit SingleToken and stored
	// speratly from the Tree.
	Singles     slice.Slice[T]
	SingleToken T
}

Slice encoded using Huffman compression

func (*Slice[T]) Iter

func (s *Slice[T]) Iter() liter.Iter[T]

Iter creates an iterator for decoding the Slice.