Skip to content

Commit e3002a8

Browse files
author
Documenter.jl
committed
build based on b89c568 
1 parent 6bea1a8 commit e3002a8

3 files changed

Lines changed: 3 additions & 3 deletions

File tree

‎dev/.documenter-siteinfo.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"documenter":{"documenter_version":"1.17.0","generation_timestamp":"2026-04-02T05:43:57","julia_version":"1.12.5"}}
1+
{"documenter":{"documenter_version":"1.17.0","generation_timestamp":"2026-04-09T05:50:56","julia_version":"1.12.5"}}

‎dev/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@
1212
@test blockstoredlength(a) == 2
1313
b = a .+ 2 .* a'
1414
@test Array(b) ≈ Array(a) + 2 * Array(a')
15-
@test blockstoredlength(b) == 2</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi"><span class="sgr32"><span class="sgr1">Test Passed</span></span></code></pre><hr/><p><em>This page was generated using <a href="https://github.com/fredrikekre/Literate.jl">Literate.jl</a>.</em></p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="reference/">Reference »</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="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.17.0 on <span class="colophon-date" title="Thursday 2 April 2026 05:43">Thursday 2 April 2026</span>. Using Julia version 1.12.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
15+
@test blockstoredlength(b) == 2</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi"><span class="sgr32"><span class="sgr1">Test Passed</span></span></code></pre><hr/><p><em>This page was generated using <a href="https://github.com/fredrikekre/Literate.jl">Literate.jl</a>.</em></p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="reference/">Reference »</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="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.17.0 on <span class="colophon-date" title="Thursday 9 April 2026 05:50">Thursday 9 April 2026</span>. Using Julia version 1.12.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

‎dev/reference/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Reference · BlockSparseArrays.jl</title><meta name="title" content="Reference · BlockSparseArrays.jl"/><meta property="og:title" content="Reference · BlockSparseArrays.jl"/><meta property="twitter:title" content="Reference · BlockSparseArrays.jl"/><meta name="description" content="Documentation for BlockSparseArrays.jl."/><meta property="og:description" content="Documentation for BlockSparseArrays.jl."/><meta property="twitter:description" content="Documentation for BlockSparseArrays.jl."/><meta property="og:url" content="https://itensor.github.io/BlockSparseArrays.jl/reference/"/><meta property="twitter:url" content="https://itensor.github.io/BlockSparseArrays.jl/reference/"/><link rel="canonical" href="https://itensor.github.io/BlockSparseArrays.jl/reference/"/><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.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/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="../search_index.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/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><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/favicon.ico" rel="icon" type="image/x-icon"/><link href="../assets/extras.css" rel="stylesheet" type="text/css"/></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../"><img class="docs-light-only" src="../assets/logo.png" alt="BlockSparseArrays.jl logo"/><img class="docs-dark-only" src="../assets/logo-dark.png" alt="BlockSparseArrays.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../">BlockSparseArrays.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li class="is-active"><a class="tocitem" href>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"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Reference</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Reference</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/ITensor/BlockSparseArrays.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/ITensor/BlockSparseArrays.jl/blob/main/docs/src/reference.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Reference"><a class="docs-heading-anchor" href="#Reference">Reference</a><a id="Reference-1"></a><a class="docs-heading-anchor-permalink" href="#Reference" title="Permalink"></a></h1><article><details class="docstring" open="true"><summary id="BlockSparseArrays.BlockDiagonalAlgorithm"><a class="docstring-binding" href="#BlockSparseArrays.BlockDiagonalAlgorithm"><code>BlockSparseArrays.BlockDiagonalAlgorithm</code></a> — <span class="docstring-category">Type</span></summary><section><div><pre><code class="language-julia hljs">BlockDiagonalAlgorithm([f]) &lt;: MatrixAlgebraKit.AbstractAlgorithm</code></pre><p>Type for handling algorithms on a block-by-block basis, which is possible for block-diagonal input matrices. Additionally this algorithm may take a function that, given the individual blocks, returns the algorithm that will be used. This can be leveraged to allow for different algorithms for each block.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ITensor/BlockSparseArrays.jl/blob/b89c5686e7fc21ebfbe02951faa1d8bf3084b523/src/factorizations/utility.jl#L85-L93">source</a></section></details></article><article><details class="docstring" open="true"><summary id="BlockSparseArrays.BlockDiagonalTruncationStrategy"><a class="docstring-binding" href="#BlockSparseArrays.BlockDiagonalTruncationStrategy"><code>BlockSparseArrays.BlockDiagonalTruncationStrategy</code></a> — <span class="docstring-category">Type</span></summary><section><div><pre><code class="language-julia hljs">BlockDiagonalTruncationStrategy(strategy::TruncationStrategy)</code></pre><p>A wrapper for <code>TruncationStrategy</code> that implements the wrapped strategy on a block-by-block basis, which is possible if the input matrix is a block-diagonal matrix.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ITensor/BlockSparseArrays.jl/blob/b89c5686e7fc21ebfbe02951faa1d8bf3084b523/src/factorizations/truncation.jl#L4-L9">source</a></section></details></article><article><details class="docstring" open="true"><summary id="BlockSparseArrays.BlockPermutedDiagonalAlgorithm"><a class="docstring-binding" href="#BlockSparseArrays.BlockPermutedDiagonalAlgorithm"><code>BlockSparseArrays.BlockPermutedDiagonalAlgorithm</code></a> — <span class="docstring-category">Type</span></summary><section><div><pre><code class="language-julia hljs">BlockPermutedDiagonalAlgorithm([f]) &lt;: MatrixAlgebraKit.AbstractAlgorithm</code></pre><p>Type for handling algorithms on a block-by-block basis, which is possible for block-diagonal or block-permuted-diagonal input matrices. The algorithms proceed by first permuting to a block-diagonal form, and then carrying out the algorithm. Additionally this algorithm may take a function that, given the individual blocks, returns the algorithm that will be used. This can be leveraged to allow for different algorithms for each block.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ITensor/BlockSparseArrays.jl/blob/b89c5686e7fc21ebfbe02951faa1d8bf3084b523/src/factorizations/utility.jl#L105-L114">source</a></section></details></article><article><details class="docstring" open="true"><summary id="BlockSparseArrays.BlockSparseArray"><a class="docstring-binding" href="#BlockSparseArrays.BlockSparseArray"><code>BlockSparseArrays.BlockSparseArray</code></a> — <span class="docstring-category">Type</span></summary><section><div><pre><code class="language-julia hljs">BlockSparseArray{T}(undef, dims)
33
BlockSparseArray{T,N}(undef, dims)
44
BlockSparseArray{T,N,A}(undef, dims)</code></pre><p>Construct an uninitialized N-dimensional BlockSparseArray containing elements of type T. <code>dims</code> should be a list of block lengths in each dimension or a list of blocked ranges representing the axes.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ITensor/BlockSparseArrays.jl/blob/b89c5686e7fc21ebfbe02951faa1d8bf3084b523/src/blocksparsearray/blocksparsearray.jl#L139-L146">source</a></section></details></article><article><details class="docstring" open="true"><summary id="SparseArraysBase.SparseArrayDOK-Union{Tuple{N}, Tuple{T}, Tuple{BlockArrays.UndefBlocksInitializer, NTuple{N, AbstractUnitRange{&lt;:Integer}}}} where {T, N}"><a class="docstring-binding" href="#SparseArraysBase.SparseArrayDOK-Union{Tuple{N}, Tuple{T}, Tuple{BlockArrays.UndefBlocksInitializer, NTuple{N, AbstractUnitRange{&lt;:Integer}}}} where {T, N}"><code>SparseArraysBase.SparseArrayDOK</code></a> — <span class="docstring-category">Method</span></summary><section><div><pre><code class="language-julia hljs">SparseArrayDOK{T}(undef_blocks, axes)
5-
SparseArrayDOK{T,N}(undef_blocks, axes)</code></pre><p>Construct the block structure of an undefined BlockSparseArray that will have blocked axes <code>axes</code>.</p><p>Note that <code>undef_blocks</code> is defined in <a href="https://juliaarrays.github.io/BlockArrays.jl/stable/lib/public/#BlockArrays.undef_blocks">BlockArrays.jl</a> and should be imported from that package to use it as an input to this constructor.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ITensor/BlockSparseArrays.jl/blob/b89c5686e7fc21ebfbe02951faa1d8bf3084b523/src/blocksparsearray/blocksparsearray.jl#L7-L17">source</a></section></details></article><article><details class="docstring" open="true"><summary id="BlockSparseArrays.sparsemortar-Union{Tuple{N}, Tuple{T}, Tuple{AbstractArray{&lt;:AbstractArray{T, N}, N}, NTuple{N, AbstractUnitRange{&lt;:Integer}}}} where {T, N}"><a class="docstring-binding" href="#BlockSparseArrays.sparsemortar-Union{Tuple{N}, Tuple{T}, Tuple{AbstractArray{&lt;:AbstractArray{T, N}, N}, NTuple{N, AbstractUnitRange{&lt;:Integer}}}} where {T, N}"><code>BlockSparseArrays.sparsemortar</code></a> — <span class="docstring-category">Method</span></summary><section><div><pre><code class="language-julia hljs">sparsemortar(blocks::AbstractArray{&lt;:AbstractArray{T,N},N}, axes) -&gt; ::BlockSparseArray{T,N}</code></pre><p>Construct a block sparse array from a sparse array of arrays and specified blocked axes. The block sizes must be commensurate with the blocks of the axes.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ITensor/BlockSparseArrays.jl/blob/b89c5686e7fc21ebfbe02951faa1d8bf3084b523/src/blocksparsearray/blocksparsearray.jl#L107-L112">source</a></section></details></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</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="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.17.0 on <span class="colophon-date" title="Thursday 2 April 2026 05:43">Thursday 2 April 2026</span>. Using Julia version 1.12.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
5+
SparseArrayDOK{T,N}(undef_blocks, axes)</code></pre><p>Construct the block structure of an undefined BlockSparseArray that will have blocked axes <code>axes</code>.</p><p>Note that <code>undef_blocks</code> is defined in <a href="https://juliaarrays.github.io/BlockArrays.jl/stable/lib/public/#BlockArrays.undef_blocks">BlockArrays.jl</a> and should be imported from that package to use it as an input to this constructor.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ITensor/BlockSparseArrays.jl/blob/b89c5686e7fc21ebfbe02951faa1d8bf3084b523/src/blocksparsearray/blocksparsearray.jl#L7-L17">source</a></section></details></article><article><details class="docstring" open="true"><summary id="BlockSparseArrays.sparsemortar-Union{Tuple{N}, Tuple{T}, Tuple{AbstractArray{&lt;:AbstractArray{T, N}, N}, NTuple{N, AbstractUnitRange{&lt;:Integer}}}} where {T, N}"><a class="docstring-binding" href="#BlockSparseArrays.sparsemortar-Union{Tuple{N}, Tuple{T}, Tuple{AbstractArray{&lt;:AbstractArray{T, N}, N}, NTuple{N, AbstractUnitRange{&lt;:Integer}}}} where {T, N}"><code>BlockSparseArrays.sparsemortar</code></a> — <span class="docstring-category">Method</span></summary><section><div><pre><code class="language-julia hljs">sparsemortar(blocks::AbstractArray{&lt;:AbstractArray{T,N},N}, axes) -&gt; ::BlockSparseArray{T,N}</code></pre><p>Construct a block sparse array from a sparse array of arrays and specified blocked axes. The block sizes must be commensurate with the blocks of the axes.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ITensor/BlockSparseArrays.jl/blob/b89c5686e7fc21ebfbe02951faa1d8bf3084b523/src/blocksparsearray/blocksparsearray.jl#L107-L112">source</a></section></details></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</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="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.17.0 on <span class="colophon-date" title="Thursday 9 April 2026 05:50">Thursday 9 April 2026</span>. Using Julia version 1.12.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

0 commit comments

Comments
 (0)