fse

Documentation

Overview

Package fse provides Finite State Entropy encoding.

Index

• Variables
• func Compress(in []byte, s *Scratch) ([]byte, error)
• func Decompress(b []byte, s *Scratch) ([]byte, error)
• type Scratch
  • func (s *Scratch) Histogram() []uint32
  • func (s *Scratch) HistogramFinished(maxSymbol uint8, maxCount int)

Variables

var (
	ErrIncompressible = errors.New("input is not compressible")
	ErrUseRLE         = errors.New("input is single value repeated")
)

Compression sentinel errors.

Functions

func Compress

func Compress(in []byte, s *Scratch) ([]byte, error)

Compress returns the FSE-compressed form of in.

func Decompress

func Decompress(b []byte, s *Scratch) ([]byte, error)

Decompress returns the FSE-decompressed form of b.

Types

type Scratch

type Scratch struct {
	Out             []byte
	DecompressLimit int

	MaxSymbolValue uint8
	TableLog       uint8
	// contains filtered or unexported fields
}

Scratch holds reusable state for FSE compression and decompression.

func (*Scratch) Histogram

func (s *Scratch) Histogram() []uint32

Histogram returns the symbol count histogram.

func (*Scratch) HistogramFinished

func (s *Scratch) HistogramFinished(maxSymbol uint8, maxCount int)

HistogramFinished marks the histogram as externally populated.