[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/dict-tree 217c9d2 119/154: Updated Commentary.
From: |
Stefan Monnier |
Subject: |
[elpa] externals/dict-tree 217c9d2 119/154: Updated Commentary. |
Date: |
Mon, 14 Dec 2020 12:21:57 -0500 (EST) |
branch: externals/dict-tree
commit 217c9d2ef72ff62632c9ad5bb56335b750ae968d
Author: Toby S. Cubitt <toby-predictive@dr-qubit.org>
Commit: Toby S. Cubitt <toby-predictive@dr-qubit.org>
Updated Commentary.
---
dict-tree.el | 38 +++++++++++++++++++++++++-------------
1 file changed, 25 insertions(+), 13 deletions(-)
diff --git a/dict-tree.el b/dict-tree.el
index 4e15d83..c040c22 100644
--- a/dict-tree.el
+++ b/dict-tree.el
@@ -28,37 +28,49 @@
;;; Commentary:
;;
;; A dict-tree (created using `dictree-create') is used to store strings,
-;; along with arbitrary data associated with each string. As well as basic
-;; data insertion (`dictree-insert'), manipulation (`dictree-insert'), and
-;; retrieval (`dictree-lookup', `dictree-member-p'), a dict-tree can perform
-;; sophisticated queries on strings, including:
+;; along with arbitrary data associated with each string. (Note that the
+;; "strings" can be any sequence data type, not just Elisp strings.) As well
+;; as basic data insertion (`dictree-insert'), manipulation
+;; (`dictree-insert'), and retrieval (`dictree-lookup', `dictree-member-p'), a
+;; dict-tree can perform sophisticated queries on strings, including:
;;
-;; - retrieve all (or a given number of) strings with a given prefix, ranking
-;; the results in alphabetical or any other given order
+;; - retrieve all completions of a prefix
;; (`dictree-complete')
;;
-;; - retrieve all (or a given number of) strings that match a regular
-;; expression, ranking the results in alphabetical or any other given order
+;; - retrieve all strings that match a regular expression
;; (`dictree-regexp-search')
;;
+;; - retrieve all fuzzy matches to a string, i.e. matches within a specified
+;; Lewenstein distance a.k.a. edit distance
+;; (`dictree-fuzzy-match')
+;;
+;; - retrieve all fuzzy completions of a prefix, i.e. completions of prefixes
+;; within a specified Lewenstein distance
+;; (`dictree-fuzzy-complete')
+;;
+;; The results of all of these queries can be ranked in alphabetical order, or
+;; according to any other desired ranking. The results can also be limited to
+;; a given number of matches.
+;;
+;; Other functions allow you to:
+;;
;; - create dict-tree stack objects, which allow efficient access to the
;; strings in the dictionary or in query results as though they were sorted
;; on a stack (useful for designing efficient algorithms on top of
;; dict-trees)
;; (`dictree-stack', `dictree-complete-stack', `dictree-regexp-stack')
;;
-;; - map over all strings in lexicographic order
+;; - map over all strings in alphabetical order
;; (`dictree-mapc', `dictree-mapcar' and `dictree-mapf')
;;
;; These sophisticated string queries are fast even for very large dict-trees,
-;; and dict-tree's can also cache query results (and automatically keep these
+;; and dict-tree's also cache query results (and automatically keep these
;; caches synchronised) to speed up queries even further.
;;
-;; The package also provides persistent storage of dict-trees to file, and can
-;; save modified dictionaries automatically if desired.
+;; The package also provides persistent storage of dict-trees to file.
;; (`dictree-save', `dictree-write', `dictee-load')
;;
-;; This package uses the trie package trie.el. the tagged NFA package tNFA.el,
+;; This package uses the trie package trie.el, the tagged NFA package tNFA.el,
;; and the heap package heap.el.
- [elpa] externals/dict-tree 1ec9d58 102/154: Restore trie print/read transformer functions., (continued)
- [elpa] externals/dict-tree 1ec9d58 102/154: Restore trie print/read transformer functions., Stefan Monnier, 2020/12/14
- [elpa] externals/dict-tree 48ab389 092/154: Simplified persistent-storage code for tries and dict-trees., Stefan Monnier, 2020/12/14
- [elpa] externals/dict-tree 454c68b 109/154: Code cleanup., Stefan Monnier, 2020/12/14
- [elpa] externals/dict-tree ba2eba0 107/154: Exploit lexical closures to allow byte-compilation of wrapped functions., Stefan Monnier, 2020/12/14
- [elpa] externals/dict-tree 08303f3 103/154: Remove ChangeLogs from library headers., Stefan Monnier, 2020/12/14
- [elpa] externals/dict-tree 8d8ce4f 120/154: Print dict-tree cache sizes in edebug., Stefan Monnier, 2020/12/14
- [elpa] externals/dict-tree 84b23ec 112/154: Implement trie-fuzzy-match and trie-fuzzy-complete functions., Stefan Monnier, 2020/12/14
- [elpa] externals/dict-tree 5321c25 113/154: Implement fuzzy match and completion on dict-trees., Stefan Monnier, 2020/12/14
- [elpa] externals/dict-tree d0e339d 117/154: Don't wrap rank and filter functions for regexp and fuzzy queries., Stefan Monnier, 2020/12/14
- [elpa] externals/dict-tree a11f2a5 115/154: Update predictive mode to new dictree-create function interface., Stefan Monnier, 2020/12/14
- [elpa] externals/dict-tree 217c9d2 119/154: Updated Commentary.,
Stefan Monnier <=
- [elpa] externals/dict-tree 95d6a5a 127/154: Mention iterator generators in Commentary., Stefan Monnier, 2020/12/14
- [elpa] externals/dict-tree d84725e 124/154: Bump version numbers since we've added iterator generators., Stefan Monnier, 2020/12/14
- [elpa] externals/dict-tree f47d49c 137/154: Bug fixes to meta-dict fuzzy-matching/completing., Stefan Monnier, 2020/12/14
- [elpa] externals/dict-tree 65b94b4 131/154: Bump version numbers., Stefan Monnier, 2020/12/14
- [elpa] externals/dict-tree c737d3a 134/154: Make use of new trie-fuzzy-complete facilities., Stefan Monnier, 2020/12/14
- [elpa] externals/dict-tree eec26c3 132/154: Fix trie--construct-Lewenstein-rankfun to new versions., Stefan Monnier, 2020/12/14
- [elpa] externals/dict-tree 5e2ffac 136/154: Test for lexical binding must be within same file to work reliably., Stefan Monnier, 2020/12/14
- [elpa] externals/dict-tree 22d0e13 140/154: Sort completions by fuzzy dist before ngram length., Stefan Monnier, 2020/12/14
- [elpa] externals/dict-tree 67afade 151/154: Document PFXFILTER argument to query functions., Stefan Monnier, 2020/12/14
- [elpa] externals/dict-tree 4299171 150/154: Work around Emacs bug preventing dict-tree caching., Stefan Monnier, 2020/12/14