Skip to content

Commit

Permalink
Autodoc commit
Browse files Browse the repository at this point in the history
  • Loading branch information
@clojure-build
clojure-build committed Aug 16, 2023
1 parent 13020d6 commit 63a4268
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 32 deletions.
8 changes: 4 additions & 4 deletions api-index.html
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Index - core.memoize 0.8.3-SNAPSHOT API documentation</title>
<title>Index - core.memoize 1.0.258-SNAPSHOT API documentation</title>
<link rel="icon" href="static/favicon.png" />
<link rel="shortcut icon" href="static/favicon.png" />
<link rel="stylesheet" href="static/clojure.css" type="text/css" media="all" />
Expand All @@ -25,7 +25,7 @@ <h1><a href="index.html" id="page-header" title="page header title">core.memoize
<div id="leftcolumn"><div style="text-align: center;"></div>
<div class="menu">
<div class="WikiCustomNav WikiElement wiki">
<span class="toc-header"><span id="project-name">core.memoize</span> <span id="version">0.8.3-SNAPSHOT</span> API</span><br />
<span class="toc-header"><span id="project-name">core.memoize</span> <span id="version">1.0.258-SNAPSHOT</span> API</span><br />
<ul>
<li><a href="index.html" class="wiki_link">Overview</a></li>
<li><a href="api-index.html" class="wiki_link">API Index</a></li>
Expand All @@ -41,7 +41,7 @@ <h1><a href="index.html" id="page-header" title="page header title">core.memoize
<div class="contentBox"><div class="innerContentBox">
<div class="wiki wikiPage" id="content_view">
<div id="right-sidebar"></div>
<div id="content-tag"><h1 id="overview">Index of Public Functions and Variables - <span id="header-project">core.memoize</span> <span id="header-version">0.8.3-SNAPSHOT</span><span id="header-status-block"> (<span id="header-status">in development</span>)</span></h1>
<div id="content-tag"><h1 id="overview">Index of Public Functions and Variables - <span id="header-project">core.memoize</span> <span id="header-version">1.0.258-SNAPSHOT</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">core.memoize</span>.

Expand Down Expand Up @@ -233,7 +233,7 @@ <h2 id="Other"><span id="section-head">Other</span></h2>
</div>
</div>
<div id="foot">
<div id="copyright" style="text-align: center;">Copyright 2007-2019 by Rich Hickey and the various contributors</div>
<div id="copyright" style="text-align: center;">Copyright 2007-2023 by Rich Hickey and the various contributors</div>
</div>
</div>
<div id="DesignedBy">Logo &amp; site design by <a href="http://www.tomhickey.com" title="Visit Tom Hickey's website.">Tom Hickey</a>.<br />
Expand Down
71 changes: 43 additions & 28 deletions index.html
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>clojure.core.memoize - core.memoize 0.8.3-SNAPSHOT API documentation</title>
<title>clojure.core.memoize - core.memoize 1.0.258-SNAPSHOT API documentation</title>
<link rel="icon" href="static/favicon.png" />
<link rel="shortcut icon" href="static/favicon.png" />
<link rel="stylesheet" href="static/clojure.css" type="text/css" media="all" />
Expand All @@ -25,7 +25,7 @@ <h1><a href="index.html" id="page-header" title="page header title">core.memoize
<div id="leftcolumn"><div style="text-align: center;"></div>
<div class="menu">
<div class="WikiCustomNav WikiElement wiki">
<span class="toc-header"><span id="project-name">core.memoize</span> <span id="version">0.8.3-SNAPSHOT</span> API</span><br />
<span class="toc-header"><span id="project-name">core.memoize</span> <span id="version">1.0.258-SNAPSHOT</span> API</span><br />
<ul>
<li><a href="index.html" class="wiki_link">Overview</a></li>
<li><a href="api-index.html" class="wiki_link">API Index</a></li>
Expand Down Expand Up @@ -124,7 +124,7 @@ <h1 class="nopad">Table of Contents</h1>
</div>
</div>
<div id="content-tag"><h1 id="overview">API for <span id="clojure.core.memoize">clojure.core.memoize</span>
- <span id="header-project">core.memoize</span> <span id="header-version">0.8.3-SNAPSHOT</span><span id="header-status-block"> (<span id="header-status">in development</span>)</span>
- <span id="header-project">core.memoize</span> <span id="header-version">1.0.258-SNAPSHOT</span><span id="header-status-block"> (<span id="header-status">in development</span>)</span>
</h1>
<span id="author-line">by <span id="author-name">fogus</span><br /></span>
<br />Full namespace name: <span id="long-name">clojure.core.memoize</span>
Expand Down Expand Up @@ -170,7 +170,7 @@ <h2 id="clojure.core.memoize/RetryingDelay">RetryingDelay</h2>
<pre id="type-docstr"></pre>
Fields: <span id="type-fields">[fun available? value]</span><br />
Protocols: <span id="type-protocols"></span><br />
Interfaces: <span id="type-interfaces">clojure.lang.IDeref</span><br />
Interfaces: <span id="type-interfaces">clojure.lang.IDeref, clojure.lang.IPending</span><br />
</div>
</div>
<div id="var-section">
Expand All @@ -187,7 +187,7 @@ <h2 id="clojure.core.memoize/-&gt;PluggableMemoization">-&gt;PluggableMemoizatio
<pre id="var-specs"></pre>


