Skip to content

Commit

Permalink
Autodoc commit for master/ce5c0a2d
Browse files Browse the repository at this point in the history
  • Loading branch information
Tom Faulhaber committed Jun 6, 2016
1 parent 73ee907 commit 9eb43af
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 26 deletions.
12 changes: 6 additions & 6 deletions api-index.html
View file
Expand Up @@ -43,19 +43,19 @@ <h1><a href="index.html" id="page-header" title="page header title">core.memoize
<div id="right-sidebar"></div>
<div id="content-tag"><h1 id="overview">Index of Public Functions and Variables - <span id="header-project">A manipulable, pluggable, memoization framework</span> <span id="header-version">0.5.10</span><span id="header-status-block"> (<span id="header-status">in development</span>)</span></h1>
This page has an alphabetical index of all the documented functions and variables
in <span class="project-name-span">A manipulable, pluggable, memoization framework</span>.
in <span class="project-name-span">A manipulable, pluggable, memoization framework</span>.

<!-- TODO: enable this functionality on github?
In a narrow browser window, you may want to collapse the sidebar (use the \"<<\" link)
to get more screen space for the index.
In a narrow browser window, you may want to collapse the sidebar (use the \"<<\" link)
to get more screen space for the index.
-->

<div class="shortcuts">
<p>
</p><div class="shortcuts">
Shortcuts:<br />
<a href="#A">A</a> <a href="#B">B</a> <a href="#C">C</a> <a href="#D">D</a>
<a href="#E">E</a> <a href="#F">F</a> <a href="#G">G</a> <a href="#H">H</a>
<a href="#I">I</a> <a href="#J">J</a> <a href="#K">K</a> <a href="#L">L</a>
<a href="#I">I</a> <a href="#J">J</a> <a href="#K">K</a> <a href="#L">L</a>
<a href="#M">M</a>
<br />
<a href="#N">N</a> <a href="#O">O</a> <a href="#P">P</a> <a href="#Q">Q</a>
Expand Down
39 changes: 19 additions & 20 deletions index-0.5.10.clj
View file
Expand Up @@ -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
Expand All @@ -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",
Expand All @@ -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",
Expand All @@ -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",
Expand All @@ -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",
Expand All @@ -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",
Expand All @@ -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",
Expand All @@ -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!",
Expand All @@ -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",
Expand All @@ -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",
Expand All @@ -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",
Expand All @@ -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!",
Expand All @@ -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",
Expand All @@ -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?",
Expand All @@ -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",
Expand All @@ -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",
Expand All @@ -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}
Expand All @@ -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})}

0 comments on commit 9eb43af

Please sign in to comment.