matcher

Documentation

Overview

package matcher is the central processing unit for matching name-strings to known scientific names.

Index

• Constants
• type Matcher
  • func NewMatcher(em exact.ExactMatcher, fm fuzzy.FuzzyMatcher, j int) Matcher

Constants

const (
	// MaxNMaxNamesNum is the largest number of names that can be processed
	// per request. If input contains more names, it will be truncated.
	MaxNamesNum = 10_000
)

Types

type Matcher

type Matcher interface {
	// Init loads data from cache on disk, and, if cache is empty, populates it
	// from gnames database.
	Init()
	// MatchNames takes a slice of strings and returns back matches of these
	// strings to known scientific names.
	MatchNames(names []string) []mlib.Match
}

Matcher is the interface that enables matching strings to known scientific names.

func NewMatcher

func NewMatcher(em exact.ExactMatcher, fm fuzzy.FuzzyMatcher, j int) Matcher

NewMatcher returns Matcher object. It takes interfaces to ExactMatcher and FuzzyMatcher.