mash

package

v1.4.0 Latest Latest Go to latest Published: Jan 1, 2026 License: MIT Imports: 8 Imported by: 0

Details

Package mash provides sequence MinHashing and Mash distance calculation.

This section is empty.

This section is empty.

func Distance(n, k int, s1, s2 []byte) float64

Distance returns the Mash distance between two sequences, using n hashes and k-long subsequences.

func FromJaccard(jac float64, k int) float64

FromJaccard returns the Mash distance given a Jaccard similarity.

type Masher struct {
	// contains filtered or unexported fields
}

A Masher min-hashes sequences and calculates Mash distances.

func New(n, k int) *Masher

New returns a new Masher with n hashes, k-long subsequences and seed 0.

func NewSeed(n, k int, seed uint32) *Masher

NewSeed returns a new Masher with n hashes, k-long subsequences and the given seed.

func (m *Masher) Add(seq []byte) *Masher

Add adds the given sequence to the MinHash.

func (m *Masher) AddSeq(seqs iter.Seq[[]byte]) *Masher

AddSeq adds the given sequences to the MinHash.

func (m *Masher) Distance(other *Masher) float64

Distance returns the Mash distance between this Masher and another one.

Both Mashers need to have the same k's and seeds.

func (m *Masher) MarshalJSON() ([]byte, error)

MarshalJSON implements the JSONMarshaler interface.

func (m *Masher) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the JSONUnmarshaler interface.