diff --git a/api-index.html b/api-index.html index 1248821..0fcad93 100644 --- a/api-index.html +++ b/api-index.html @@ -43,19 +43,19 @@

core.memoize

Index of Public Functions and Variables - A manipulable, pluggable, memoization framework 0.5.10 (in development)

This page has an alphabetical index of all the documented functions and variables -in A manipulable, pluggable, memoization framework. +in A manipulable, pluggable, memoization framework. - -
+

+

Shortcuts:
A B C D E F G H - I J K L + I J K L M
N O P Q diff --git a/index-0.5.10.clj b/index-0.5.10.clj index 66a01ca..f4992f1 100644 --- a/index-0.5.10.clj +++ b/index-0.5.10.clj @@ -3,8 +3,7 @@ "core.memoize is a memoization library offering functionality above Clojure's core `memoize`\nfunction in the following ways:\n\n**Pluggable memoization**\n\ncore.memoize allows for different back-end cache implmentations to be used as appropriate without\nchanging the memoization modus operandi.\n\n**Manipulable memoization**\n\nBecause core.memoize allows you to access a function's memoization store, you do interesting things like\nclear it, modify it, and save it for later.\n", :author "fogus", :name "clojure.core.memoize", - :wiki-url - "http://clojure.github.com/core.memoize/clojure.core.memoize-api.html", + :wiki-url "http://clojure.github.io/core.memoize/index.html", :source-url "https://github.com/clojure/core.memoize/blob/0f82bdd867600e7f526b0688aac6e9b82f70e5ee/src/main/clojure/clojure/core/memoize.clj"}), :vars @@ -21,7 +20,7 @@ "Positional factory function for class clojure.core.memoize.PluggableMemoization.", :namespace "clojure.core.memoize", :wiki-url - "http://clojure.github.com/core.memoize//clojure.core.memoize-api.html#clojure.core.memoize/->PluggableMemoization"} + "http://clojure.github.io/core.memoize//index.html#clojure.core.memoize/->PluggableMemoization"} {:raw-source-url "https://github.com/clojure/core.memoize/raw/0f82bdd867600e7f526b0688aac6e9b82f70e5ee/src/main/clojure/clojure/core/memoize.clj", :name "->RetryingDelay", @@ -35,7 +34,7 @@ "Positional factory function for class clojure.core.memoize.RetryingDelay.", :namespace "clojure.core.memoize", :wiki-url - "http://clojure.github.com/core.memoize//clojure.core.memoize-api.html#clojure.core.memoize/->RetryingDelay"} + "http://clojure.github.io/core.memoize//index.html#clojure.core.memoize/->RetryingDelay"} {:raw-source-url "https://github.com/clojure/core.memoize/raw/0f82bdd867600e7f526b0688aac6e9b82f70e5ee/src/main/clojure/clojure/core/memoize.clj", :name "build-memoizer", @@ -49,7 +48,7 @@ "Builds a function that given a function, returns a pluggable memoized\nversion of it. `build-memoizer` Takes a cache factory function, a function\nto memoize, and the arguments to the factory. At least one of those\nfunctions should be the function to be memoized.", :namespace "clojure.core.memoize", :wiki-url - "http://clojure.github.com/core.memoize//clojure.core.memoize-api.html#clojure.core.memoize/build-memoizer"} + "http://clojure.github.io/core.memoize//index.html#clojure.core.memoize/build-memoizer"} {:raw-source-url "https://github.com/clojure/core.memoize/raw/0f82bdd867600e7f526b0688aac6e9b82f70e5ee/src/main/clojure/clojure/core/memoize.clj", :name "fifo", @@ -63,7 +62,7 @@ "Works the same as the basic memoization function (i.e. `memo`\nand `core.memoize` except when a given threshold is breached.\n\nObserve the following:\n\n (require '[clojure.core.memoize :as memo])\n\n (def id (memo/fifo identity :fifo/threshold 2))\n\n (id 42)\n (id 43)\n (snapshot id)\n ;=> {[42] 42, [43] 43}\n\nAs you see, the limit of `2` has not been breached yet, but\nif you call again with another value, then it is:\n\n (id 44)\n (snapshot id)\n ;=> {[44] 44, [43] 43}\n\nThat is, the oldest entry `42` is pushed out of the\nmemoization cache. This is the standard **F**irst **I**n\n**F**irst **O**ut behavior.", :namespace "clojure.core.memoize", :wiki-url - "http://clojure.github.com/core.memoize//clojure.core.memoize-api.html#clojure.core.memoize/fifo"} + "http://clojure.github.io/core.memoize//index.html#clojure.core.memoize/fifo"} {:raw-source-url "https://github.com/clojure/core.memoize/raw/0f82bdd867600e7f526b0688aac6e9b82f70e5ee/src/main/clojure/clojure/core/memoize.clj", :name "lru", @@ -77,7 +76,7 @@ "Works the same as the basic memoization function (i.e. `memo`\nand `core.memoize` except when a given threshold is breached.\n\nObserve the following:\n\n (require '[clojure.core.memoize :as memo])\n\n (def id (memo/lru identity :lru/threshold 2))\n\n (id 42)\n (id 43)\n (snapshot id)\n ;=> {[42] 42, [43] 43}\n\nAt this point the cache has not yet crossed the set threshold\nof `2`, but if you execute yet another call the story will\nchange:\n\n (id 44)\n (snapshot id)\n ;=> {[44] 44, [43] 43}\n\nAt this point the operation of the LRU cache looks exactly\nthe same at the FIFO cache. However, the difference becomes\napparent on further use:\n\n (id 43)\n (id 0)\n (snapshot id)\n ;=> {[0] 0, [43] 43}\n\nAs you see, once again calling `id` with the argument `43`\nwill expose the LRU nature of the underlying cache. That is,\nwhen the threshold is passed, the cache will expel the\n**L**east **R**ecently **U**sed element in favor of the new.", :namespace "clojure.core.memoize", :wiki-url - "http://clojure.github.com/core.memoize//clojure.core.memoize-api.html#clojure.core.memoize/lru"} + "http://clojure.github.io/core.memoize//index.html#clojure.core.memoize/lru"} {:raw-source-url "https://github.com/clojure/core.memoize/raw/0f82bdd867600e7f526b0688aac6e9b82f70e5ee/src/main/clojure/clojure/core/memoize.clj", :name "lu", @@ -91,7 +90,7 @@ "Similar to the implementation of memo-lru, except that this\nfunction removes all cache values whose usage value is\nsmallest:\n\n (require '[clojure.core.memoize :as memo])\n\n (def id (memo/lu identity :lu/threshold 3))\n\n (id 42)\n (id 42)\n (id 43)\n (id 44)\n (snapshot id)\n ;=> {[44] 44, [42] 42}\n\nThe **L**east **U**sed values are cleared on cache misses.", :namespace "clojure.core.memoize", :wiki-url - "http://clojure.github.com/core.memoize//clojure.core.memoize-api.html#clojure.core.memoize/lu"} + "http://clojure.github.io/core.memoize//index.html#clojure.core.memoize/lu"} {:raw-source-url "https://github.com/clojure/core.memoize/raw/0f82bdd867600e7f526b0688aac6e9b82f70e5ee/src/main/clojure/clojure/core/memoize.clj", :name "memo", @@ -105,7 +104,7 @@ "Used as a more flexible alternative to Clojure's core `memoization`\nfunction. Memoized functions built using `memo` will respond to\nthe core.memo manipulable memoization utilities. As a nice bonus,\nyou can use `memo` in place of `memoize` without any additional\nchanges.\n\nThe default way to use this function is to simply apply a function\nthat will be memoized. Additionally, you may also supply a map\nof the form `'{[42] 42, [108] 108}` where keys are a vector\nmapping expected argument values to arity positions. The map values\nare the return values of the memoized function.\n\nYou can access the memoization cache directly via the `:clojure.core.memoize/cache` key\non the memoized function's metadata. However, it is advised to\nuse the core.memo primitives instead as implementation details may\nchange over time.", :namespace "clojure.core.memoize", :wiki-url - "http://clojure.github.com/core.memoize//clojure.core.memoize-api.html#clojure.core.memoize/memo"} + "http://clojure.github.io/core.memoize//index.html#clojure.core.memoize/memo"} {:raw-source-url "https://github.com/clojure/core.memoize/raw/0f82bdd867600e7f526b0688aac6e9b82f70e5ee/src/main/clojure/clojure/core/memoize.clj", :name "memo-clear!", @@ -119,7 +118,7 @@ "Reaches into an core.memo-memoized function and clears the cache. This is a\ndestructive operation and should be used with care.\n\nWhen the second argument is a vector of input arguments, clears cache only\nfor argument vector.\n\nKeep in mind that depending on what other threads or doing, an\nimmediate call to `snapshot` may not yield an empty cache. That's\ncool though, we've learned to deal with that stuff in Clojure by\nnow.", :namespace "clojure.core.memoize", :wiki-url - "http://clojure.github.com/core.memoize//clojure.core.memoize-api.html#clojure.core.memoize/memo-clear!"} + "http://clojure.github.io/core.memoize//index.html#clojure.core.memoize/memo-clear!"} {:raw-source-url "https://github.com/clojure/core.memoize/raw/0f82bdd867600e7f526b0688aac6e9b82f70e5ee/src/main/clojure/clojure/core/memoize.clj", :name "memo-fifo", @@ -132,7 +131,7 @@ :doc "DEPRECATED: Please use clojure.core.memoize/fifo instead.", :namespace "clojure.core.memoize", :wiki-url - "http://clojure.github.com/core.memoize//clojure.core.memoize-api.html#clojure.core.memoize/memo-fifo"} + "http://clojure.github.io/core.memoize//index.html#clojure.core.memoize/memo-fifo"} {:raw-source-url "https://github.com/clojure/core.memoize/raw/0f82bdd867600e7f526b0688aac6e9b82f70e5ee/src/main/clojure/clojure/core/memoize.clj", :name "memo-lru", @@ -145,7 +144,7 @@ :doc "DEPRECATED: Please use clojure.core.memoize/lru instead.", :namespace "clojure.core.memoize", :wiki-url - "http://clojure.github.com/core.memoize//clojure.core.memoize-api.html#clojure.core.memoize/memo-lru"} + "http://clojure.github.io/core.memoize//index.html#clojure.core.memoize/memo-lru"} {:raw-source-url "https://github.com/clojure/core.memoize/raw/0f82bdd867600e7f526b0688aac6e9b82f70e5ee/src/main/clojure/clojure/core/memoize.clj", :name "memo-lu", @@ -158,7 +157,7 @@ :doc "DEPRECATED: Please use clojure.core.memoize/lu instead.", :namespace "clojure.core.memoize", :wiki-url - "http://clojure.github.com/core.memoize//clojure.core.memoize-api.html#clojure.core.memoize/memo-lu"} + "http://clojure.github.io/core.memoize//index.html#clojure.core.memoize/memo-lu"} {:raw-source-url "https://github.com/clojure/core.memoize/raw/0f82bdd867600e7f526b0688aac6e9b82f70e5ee/src/main/clojure/clojure/core/memoize.clj", :name "memo-swap!", @@ -172,7 +171,7 @@ "Takes a core.memo-populated function and a map and replaces the memoization cache\nwith the supplied map. This is potentially some serious voodoo,\nsince you can effectively change the semantics of a function on the fly.\n\n (def id (memo identity))\n (memo-swap! id '{[13] :omg})\n (id 13)\n ;=> :omg\n\nWith great power comes ... yadda yadda yadda.", :namespace "clojure.core.memoize", :wiki-url - "http://clojure.github.com/core.memoize//clojure.core.memoize-api.html#clojure.core.memoize/memo-swap!"} + "http://clojure.github.io/core.memoize//index.html#clojure.core.memoize/memo-swap!"} {:raw-source-url "https://github.com/clojure/core.memoize/raw/0f82bdd867600e7f526b0688aac6e9b82f70e5ee/src/main/clojure/clojure/core/memoize.clj", :name "memo-ttl", @@ -185,7 +184,7 @@ :doc "DEPRECATED: Please use clojure.core.memoize/ttl instead.", :namespace "clojure.core.memoize", :wiki-url - "http://clojure.github.com/core.memoize//clojure.core.memoize-api.html#clojure.core.memoize/memo-ttl"} + "http://clojure.github.io/core.memoize//index.html#clojure.core.memoize/memo-ttl"} {:raw-source-url "https://github.com/clojure/core.memoize/raw/0f82bdd867600e7f526b0688aac6e9b82f70e5ee/src/main/clojure/clojure/core/memoize.clj", :name "memoized?", @@ -199,7 +198,7 @@ "Returns true if a function has an core.memo-placed cache, false otherwise.", :namespace "clojure.core.memoize", :wiki-url - "http://clojure.github.com/core.memoize//clojure.core.memoize-api.html#clojure.core.memoize/memoized?"} + "http://clojure.github.io/core.memoize//index.html#clojure.core.memoize/memoized?"} {:raw-source-url "https://github.com/clojure/core.memoize/raw/0f82bdd867600e7f526b0688aac6e9b82f70e5ee/src/main/clojure/clojure/core/memoize.clj", :name "snapshot", @@ -213,7 +212,7 @@ "Returns a snapshot of a core.memo-placed memoization cache. By snapshot\nyou can infer that what you get is only the cache contents at a\nmoment in time.", :namespace "clojure.core.memoize", :wiki-url - "http://clojure.github.com/core.memoize//clojure.core.memoize-api.html#clojure.core.memoize/snapshot"} + "http://clojure.github.io/core.memoize//index.html#clojure.core.memoize/snapshot"} {:raw-source-url "https://github.com/clojure/core.memoize/raw/0f82bdd867600e7f526b0688aac6e9b82f70e5ee/src/main/clojure/clojure/core/memoize.clj", :name "ttl", @@ -227,13 +226,13 @@ "Unlike many of the other core.memo memoization functions,\n`memo-ttl`'s cache policy is time-based rather than algortihmic\nor explicit. When memoizing a function using `memo-ttl` you\nshould provide a **T**ime **T**o **L**ive parameter in\nmilliseconds.\n\n (require '[clojure.core.memoize :as memo])\n\n (def id (memo/ttl identity :ttl/threshold 5000))\n\n (id 42)\n (snapshot id)\n ;=> {[42] 42}\n\n ... wait 5 seconds ...\n (id 43)\n (snapshot id)\n ;=> {[43] 43}\n\nThe expired cache entries will be removed on each cache **miss**.", :namespace "clojure.core.memoize", :wiki-url - "http://clojure.github.com/core.memoize//clojure.core.memoize-api.html#clojure.core.memoize/ttl"} + "http://clojure.github.io/core.memoize//index.html#clojure.core.memoize/ttl"} {:name "PluggableMemoization", :var-type "type", :namespace "clojure.core.memoize", :arglists nil, :wiki-url - "http://clojure.github.com/core.memoize//clojure.core.memoize-api.html#clojure.core.memoize/PluggableMemoization", + "http://clojure.github.io/core.memoize//index.html#clojure.core.memoize/PluggableMemoization", :source-url nil, :raw-source-url nil, :file nil} @@ -242,7 +241,7 @@ :namespace "clojure.core.memoize", :arglists nil, :wiki-url - "http://clojure.github.com/core.memoize//clojure.core.memoize-api.html#clojure.core.memoize/RetryingDelay", + "http://clojure.github.io/core.memoize//index.html#clojure.core.memoize/RetryingDelay", :source-url nil, :raw-source-url nil, :file nil})} diff --git a/index.html b/index.html index 9cca9c3..43388f5 100644 --- a/index.html +++ b/index.html @@ -108,6 +108,9 @@

