Skip to content

Commit

Permalink
build based on d9190dd
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Nov 6, 2024
1 parent b39a524 commit 5a18a04
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion dev/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · PartitionedVectors.jl</title><script data-outdated-warner src="assets/warner.js"></script><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><link href="assets/style.css" rel="stylesheet" type="text/css"/></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href><img src="assets/logo.png" alt="PartitionedVectors.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href>PartitionedVectors.jl</a></span></div><form class="docs-search" action="search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>Home</a><ul class="internal"><li><a class="tocitem" href="#Compatibility"><span>Compatibility</span></a></li><li><a class="tocitem" href="#How-to-install"><span>How to install</span></a></li><li><a class="tocitem" href="#Synopsis"><span>Synopsis</span></a></li><li><a class="tocitem" href="#How-to-use"><span>How to use</span></a></li><li><a class="tocitem" href="#How-to-Cite"><span>How to Cite</span></a></li><li class="toplevel"><a class="tocitem" href="#Bug-reports-and-discussions"><span>Bug reports and discussions</span></a></li></ul></li><li><a class="tocitem" href="tutorial/">Tutorial</a></li><li><a class="tocitem" href="reference/">Reference</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>Home</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Home</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/JuliaSmoothOptimizers/PartitionedVectors.jl/blob/main/docs/src/index.md" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><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 class="content" id="documenter-page"><h1 id="PartitionedVectors.jl"><a class="docs-heading-anchor" href="#PartitionedVectors.jl">PartitionedVectors.jl</a><a id="PartitionedVectors.jl-1"></a><a class="docs-heading-anchor-permalink" href="#PartitionedVectors.jl" title="Permalink"></a></h1><h2 id="Compatibility"><a class="docs-heading-anchor" href="#Compatibility">Compatibility</a><a id="Compatibility-1"></a><a class="docs-heading-anchor-permalink" href="#Compatibility" title="Permalink"></a></h2><p>Julia ≥ 1.6.</p><h2 id="How-to-install"><a class="docs-heading-anchor" href="#How-to-install">How to install</a><a id="How-to-install-1"></a><a class="docs-heading-anchor-permalink" href="#How-to-install" title="Permalink"></a></h2><p>This module can be installed with the following command:</p><pre><code class="language-julia hljs">pkg&gt; add PartitionedVectors
pkg&gt; test PartitionedVectors</code></pre><h2 id="Synopsis"><a class="docs-heading-anchor" href="#Synopsis">Synopsis</a><a id="Synopsis-1"></a><a class="docs-heading-anchor-permalink" href="#Synopsis" title="Permalink"></a></h2><p>A <code>PartitionedVector &lt;: DenseVector &lt;: AbstractVector</code> wraps a <a href="https://github.com/JuliaSmoothOptimizers/PartitionedStructures.jl">PartitionedStructures</a><code>.Elemental_pv</code>, to make <a href="https://github.com/JuliaSmoothOptimizers">JuliaSmoothOptimizers</a> modules able to exploit the partially separable structure.</p><h2 id="How-to-use"><a class="docs-heading-anchor" href="#How-to-use">How to use</a><a id="How-to-use-1"></a><a class="docs-heading-anchor-permalink" href="#How-to-use" title="Permalink"></a></h2><p>Check the <a href="https://JuliaSmoothOptimizers.github.io/PartitionedVectors.jl/dev/tutorial/">tutorial</a>.</p><h2 id="How-to-Cite"><a class="docs-heading-anchor" href="#How-to-Cite">How to Cite</a><a id="How-to-Cite-1"></a><a class="docs-heading-anchor-permalink" href="#How-to-Cite" title="Permalink"></a></h2><p>If you use PartitionedVectors.jl in your work, please cite using the format given in <a href="https://github.com/JuliaSmoothOptimizers/PartitionedVectors.jl/blob/main/CITATION.bib"><code>CITATION.bib</code></a>.</p><h1 id="Bug-reports-and-discussions"><a class="docs-heading-anchor" href="#Bug-reports-and-discussions">Bug reports and discussions</a><a id="Bug-reports-and-discussions-1"></a><a class="docs-heading-anchor-permalink" href="#Bug-reports-and-discussions" title="Permalink"></a></h1><p>If you think you found a bug, feel free to open an <a href="https://github.com/JuliaSmoothOptimizers/PartitionedVectors.jl/issues">issue</a>. Focused suggestions and requests can also be opened as issues. Before opening a pull request, start an issue or a discussion on the topic, please.</p><p>If you want to ask a question not suited for a bug report, feel free to start a discussion <a href="https://github.com/JuliaSmoothOptimizers/Organization/discussions">here</a>. This forum is for general discussion about this repository and the <a href="https://github.com/JuliaSmoothOptimizers">JuliaSmoothOptimizers</a>, so questions about any of our packages are welcome.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="tutorial/">Tutorial »</a><div class="flexbox-break"></div><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.25 on <span class="colophon-date" title="Wednesday 6 November 2024 14:06">Wednesday 6 November 2024</span>. Using Julia version 1.7.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
pkg&gt; test PartitionedVectors</code></pre><h2 id="Synopsis"><a class="docs-heading-anchor" href="#Synopsis">Synopsis</a><a id="Synopsis-1"></a><a class="docs-heading-anchor-permalink" href="#Synopsis" title="Permalink"></a></h2><p>A <code>PartitionedVector &lt;: DenseVector &lt;: AbstractVector</code> wraps a <a href="https://github.com/JuliaSmoothOptimizers/PartitionedStructures.jl">PartitionedStructures</a><code>.Elemental_pv</code>, to make <a href="https://github.com/JuliaSmoothOptimizers">JuliaSmoothOptimizers</a> modules able to exploit the partially separable structure.</p><h2 id="How-to-use"><a class="docs-heading-anchor" href="#How-to-use">How to use</a><a id="How-to-use-1"></a><a class="docs-heading-anchor-permalink" href="#How-to-use" title="Permalink"></a></h2><p>Check the <a href="https://JuliaSmoothOptimizers.github.io/PartitionedVectors.jl/dev/tutorial/">tutorial</a>.</p><h2 id="How-to-Cite"><a class="docs-heading-anchor" href="#How-to-Cite">How to Cite</a><a id="How-to-Cite-1"></a><a class="docs-heading-anchor-permalink" href="#How-to-Cite" title="Permalink"></a></h2><p>If you use PartitionedVectors.jl in your work, please cite using the format given in <a href="https://github.com/JuliaSmoothOptimizers/PartitionedVectors.jl/blob/main/CITATION.bib"><code>CITATION.bib</code></a>.</p><h1 id="Bug-reports-and-discussions"><a class="docs-heading-anchor" href="#Bug-reports-and-discussions">Bug reports and discussions</a><a id="Bug-reports-and-discussions-1"></a><a class="docs-heading-anchor-permalink" href="#Bug-reports-and-discussions" title="Permalink"></a></h1><p>If you think you found a bug, feel free to open an <a href="https://github.com/JuliaSmoothOptimizers/PartitionedVectors.jl/issues">issue</a>. Focused suggestions and requests can also be opened as issues. Before opening a pull request, start an issue or a discussion on the topic, please.</p><p>If you want to ask a question not suited for a bug report, feel free to start a discussion <a href="https://github.com/JuliaSmoothOptimizers/Organization/discussions">here</a>. This forum is for general discussion about this repository and the <a href="https://github.com/JuliaSmoothOptimizers">JuliaSmoothOptimizers</a>, so questions about any of our packages are welcome.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="tutorial/">Tutorial »</a><div class="flexbox-break"></div><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.25 on <span class="colophon-date" title="Wednesday 6 November 2024 14:43">Wednesday 6 November 2024</span>. Using Julia version 1.7.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 5a18a04

Please sign in to comment.