blob: 96d78f52f0c96da2a69ebc171bcc5b2b01bde18b [file] [log] [blame]
<!DOCTYPE html PUBLIC ""
"">
<html><head><meta charset="UTF-8" /><title>org.apache.clojure-mxnet.util documentation</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Clojure-mxnet</span> <span class="project-version">1.8.0-SNAPSHOT</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>org</span></div></div></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>apache</span></div></div></li><li class="depth-3"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>clojure-mxnet</span></div></div></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.base.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>base</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.callback.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>callback</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.context.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>context</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.dtype.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>dtype</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.eval-metric.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>eval-metric</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.executor.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>executor</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.image.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>image</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.infer.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>infer</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.initializer.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>initializer</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.io.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>io</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.kvstore.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>kvstore</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.kvstore-server.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>kvstore-server</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.layout.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>layout</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.lr-scheduler.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>lr-scheduler</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.module.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>module</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.monitor.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>monitor</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.ndarray.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>ndarray</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.ndarray-api.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>ndarray-api</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.ndarray-random-api.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>ndarray-random-api</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.optimizer.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>optimizer</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.primitives.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>primitives</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.profiler.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>profiler</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.random.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>random</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.resource-scope.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>resource-scope</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.shape.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>shape</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.symbol.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>symbol</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.symbol-api.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>symbol-api</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.symbol-random-api.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>symbol-random-api</span></div></a></li><li class="depth-4 branch current"><a href="org.apache.clojure-mxnet.util.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>util</span></div></a></li><li class="depth-4"><a href="org.apache.clojure-mxnet.visualization.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>visualization</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="org.apache.clojure-mxnet.util.html#var--.3Eint-option"><div class="inner"><span>-&gt;int-option</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.util.html#var--.3Eoption"><div class="inner"><span>-&gt;option</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.util.html#var-apply-scala-fn"><div class="inner"><span>apply-scala-fn</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.util.html#var-buffer-.3Evec"><div class="inner"><span>buffer-&gt;vec</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.util.html#var-coerce-param"><div class="inner"><span>coerce-param</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.util.html#var-coerce-return"><div class="inner"><span>coerce-return</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.util.html#var-coerce-return-recursive"><div class="inner"><span>coerce-return-recursive</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.util.html#var-convert-by-shape"><div class="inner"><span>convert-by-shape</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.util.html#var-convert-io-map"><div class="inner"><span>convert-io-map</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.util.html#var-convert-map"><div class="inner"><span>convert-map</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.util.html#var-convert-shape-map"><div class="inner"><span>convert-shape-map</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.util.html#var-convert-symbol-map"><div class="inner"><span>convert-symbol-map</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.util.html#var-convert-tuple"><div class="inner"><span>convert-tuple</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.util.html#var-convert-vector"><div class="inner"><span>convert-vector</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.util.html#var-empty-indexed-seq"><div class="inner"><span>empty-indexed-seq</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.util.html#var-empty-list"><div class="inner"><span>empty-list</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.util.html#var-empty-list-map"><div class="inner"><span>empty-list-map</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.util.html#var-empty-map"><div class="inner"><span>empty-map</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.util.html#var-forms-.3Escala-fn"><div class="inner"><span>forms-&gt;scala-fn</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.util.html#var-io-convert-by-param-name"><div class="inner"><span>io-convert-by-param-name</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.util.html#var-io-param-names"><div class="inner"><span>io-param-names</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.util.html#var-keyword-.3Esnake-case"><div class="inner"><span>keyword-&gt;snake-case</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.util.html#var-list-map"><div class="inner"><span>list-map</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.util.html#var-map-.3Escala-tuple-seq"><div class="inner"><span>map-&gt;scala-tuple-seq</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.util.html#var-map-.3Etuple"><div class="inner"><span>map-&gt;tuple</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.util.html#var-nd-seq-shape"><div class="inner"><span>nd-seq-shape</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.util.html#var-ndarray-param-coerce"><div class="inner"><span>ndarray-param-coerce</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.util.html#var-nil-or-coerce-param"><div class="inner"><span>nil-or-coerce-param</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.util.html#var-option-.3Evalue"><div class="inner"><span>option-&gt;value</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.util.html#var-scala-fn"><div class="inner"><span>scala-fn</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.util.html#var-scala-iterator-.3Eseq"><div class="inner"><span>scala-iterator-&gt;seq</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.util.html#var-scala-map-.3Emap"><div class="inner"><span>scala-map-&gt;map</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.util.html#var-scala-vector-.3Evec"><div class="inner"><span>scala-vector-&gt;vec</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.util.html#var-symbol-param-coerce"><div class="inner"><span>symbol-param-coerce</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.util.html#var-to-array-nd"><div class="inner"><span>to-array-nd</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.util.html#var-translate-keyword-shape"><div class="inner"><span>translate-keyword-shape</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.util.html#var-tuple-.3Evec"><div class="inner"><span>tuple-&gt;vec</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.util.html#var-tuple-convert-by-param-name"><div class="inner"><span>tuple-convert-by-param-name</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.util.html#var-tuple-param-names"><div class="inner"><span>tuple-param-names</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.util.html#var-validate.21"><div class="inner"><span>validate!</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.util.html#var-vec-.3Eindexed-seq"><div class="inner"><span>vec-&gt;indexed-seq</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.util.html#var-vec-.3Eset"><div class="inner"><span>vec-&gt;set</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">org.apache.clojure-mxnet.util</h1><div class="doc"><pre class="plaintext"></pre></div><div class="public anchor" id="var--.3Eint-option"><h3>-&gt;int-option</h3><div class="usage"><code>(-&gt;int-option v)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var--.3Eoption"><h3>-&gt;option</h3><div class="usage"><code>(-&gt;option v)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-apply-scala-fn"><h3>apply-scala-fn</h3><div class="usage"><code>(apply-scala-fn f args)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-buffer-.3Evec"><h3>buffer-&gt;vec</h3><div class="usage"><code>(buffer-&gt;vec b)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-coerce-param"><h3>coerce-param</h3><div class="usage"><code>(coerce-param param targets)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-coerce-return"><h3>coerce-return</h3><div class="usage"><code>(coerce-return return-val)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-coerce-return-recursive"><h3>coerce-return-recursive</h3><div class="usage"><code>(coerce-return-recursive return-val)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-convert-by-shape"><h3>convert-by-shape</h3><div class="usage"><code>(convert-by-shape param)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-convert-io-map"><h3>convert-io-map</h3><div class="usage"><code>(convert-io-map param)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-convert-map"><h3>convert-map</h3><div class="usage"><code>(convert-map param)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-convert-shape-map"><h3>convert-shape-map</h3><div class="usage"><code>(convert-shape-map param)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-convert-symbol-map"><h3>convert-symbol-map</h3><div class="usage"><code>(convert-symbol-map param)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-convert-tuple"><h3>convert-tuple</h3><div class="usage"><code>(convert-tuple param)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-convert-vector"><h3>convert-vector</h3><div class="usage"><code>(convert-vector param)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-empty-indexed-seq"><h3>empty-indexed-seq</h3><div class="usage"><code>(empty-indexed-seq)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-empty-list"><h3>empty-list</h3><div class="usage"><code>(empty-list)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-empty-list-map"><h3>empty-list-map</h3><div class="usage"><code>(empty-list-map)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-empty-map"><h3>empty-map</h3><div class="usage"><code>(empty-map)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-forms-.3Escala-fn"><h3>forms-&gt;scala-fn</h3><h4 class="type">macro</h4><div class="usage"><code>(forms-&gt;scala-fn &amp; forms)</code></div><div class="doc"><pre class="plaintext">Creates a scala fn of zero args from forms
</pre></div></div><div class="public anchor" id="var-io-convert-by-param-name"><h3>io-convert-by-param-name</h3><div class="usage"><code>(io-convert-by-param-name param)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-io-param-names"><h3>io-param-names</h3><div class="usage"></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-keyword-.3Esnake-case"><h3>keyword-&gt;snake-case</h3><div class="usage"><code>(keyword-&gt;snake-case kw)</code></div><div class="doc"><pre class="plaintext">Transforms a keyword `kw` into a snake-case string.
`kw`: keyword
returns: string
Ex:
(keyword-&gt;snake-case :foo-bar) ;"foo_bar"
(keyword-&gt;snake-case :foo) ;"foo"</pre></div></div><div class="public anchor" id="var-list-map"><h3>list-map</h3><div class="usage"><code>(list-map m)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-map-.3Escala-tuple-seq"><h3>map-&gt;scala-tuple-seq</h3><div class="usage"><code>(map-&gt;scala-tuple-seq map-or-tuple-seq)</code></div><div class="doc"><pre class="plaintext">* Convert a map to a scala-Seq of scala-Tuple.
* Should also work if a seq of seq of 2 things passed.
* Otherwise passed through unchanged.</pre></div></div><div class="public anchor" id="var-map-.3Etuple"><h3>map-&gt;tuple</h3><div class="usage"><code>(map-&gt;tuple m)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-nd-seq-shape"><h3>nd-seq-shape</h3><div class="usage"><code>(nd-seq-shape nd-seq)</code></div><div class="doc"><pre class="plaintext">Computes the shape of a n-dimensional sequential structure
</pre></div></div><div class="public anchor" id="var-ndarray-param-coerce"><h3>ndarray-param-coerce</h3><div class="usage"></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-nil-or-coerce-param"><h3>nil-or-coerce-param</h3><div class="usage"><code>(nil-or-coerce-param param targets)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-option-.3Evalue"><h3>option-&gt;value</h3><div class="usage"><code>(option-&gt;value opt)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-scala-fn"><h3>scala-fn</h3><h4 class="type">macro</h4><div class="usage"><code>(scala-fn f)</code></div><div class="doc"><pre class="plaintext">Creates a scala fn from an anonymous clojure fn of the form (fn [x] body)
</pre></div></div><div class="public anchor" id="var-scala-iterator-.3Eseq"><h3>scala-iterator-&gt;seq</h3><div class="usage"><code>(scala-iterator-&gt;seq x)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-scala-map-.3Emap"><h3>scala-map-&gt;map</h3><div class="usage"><code>(scala-map-&gt;map m)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-scala-vector-.3Evec"><h3>scala-vector-&gt;vec</h3><div class="usage"><code>(scala-vector-&gt;vec x)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-symbol-param-coerce"><h3>symbol-param-coerce</h3><div class="usage"></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-to-array-nd"><h3>to-array-nd</h3><div class="usage"><code>(to-array-nd nd-seq)</code></div><div class="doc"><pre class="plaintext">Converts any N-D sequential structure to an array
with the same dimensions.</pre></div></div><div class="public anchor" id="var-translate-keyword-shape"><h3>translate-keyword-shape</h3><div class="usage"><code>(translate-keyword-shape [k v])</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-tuple-.3Evec"><h3>tuple-&gt;vec</h3><div class="usage"><code>(tuple-&gt;vec p)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-tuple-convert-by-param-name"><h3>tuple-convert-by-param-name</h3><div class="usage"><code>(tuple-convert-by-param-name param)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-tuple-param-names"><h3>tuple-param-names</h3><div class="usage"></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-validate.21"><h3>validate!</h3><div class="usage"><code>(validate! spec value error-msg)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-vec-.3Eindexed-seq"><h3>vec-&gt;indexed-seq</h3><div class="usage"><code>(vec-&gt;indexed-seq x)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-vec-.3Eset"><h3>vec-&gt;set</h3><div class="usage"><code>(vec-&gt;set param)</code></div><div class="doc"><pre class="plaintext"></pre></div></div></div></body></html>