Table of Contents

ttl
+
+ +
@@ -171,6 +174,7 @@

->PluggableMemoizatio
Usage: (->PluggableMemoization f cache)
 
Positional factory function for class clojure.core.memoize.PluggableMemoization.
+

     
     
     Source
@@ -182,6 +186,7 @@ 

->RetryingDelay

Usage: (->RetryingDelay fun available? value)
 
Positional factory function for class clojure.core.memoize.RetryingDelay.
+

     
     
     Source
@@ -196,6 +201,7 @@ 

build-memoizer

version of it. `build-memoizer` Takes a cache factory function, a function to memoize, and the arguments to the factory. At least one of those functions should be the function to be memoized. +

     
     
     Source
@@ -233,6 +239,7 @@ 

fifo

That is, the oldest entry `42` is pushed out of the memoization cache. This is the standard **F**irst **I**n **F**irst **O**ut behavior. +

     
     
     Source
@@ -281,6 +288,7 @@ 

lru

will expose the LRU nature of the underlying cache. That is, when the threshold is passed, the cache will expel the **L**east **R**ecently **U**sed element in favor of the new. +

     
     
     Source
@@ -310,6 +318,7 @@ 

lu

;=> {[44] 44, [42] 42} The **L**east **U**sed values are cleared on cache misses. +

     
     
     Source
@@ -337,6 +346,7 @@ 

memo

on the memoized function's metadata. However, it is advised to use the core.memo primitives instead as implementation details may change over time. +

     
     
     Source
@@ -358,6 +368,7 @@ 

memo-clear!

immediate call to `snapshot` may not yield an empty cache. That's cool though, we've learned to deal with that stuff in Clojure by now. +

     
     
     Source
@@ -371,6 +382,7 @@ 

memo-fifo

(memo-fifo f limit base)
DEPRECATED: Please use clojure.core.memoize/fifo instead.
+

     
     
     Source
@@ -384,6 +396,7 @@ 

memo-lru

(memo-lru f limit base)
DEPRECATED: Please use clojure.core.memoize/lru instead.
+

     
     
     Source
@@ -397,6 +410,7 @@ 

memo-lu

(memo-lu f limit base)
DEPRECATED: Please use clojure.core.memoize/lu instead.
+

     
     
     Source
@@ -417,6 +431,7 @@ 

memo-swap!

;=> :omg With great power comes ... yadda yadda yadda. +

     
     
     Source
@@ -430,6 +445,7 @@ 

memo-ttl

(memo-ttl f limit base)
DEPRECATED: Please use clojure.core.memoize/ttl instead.
+

     
     
     Source
@@ -441,6 +457,7 @@ 

memoized?

Usage: (memoized? f)
 
Returns true if a function has an core.memo-placed cache, false otherwise.
+

     
     
     Source
@@ -454,6 +471,7 @@ 

snapshot

Returns a snapshot of a core.memo-placed memoization cache.  By snapshot
 you can infer that what you get is only the cache contents at a
 moment in time.
+

     
     
     Source
@@ -487,6 +505,7 @@ 

ttl

;=> {[43] 43} The expired cache entries will be removed on each cache **miss**. +

     
     
     Source