Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ( // Version of the bhlindex binary. Version = "1.0.2" // Build is a timestamp of the bhlindex binary compilation. Build string )
Functions ¶
This section is empty.
Types ¶
type BHLindex ¶
type BHLindex interface {
// FindNames traverses BHL corpus directory structure, assembling texts,
// detecting names, saving the resulting data to storage.
FindNames(loader.Loader, finder.Finder) error
// Verify names runs verification on unique detected names and saves the
// results to storage.
VerifyNames(verif.VerifierBHL) error
// CalcOddsVerif calculates relationship between odds and the percentage
// of successful verifications.
CalcOddsVerif(verif.VerifierBHL) error
// DumpOccurrences exports data about detected names and their position
// on BHL pages in CSV, TSV, or JSON formats.
DumpOccurrences(output.Dumper) error
// DumpNames exports results of names verification in CSV,
// TSV, or JSON formats.
DumpNames(output.Dumper) error
// DumpOddsVerification exports mapping of Odds values to verification
// percentage
DumpOddsVerification(output.Dumper) error
// GetVersion outputs the version of BHLindex.
GetVersion() gnvers.Version
// GetConfig returns an instance of configuration fields.
GetConfig() config.Config
}
BHLindex defines main functionality of BHLindex project.
Click to show internal directories.
Click to hide internal directories.