bwt

package module

v0.6.1 Latest Latest Go to latest Published: Aug 19, 2022 License: MIT Imports: 5 Imported by: 3

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

Repository

github.com/shenwei356/bwt

Links

Open Source Insights

README ¶

bwt

Burrows-Wheeler Transform and FM-index in golang

Install

This package is "go-gettable", just:

go get -u github.com/shenwei356/bwt

Licence

MIT License

Documentation ¶

Index ¶

Variables
func FromSuffixArray(s []byte, sa []int, es byte) ([]byte, error)
func InverseTransform(t []byte, es byte) []byte
func SuffixArray(s []byte) []int
func Transform(s []byte, es byte) ([]byte, error)
type SliceOfByteSlice

Constants ¶

This section is empty.

Variables ¶

View Source

var CheckEndSymbol = true

CheckEndSymbol is a global variable for checking end symbol before Burrows–Wheeler transform

View Source

var ErrEmptySeq = errors.New("bwt: empty sequence")

ErrEmptySeq means a empty sequence is given

View Source

var ErrEndSymbolExisted = errors.New("bwt: end-symbol existed in string")

ErrEndSymbolExisted means you should choose another EndSymbol

View Source

var ErrInvalidSuffixArray = errors.New("bwt: invalid suffix array")

ErrInvalidSuffixArray means length of sa is not equal to 1+len(s)

Functions ¶

func FromSuffixArray ¶

func FromSuffixArray(s []byte, sa []int, es byte) ([]byte, error)

FromSuffixArray compute BWT from sa

func InverseTransform ¶

func InverseTransform(t []byte, es byte) []byte

InverseTransform reverses the bwt to original byte slice. Not optimized yet.

func SuffixArray ¶

func SuffixArray(s []byte) []int

SuffixArray returns the suffix array of s. This function is the performance bottleneck of bwt and bwt/fmi package, with O(nlogn).

func Transform ¶

func Transform(s []byte, es byte) ([]byte, error)

Transform returns Burrows–Wheeler transform of a byte slice. See https://en.wikipedia.org/wiki/Burrows%E2%80%93Wheeler_transform

Types ¶

type SliceOfByteSlice ¶ added in v0.4.0

type SliceOfByteSlice [][]byte

SliceOfByteSlice is [][]byte

func (SliceOfByteSlice) Len ¶ added in v0.4.0

func (s SliceOfByteSlice) Len() int

func (SliceOfByteSlice) Less ¶ added in v0.4.0

func (s SliceOfByteSlice) Less(i, j int) bool

func (SliceOfByteSlice) Swap ¶ added in v0.4.0

func (s SliceOfByteSlice) Swap(i, j int)

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
fmi

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL