levenshteinDistanceMax same as levenshteinDistance but attempts to bail early once we know the distance will be greater than max in which case the first return val will be the max and the second will be true, indicating max was exceeded.

NewDocumentMatchPool will build a DocumentMatchPool with memory pre-allocated to accomodate the requested number of DocumentMatch instances.

SortFieldAsDate forces sort as string (prefix coded terms with shift > 0 removed).

SortFieldAsNumber forces sort as string (prefix coded terms with shift > 0 removed).

SortFieldAsString forces sort as string (no prefix coded terms removed).

SortFieldAuto applies heuristics attempt to automatically sort correctly.

FIXME name is confusing.

SortFieldMax uses the maximum value.

SortFieldMin uses the minimum value.

SortFieldMissingFirst sorts documents missing a field at the beginning.

SortFieldMissingLast sorts documents missing a field at the end.

DocumentMatchPool manages use/re-use of DocumentMatch instances it pre-allocates space from a single large block with the expected number of instances.

SearchContext represents the context around a single search.

SortDocID will sort results by the document identifier.

SortField will sort results by the value of a stored field Field is the name of the field Descending reverse the sort order (default false) Type allows forcing of string/number/date behavior (default auto) Mode controls behavior for multi-values fields (default first) Missing controls behavior of missing values (default last).

SortScore will sort results by the document match score.

DocumentMatchPoolTooSmall is a callback function that can be executed when the DocumentMatchPool does not have sufficient capacity By default we just perform just-in-time allocation, but you could log a message, or panic, etc.

SortFieldMissing controls where documents missing a field value should be sorted.

SortFieldMode describes the behavior if the field has multiple values.

SortFieldType lets you control some internal sort behavior normally leaving this to the zero-value of SortFieldAuto is fine.