build based on c9a0178

dev/index.html

@@ -19,4 +19,4 @@
   number =       "4",
   pages =        "1066--1095",
   DOI =          "10.1137/19M1266265",
-}</code></pre><h2 id="Docstrings"><a class="docs-heading-anchor" href="#Docstrings">Docstrings</a><a id="Docstrings-1"></a><a class="docs-heading-anchor-permalink" href="#Docstrings" title="Permalink"></a></h2><ul><li><a href="#GCPDecompositions.GCPDecompositions"><code>GCPDecompositions.GCPDecompositions</code></a></li><li><a href="#GCPDecompositions.CPD"><code>GCPDecompositions.CPD</code></a></li><li><a href="#GCPDecompositions.gcp"><code>GCPDecompositions.gcp</code></a></li></ul><article class="docstring"><header><a class="docstring-binding" id="GCPDecompositions.GCPDecompositions" href="#GCPDecompositions.GCPDecompositions"><code>GCPDecompositions.GCPDecompositions</code></a> — <span class="docstring-category">Module</span></header><section><div><p>Generalized CP Decomposition module. Provides approximate CP tensor decomposition with respect to general losses.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/dahong67/GCPDecompositions.jl/blob/7c573f88432f71925caf144e56220faddd8f3a52/src/GCPDecompositions.jl#L1-L3">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="GCPDecompositions.CPD" href="#GCPDecompositions.CPD"><code>GCPDecompositions.CPD</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">CPD</code></pre><p>Tensor decomposition type for the canonical polyadic decompositions (CPD) of a tensor (i.e., a multi-dimensional array) <code>A</code>.</p><p>If <code>F::CPD</code> is the decomposition object, the weights <code>λ</code> and factor matrices <code>U = (U[1],...,U[N])</code> can be obtained via <code>F.λ</code> and <code>F.U</code>, such that <code>A = Σ_j λ[j] U[1][:,j] ∘ ⋯ ∘ U[N][:,j]</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/dahong67/GCPDecompositions.jl/blob/7c573f88432f71925caf144e56220faddd8f3a52/src/type-cpd.jl#L3-L13">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="GCPDecompositions.gcp" href="#GCPDecompositions.gcp"><code>GCPDecompositions.gcp</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">gcp(X::Array, r[, func, grad, lower]) -&gt; CPD</code></pre><p>Compute an approximate rank-<code>r</code> CP decomposition of the tensor <code>X</code> with respect to a general loss and return a <code>CPD</code> object.</p><p><strong>Inputs</strong></p><ul><li><code>X</code> : multi-dimensional tensor/array to approximate/decompose</li><li><code>r</code> : number of components for the CPD</li><li><code>func</code> : loss function, <code>default = (x, m) -&gt; (m - x)^2</code></li><li><code>grad</code> : loss function derivative, default uses <code>ForwardDiff.jl</code></li><li><code>lower</code> : lower bound for factor matrix entries, <code>default = -Inf</code></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/dahong67/GCPDecompositions.jl/blob/7c573f88432f71925caf144e56220faddd8f3a52/src/gcp-opt.jl#L4-L17">source</a></section></article></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.23 on <span class="colophon-date" title="Tuesday 10 October 2023 16:19">Tuesday 10 October 2023</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+}</code></pre><h2 id="Docstrings"><a class="docs-heading-anchor" href="#Docstrings">Docstrings</a><a id="Docstrings-1"></a><a class="docs-heading-anchor-permalink" href="#Docstrings" title="Permalink"></a></h2><ul><li><a href="#GCPDecompositions.GCPDecompositions"><code>GCPDecompositions.GCPDecompositions</code></a></li><li><a href="#GCPDecompositions.CPD"><code>GCPDecompositions.CPD</code></a></li><li><a href="#GCPDecompositions.gcp"><code>GCPDecompositions.gcp</code></a></li></ul><article class="docstring"><header><a class="docstring-binding" id="GCPDecompositions.GCPDecompositions" href="#GCPDecompositions.GCPDecompositions"><code>GCPDecompositions.GCPDecompositions</code></a> — <span class="docstring-category">Module</span></header><section><div><p>Generalized CP Decomposition module. Provides approximate CP tensor decomposition with respect to general losses.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/dahong67/GCPDecompositions.jl/blob/c9a01787647afe38778d0b2bc64f586cc342afc0/src/GCPDecompositions.jl#L1-L3">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="GCPDecompositions.CPD" href="#GCPDecompositions.CPD"><code>GCPDecompositions.CPD</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">CPD</code></pre><p>Tensor decomposition type for the canonical polyadic decompositions (CPD) of a tensor (i.e., a multi-dimensional array) <code>A</code>.</p><p>If <code>F::CPD</code> is the decomposition object, the weights <code>λ</code> and factor matrices <code>U = (U[1],...,U[N])</code> can be obtained via <code>F.λ</code> and <code>F.U</code>, such that <code>A = Σ_j λ[j] U[1][:,j] ∘ ⋯ ∘ U[N][:,j]</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/dahong67/GCPDecompositions.jl/blob/c9a01787647afe38778d0b2bc64f586cc342afc0/src/type-cpd.jl#L3-L13">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="GCPDecompositions.gcp" href="#GCPDecompositions.gcp"><code>GCPDecompositions.gcp</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">gcp(X::Array, r[, func, grad, lower]) -&gt; CPD</code></pre><p>Compute an approximate rank-<code>r</code> CP decomposition of the tensor <code>X</code> with respect to a general loss and return a <code>CPD</code> object.</p><p><strong>Inputs</strong></p><ul><li><code>X</code> : multi-dimensional tensor/array to approximate/decompose</li><li><code>r</code> : number of components for the CPD</li><li><code>func</code> : loss function, <code>default = (x, m) -&gt; (m - x)^2</code></li><li><code>grad</code> : loss function derivative, default uses <code>ForwardDiff.jl</code></li><li><code>lower</code> : lower bound for factor matrix entries, <code>default = -Inf</code></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/dahong67/GCPDecompositions.jl/blob/c9a01787647afe38778d0b2bc64f586cc342afc0/src/gcp-opt.jl#L4-L17">source</a></section></article></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.23 on <span class="colophon-date" title="Tuesday 10 October 2023 18:03">Tuesday 10 October 2023</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/search/index.html

@@ -1,2 +1,2 @@
 <!DOCTYPE html>
-<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Search · GCPDecompositions.jl</title><script data-outdated-warner src="../assets/warner.js"></script><link rel="canonical" href="https://dahong67.github.io/GCPDecompositions.jl/search/"/><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">GCPDecompositions.jl</a></span></div><form class="docs-search" action><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Search</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Search</a></li></ul></nav><div class="docs-right"><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article><p id="documenter-search-info">Loading search...</p><ul id="documenter-search-results"></ul></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.23 on <span class="colophon-date" title="Tuesday 10 October 2023 16:19">Tuesday 10 October 2023</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body><script src="../search_index.js"></script><script src="../assets/search.js"></script></html>
+<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Search · GCPDecompositions.jl</title><script data-outdated-warner src="../assets/warner.js"></script><link rel="canonical" href="https://dahong67.github.io/GCPDecompositions.jl/search/"/><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">GCPDecompositions.jl</a></span></div><form class="docs-search" action><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Search</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Search</a></li></ul></nav><div class="docs-right"><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article><p id="documenter-search-info">Loading search...</p><ul id="documenter-search-results"></ul></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.23 on <span class="colophon-date" title="Tuesday 10 October 2023 18:03">Tuesday 10 October 2023</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body><script src="../search_index.js"></script><script src="../assets/search.js"></script></html>