about summary refs log tree commit
path: root/README
diff options
context:
space:
mode:
authorEric Wong <normalperson@yhbt.net>2010-09-02 13:56:39 -0700
committerEric Wong <normalperson@yhbt.net>2010-09-02 13:56:39 -0700
commit03daddf53a88bf1a3b7890d02577dd8921d70b76 (patch)
treeb98837aa15f79b0ab34cd7fe4bc433223ef6ad9d /README
parent531c7ee4fade42ff115ba9df9ca1ca7d7ad631d6 (diff)
downloadrpatricia-03daddf53a88bf1a3b7890d02577dd8921d70b76.tar.gz
add Patricia#include? method
This behaves like Patricia#match_best, but is more
efficient as it does not need to allocate a new object
on successful matches.
Diffstat (limited to 'README')
-rw-r--r--README8
1 files changed, 8 insertions, 0 deletions
diff --git a/README b/README
index 23ce6c1..0f9c012 100644
--- a/README
+++ b/README
@@ -124,6 +124,14 @@ search_exact:
 
 match_exact:        An alias of search_exact.
 
+include?:
+
+      pt.include?(key_string);
+
+    This method behaves like match_best, but returns true on success
+    and false on failure.  This method is more efficient than match_best
+    as it does not allocate a new object.
+
 remove:
 
       pt.remove(key_string);