memsearch.text.search — coderafting/memsearch 0.1.1

default-fetch-fn cljs

(default-fetch-fn db doc-ids)

The db is expected to be a map with doc-ids as keys and maps as values. Each value map may contain the data that needs to come out of the db.

fetch-docs-for-a-word cljs

(fetch-docs-for-a-word w index)

Fetches all the indexed docs for a word.

highest-similarity cljs

(highest-similarity w str-set)

Returns the similarilty value (between 0 and 1, both inclusive) for a word against the best similar word from a set of words.

merge-scored-docs cljs

(merge-scored-docs m1 m2)

Example inputs: {1 {:score 10 :data {:age 20}}} and {1 {:score 12 :data {:age 20}} 2 {:score 5 :data {:age 30}}} Return: {1 {:score 22 :data {:age 20}} 2 {:score 5 :data {:age 30}}} If there are duplicate keys (values are equal):

• The values of :score gets added.
• The values of :data are expected to be equal in both the inputs, and will be returned as is. If the keys are not duplicate, then simply append as a key val pair.

score-comparator cljs

(score-comparator m & increasing?)

Sorting comparator based on the score, either in increasing or in decreasing order. Defaults to decreasing order.

scored-doc-for-a-word cljs

(scored-doc-for-a-word w doc)

Returns a map with doc-id as key and a map (with :score) as value. The supplied doc is expected to have :id and :frequency of the supplied word.

scored-docs cljs

(scored-docs s-coll index & opts-map)

Results from the index map based on the supplied words collection. Return value may or may not be sorted based on provided options. Defaults to non-sorted result.

scored-docs-for-str-coll cljs

(scored-docs-for-str-coll s-coll index)

Fetches the docs for all the valid words of the supplied collection. The score for each fetched doc is combined (added) for each word of the words collection, to compute the final socre for the doc.

scored-docs-for-word cljs

(scored-docs-for-word w docs)

Returns a map with doc-ids as keys and a maps (with :score) as values. The supplied docs are expected to have :id and :frequency of the supplied word.

scored-docs-with-data cljs

(scored-docs-with-data s-coll index db & opts-map)

If a custom fetch fn is not provided in the opts-map, then the db is expected to be a map with doc-ids as keys and maps as values. The return value of fetch-fn is expected to be a map or a collection similar to: {1 {:data {}} 2 {:data {}}} or [{1 {:data {}}} {2 {:data {}}}].

sorted-scored-docs cljs

(sorted-scored-docs s-coll index & increasing?)

Results sorted by score, either in increasing or in decreasing order. Defaults to decreasing order.

text-search cljs

(text-search query-string index & opts-map)

Search the index with a string of one or more words. Various options can be provided:

• :db - If provided, the return value will contain additional data from the db based on the doc-ids returned by the index.
• :fetch-fn - A function with args signature [db doc-ids]. Exists only with :db key. It is expected to return results in the form similar to {1 {:data {}} 2 {:data {}}} or [{1 {:data {}}} {2 {:data {}}}]. The key :dataand its value could be any key and value.
• :sorted? - If true, the result should be sorted. Defaults to decreasing order of sorting.
• :increasing? - Exists only with :sorted? key, a true value indicates the sorting to be in the increasing order.
• :valid-word-fn - A single arity fn that takes one word (string) and returns boolean.