<a id="var-source" href="https://github.com/clojure/core.memoize/blob/e1b448aec9b0aa9ce6754373681cfc54c0d5359e/src/main/clojure/clojure/core/memoize.clj#L75">Source</a>
<a id="var-source" href="https://github.com/clojure/core.memoize/blob/2088ed2b2110a7b8deed03f3554f788ad3daae9e/src/main/clojure/clojure/core/memoize.clj#L78">Source</a>
</div><div id="var-entry">
<br />
<hr />
Expand All @@ -199,7 +199,7 @@ <h2 id="clojure.core.memoize/-&gt;RetryingDelay">-&gt;RetryingDelay</h2>
<pre id="var-specs"></pre>


<a id="var-source" href="https://github.com/clojure/core.memoize/blob/e1b448aec9b0aa9ce6754373681cfc54c0d5359e/src/main/clojure/clojure/core/memoize.clj#L35">Source</a>
<a id="var-source" href="https://github.com/clojure/core.memoize/blob/2088ed2b2110a7b8deed03f3554f788ad3daae9e/src/main/clojure/clojure/core/memoize.clj#L35">Source</a>
</div><div id="var-entry">
<br />
<hr />
Expand All @@ -209,7 +209,7 @@ <h2 id="clojure.core.memoize/build-memoizer">build-memoizer</h2>
</pre>
<pre id="var-docstr">Builds a function that, given a function, returns a pluggable memoized
version of it. `build-memoizer` takes a cache factory function, and the
argunments to that factory function -- at least one of those arguments
arguments to that factory function -- at least one of those arguments
should be the function to be memoized (it's usually the first argument).

`memoizer` above is a simpler version of `build-memoizer` that 'does the
Expand All @@ -218,7 +218,7 @@ <h2 id="clojure.core.memoize/build-memoizer">build-memoizer</h2>
<pre id="var-specs"></pre>


<a id="var-source" href="https://github.com/clojure/core.memoize/blob/e1b448aec9b0aa9ce6754373681cfc54c0d5359e/src/main/clojure/clojure/core/memoize.clj#L261">Source</a>
<a id="var-source" href="https://github.com/clojure/core.memoize/blob/2088ed2b2110a7b8deed03f3554f788ad3daae9e/src/main/clojure/clojure/core/memoize.clj#L264">Source</a>
</div><div id="var-entry">
<br />
<hr />
Expand Down Expand Up @@ -256,7 +256,7 @@ <h2 id="clojure.core.memoize/fifo">fifo</h2>
<pre id="var-specs"></pre>


<a id="var-source" href="https://github.com/clojure/core.memoize/blob/e1b448aec9b0aa9ce6754373681cfc54c0d5359e/src/main/clojure/clojure/core/memoize.clj#L339">Source</a>
<a id="var-source" href="https://github.com/clojure/core.memoize/blob/2088ed2b2110a7b8deed03f3554f788ad3daae9e/src/main/clojure/clojure/core/memoize.clj#L357">Source</a>
</div><div id="var-entry">
<br />
<hr />
Expand All @@ -273,7 +273,7 @@ <h2 id="clojure.core.memoize/lazy-snapshot">lazy-snapshot</h2>
<pre id="var-specs"></pre>


<a id="var-source" href="https://github.com/clojure/core.memoize/blob/e1b448aec9b0aa9ce6754373681cfc54c0d5359e/src/main/clojure/clojure/core/memoize.clj#L128">Source</a>
<a id="var-source" href="https://github.com/clojure/core.memoize/blob/2088ed2b2110a7b8deed03f3554f788ad3daae9e/src/main/clojure/clojure/core/memoize.clj#L131">Source</a>
</div><div id="var-entry">
<br />
<hr />
Expand Down Expand Up @@ -322,7 +322,7 @@ <h2 id="clojure.core.memoize/lru">lru</h2>
<pre id="var-specs"></pre>


<a id="var-source" href="https://github.com/clojure/core.memoize/blob/e1b448aec9b0aa9ce6754373681cfc54c0d5359e/src/main/clojure/clojure/core/memoize.clj#L380">Source</a>
<a id="var-source" href="https://github.com/clojure/core.memoize/blob/2088ed2b2110a7b8deed03f3554f788ad3daae9e/src/main/clojure/clojure/core/memoize.clj#L398">Source</a>
</div><div id="var-entry">
<br />
<hr />
Expand Down Expand Up @@ -352,7 +352,7 @@ <h2 id="clojure.core.memoize/lu">lu</h2>
<pre id="var-specs"></pre>


<a id="var-source" href="https://github.com/clojure/core.memoize/blob/e1b448aec9b0aa9ce6754373681cfc54c0d5359e/src/main/clojure/clojure/core/memoize.clj#L469">Source</a>
<a id="var-source" href="https://github.com/clojure/core.memoize/blob/2088ed2b2110a7b8deed03f3554f788ad3daae9e/src/main/clojure/clojure/core/memoize.clj#L487">Source</a>
</div><div id="var-entry">
<br />
<hr />
Expand All @@ -365,22 +365,37 @@ <h2 id="clojure.core.memoize/memo">memo</h2>
function. Memoized functions built using `memo` will respond to
the core.memo manipulable memoization utilities. As a nice bonus,
you can use `memo` in place of `memoize` without any additional
changes.
changes, with the added guarantee that the memoized function will
only be called once for a given sequence of arguments (`memoize`
can call the function multiple times when concurrent calls are
made with the same sequence of arguments).

The default way to use this function is to simply apply a function
The default way to use this function is to simply supply a function
that will be memoized. Additionally, you may also supply a map
of the form `'{[42] 42, [108] 108}` where keys are a vector
mapping expected argument values to arity positions. The map values
are the return values of the memoized function.

If the supplied function has metadata containing an
`:clojure.core.memoize/args-fn` key, the value is assumed to be a
function that should be applied to the arguments to produce a
subset or transformed sequence of arguments that are used for the
key in the cache (the full, original arguments will still be used
to call the function). This allows you to memoize functions where
one or more arguments are irrelevant for memoization, such as the
`clojure.java.jdbc` functions, whose first argument may include
a (mutable) JDBC `Connection` object:

(memo/memo (with-meta jdbc/execute! {::memo/args-fn rest}))

You can access the memoization cache directly via the `:clojure.core.memoize/cache` key
on the memoized function's metadata. However, it is advised to
use the core.memo primitives instead as implementation details may
change over time.</pre>
<pre id="var-specs"></pre>


<a id="var-source" href="https://github.com/clojure/core.memoize/blob/e1b448aec9b0aa9ce6754373681cfc54c0d5359e/src/main/clojure/clojure/core/memoize.clj#L275">Source</a>
<a id="var-source" href="https://github.com/clojure/core.memoize/blob/2088ed2b2110a7b8deed03f3554f788ad3daae9e/src/main/clojure/clojure/core/memoize.clj#L278">Source</a>
</div><div id="var-entry">
<br />
<hr />
Expand All @@ -402,7 +417,7 @@ <h2 id="clojure.core.memoize/memo-clear!">memo-clear!</h2>
<pre id="var-specs"></pre>


<a id="var-source" href="https://github.com/clojure/core.memoize/blob/e1b448aec9b0aa9ce6754373681cfc54c0d5359e/src/main/clojure/clojure/core/memoize.clj#L145">Source</a>
<a id="var-source" href="https://github.com/clojure/core.memoize/blob/2088ed2b2110a7b8deed03f3554f788ad3daae9e/src/main/clojure/clojure/core/memoize.clj#L148">Source</a>
</div><div id="var-entry">
<br />
<hr />
Expand All @@ -416,7 +431,7 @@ <h2 id="clojure.core.memoize/memo-fifo">memo-fifo</h2>
<pre id="var-specs"></pre>


<a id="var-source" href="https://github.com/clojure/core.memoize/blob/e1b448aec9b0aa9ce6754373681cfc54c0d5359e/src/main/clojure/clojure/core/memoize.clj#L332">Source</a>
<a id="var-source" href="https://github.com/clojure/core.memoize/blob/2088ed2b2110a7b8deed03f3554f788ad3daae9e/src/main/clojure/clojure/core/memoize.clj#L350">Source</a>
</div><div id="var-entry">
<br />
<hr />
Expand All @@ -430,7 +445,7 @@ <h2 id="clojure.core.memoize/memo-lru">memo-lru</h2>
<pre id="var-specs"></pre>


<a id="var-source" href="https://github.com/clojure/core.memoize/blob/e1b448aec9b0aa9ce6754373681cfc54c0d5359e/src/main/clojure/clojure/core/memoize.clj#L373">Source</a>
<a id="var-source" href="https://github.com/clojure/core.memoize/blob/2088ed2b2110a7b8deed03f3554f788ad3daae9e/src/main/clojure/clojure/core/memoize.clj#L391">Source</a>
</div><div id="var-entry">
<br />
<hr />
Expand All @@ -444,7 +459,7 @@ <h2 id="clojure.core.memoize/memo-lu">memo-lu</h2>
<pre id="var-specs"></pre>


<a id="var-source" href="https://github.com/clojure/core.memoize/blob/e1b448aec9b0aa9ce6754373681cfc54c0d5359e/src/main/clojure/clojure/core/memoize.clj#L462">Source</a>
<a id="var-source" href="https://github.com/clojure/core.memoize/blob/2088ed2b2110a7b8deed03f3554f788ad3daae9e/src/main/clojure/clojure/core/memoize.clj#L480">Source</a>
</div><div id="var-entry">
<br />
<hr />
Expand All @@ -465,7 +480,7 @@ <h2 id="clojure.core.memoize/memo-reset!">memo-reset!</h2>
<pre id="var-specs"></pre>


<a id="var-source" href="https://github.com/clojure/core.memoize/blob/e1b448aec9b0aa9ce6754373681cfc54c0d5359e/src/main/clojure/clojure/core/memoize.clj#L163">Source</a>
<a id="var-source" href="https://github.com/clojure/core.memoize/blob/2088ed2b2110a7b8deed03f3554f788ad3daae9e/src/main/clojure/clojure/core/memoize.clj#L166">Source</a>
</div><div id="var-entry">
<br />
<hr />
Expand Down Expand Up @@ -498,7 +513,7 @@ <h2 id="clojure.core.memoize/memo-swap!">memo-swap!</h2>
<pre id="var-specs"></pre>


<a id="var-source" href="https://github.com/clojure/core.memoize/blob/e1b448aec9b0aa9ce6754373681cfc54c0d5359e/src/main/clojure/clojure/core/memoize.clj#L179">Source</a>
<a id="var-source" href="https://github.com/clojure/core.memoize/blob/2088ed2b2110a7b8deed03f3554f788ad3daae9e/src/main/clojure/clojure/core/memoize.clj#L182">Source</a>
</div><div id="var-entry">
<br />
<hr />
Expand All @@ -512,7 +527,7 @@ <h2 id="clojure.core.memoize/memo-ttl">memo-ttl</h2>
<pre id="var-specs"></pre>


<a id="var-source" href="https://github.com/clojure/core.memoize/blob/e1b448aec9b0aa9ce6754373681cfc54c0d5359e/src/main/clojure/clojure/core/memoize.clj#L425">Source</a>
<a id="var-source" href="https://github.com/clojure/core.memoize/blob/2088ed2b2110a7b8deed03f3554f788ad3daae9e/src/main/clojure/clojure/core/memoize.clj#L443">Source</a>
</div><div id="var-entry">
<br />
<hr />
Expand All @@ -524,7 +539,7 @@ <h2 id="clojure.core.memoize/memoized?">memoized?</h2>
<pre id="var-specs"></pre>


<a id="var-source" href="https://github.com/clojure/core.memoize/blob/e1b448aec9b0aa9ce6754373681cfc54c0d5359e/src/main/clojure/clojure/core/memoize.clj#L140">Source</a>
<a id="var-source" href="https://github.com/clojure/core.memoize/blob/2088ed2b2110a7b8deed03f3554f788ad3daae9e/src/main/clojure/clojure/core/memoize.clj#L143">Source</a>
</div><div id="var-entry">
<br />
<hr />
Expand All @@ -542,7 +557,7 @@ <h2 id="clojure.core.memoize/memoizer">memoizer</h2>
<pre id="var-specs"></pre>


<a id="var-source" href="https://github.com/clojure/core.memoize/blob/e1b448aec9b0aa9ce6754373681cfc54c0d5359e/src/main/clojure/clojure/core/memoize.clj#L244">Source</a>
<a id="var-source" href="https://github.com/clojure/core.memoize/blob/2088ed2b2110a7b8deed03f3554f788ad3daae9e/src/main/clojure/clojure/core/memoize.clj#L247">Source</a>
</div><div id="var-entry">
<br />
<hr />
Expand All @@ -556,7 +571,7 @@ <h2 id="clojure.core.memoize/snapshot">snapshot</h2>
<pre id="var-specs"></pre>


<a id="var-source" href="https://github.com/clojure/core.memoize/blob/e1b448aec9b0aa9ce6754373681cfc54c0d5359e/src/main/clojure/clojure/core/memoize.clj#L118">Source</a>
<a id="var-source" href="https://github.com/clojure/core.memoize/blob/2088ed2b2110a7b8deed03f3554f788ad3daae9e/src/main/clojure/clojure/core/memoize.clj#L121">Source</a>
</div><div id="var-entry">
<br />
<hr />
Expand All @@ -568,7 +583,7 @@ <h2 id="clojure.core.memoize/ttl">ttl</h2>
(ttl f base key threshold)
</pre>
<pre id="var-docstr">Unlike many of the other core.memo memoization functions,
`memo-ttl`'s cache policy is time-based rather than algortihmic
`memo-ttl`'s cache policy is time-based rather than algorithmic
or explicit. When memoizing a function using `memo-ttl` you
should provide a **T**ime **T**o **L**ive parameter in
milliseconds.
Expand All @@ -590,7 +605,7 @@ <h2 id="clojure.core.memoize/ttl">ttl</h2>
<pre id="var-specs"></pre>


<a id="var-source" href="https://github.com/clojure/core.memoize/blob/e1b448aec9b0aa9ce6754373681cfc54c0d5359e/src/main/clojure/clojure/core/memoize.clj#L432">Source</a>
<a id="var-source" href="https://github.com/clojure/core.memoize/blob/2088ed2b2110a7b8deed03f3554f788ad3daae9e/src/main/clojure/clojure/core/memoize.clj#L450">Source</a>
</div>
</div>

Expand All @@ -601,7 +616,7 @@ <h2 id="clojure.core.memoize/ttl">ttl</h2>
</div>
</div>
<div id="foot">
<div id="copyright" style="text-align: center;">Copyright 2007-2019 by Rich Hickey and the various contributors</div>
<div id="copyright" style="text-align: center;">Copyright 2007-2023 by Rich Hickey and the various contributors</div>
</div>
</div>
<div id="DesignedBy">Logo &amp; site design by <a href="http://www.tomhickey.com" title="Visit Tom Hickey's website.">Tom Hickey</a>.<br />
Expand Down

0 comments on commit 63a4268

Please sign in to comment.