From 63a4268680e9f34bd39f150db624f477de735e5c Mon Sep 17 00:00:00 2001 From: clojure-build Date: Wed, 16 Aug 2023 14:40:36 +0000 Subject: [PATCH] Autodoc commit --- api-index.html | 8 +++--- index.html | 71 ++++++++++++++++++++++++++++++-------------------- 2 files changed, 47 insertions(+), 32 deletions(-) diff --git a/api-index.html b/api-index.html index 96a64e4..0ca5bce 100644 --- a/api-index.html +++ b/api-index.html @@ -1,7 +1,7 @@ - Index - core.memoize 0.8.3-SNAPSHOT API documentation + Index - core.memoize 1.0.258-SNAPSHOT API documentation @@ -25,7 +25,7 @@

core.memoize
- core.memoize 0.8.3-SNAPSHOT API
+ core.memoize 1.0.258-SNAPSHOT API
  • Overview
  • API Index
    • @@ -41,7 +41,7 @@

    core.memoize
    -

    Index of Public Functions and Variables - core.memoize 0.8.3-SNAPSHOT (in development)

    +

    Index of Public Functions and Variables - core.memoize 1.0.258-SNAPSHOT (in development)

    This page has an alphabetical index of all the documented functions and variables in core.memoize. @@ -233,7 +233,7 @@

    Other

    Logo & site design by Tom Hickey.
    diff --git a/index.html b/index.html index 17b97fd..1bcc796 100644 --- a/index.html +++ b/index.html @@ -1,7 +1,7 @@ - clojure.core.memoize - core.memoize 0.8.3-SNAPSHOT API documentation + clojure.core.memoize - core.memoize 1.0.258-SNAPSHOT API documentation @@ -25,7 +25,7 @@

    core.memoize
    - core.memoize 0.8.3-SNAPSHOT API
    + core.memoize 1.0.258-SNAPSHOT API

    API for clojure.core.memoize - - core.memoize 0.8.3-SNAPSHOT (in development) + - core.memoize 1.0.258-SNAPSHOT (in development)

    by fogus
    Full namespace name: clojure.core.memoize @@ -170,7 +170,7 @@

    RetryingDelay

    
     Fields: [fun available? value]
    
     Protocols: 
    
-    Interfaces: clojure.lang.IDeref
    
+    Interfaces: clojure.lang.IDeref, clojure.lang.IPending
    
   
    
 
    
 
    
@@ -187,7 +187,7 @@ 
    ->PluggableMemoizatio
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -199,7 +199,7 @@ 
    ->RetryingDelay
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -209,7 +209,7 @@ 
    build-memoizer
    
 
     
    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
@@ -218,7 +218,7 @@ 
    build-memoizer
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -256,7 +256,7 @@ 
    fifo
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -273,7 +273,7 @@ 
    lazy-snapshot
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -322,7 +322,7 @@ 
    lru
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -352,7 +352,7 @@ 
    lu
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -365,14 +365,29 @@ 
    memo
    
 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
@@ -380,7 +395,7 @@ 
    memo
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -402,7 +417,7 @@ 
    memo-clear!
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -416,7 +431,7 @@ 
    memo-fifo
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -430,7 +445,7 @@ 
    memo-lru
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -444,7 +459,7 @@ 
    memo-lu
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -465,7 +480,7 @@ 
    memo-reset!
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -498,7 +513,7 @@ 
    memo-swap!
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -512,7 +527,7 @@ 
    memo-ttl
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -524,7 +539,7 @@ 
    memoized?
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -542,7 +557,7 @@ 
    memoizer
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -556,7 +571,7 @@ 
    snapshot
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -568,7 +583,7 @@ 
    ttl
    
        (ttl f base key threshold)
 
     
    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.
@@ -590,7 +605,7 @@ 
    ttl
    
     
    
     
     
-    Source
+    Source
   
    
 
    
 
@@ -601,7 +616,7 @@ 
    ttl
    
           
    
 	
    
 	
       

       
Logo & site design by Tom Hickey.