Skip to content

Commit

Permalink
build based on f3be966
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Dec 9, 2024
1 parent f1f0c47 commit f63bf19
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.11.2","generation_timestamp":"2024-12-09T01:57:11","documenter_version":"1.8.0"}}
{"documenter":{"julia_version":"1.11.2","generation_timestamp":"2024-12-09T02:22:38","documenter_version":"1.8.0"}}
16 changes: 8 additions & 8 deletions dev/blocktensors/index.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/index.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/lib/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>Library · BlockTensorKit.jl</title><meta name="title" content="Library · BlockTensorKit.jl"/><meta property="og:title" content="Library · BlockTensorKit.jl"/><meta property="twitter:title" content="Library · BlockTensorKit.jl"/><meta name="description" content="Documentation for BlockTensorKit.jl."/><meta property="og:description" content="Documentation for BlockTensorKit.jl."/><meta property="twitter:description" content="Documentation for BlockTensorKit.jl."/><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></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../"><img src="../assets/logo.svg" alt="BlockTensorKit.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../">BlockTensorKit.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><span class="tocitem">Manual</span><ul><li><a class="tocitem" href="../sumspaces/">SumSpace</a></li><li><a class="tocitem" href="../blocktensors/">BlockTensors</a></li></ul></li><li class="is-active"><a class="tocitem" href>Library</a><ul class="internal"><li><a class="tocitem" href="#Library-index"><span>Library index</span></a></li></ul></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>Library</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Library</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/lkdvos/BlockTensorKit.jl.git" 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="github.com/lkdvos/BlockTensorKit.jl.git" 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"><h2 id="Library-index"><a class="docs-heading-anchor" href="#Library-index">Library index</a><a id="Library-index-1"></a><a class="docs-heading-anchor-permalink" href="#Library-index" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="BlockTensorKit.AbstractBlockTensorMap" href="#BlockTensorKit.AbstractBlockTensorMap"><code>BlockTensorKit.AbstractBlockTensorMap</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">AbstractBlockTensorMap{E,S,N₁,N₂}</code></pre><p>Abstract supertype for tensor maps that have additional block structure, i.e. they act on vector spaces that have a direct sum structure. These behave like <code>AbstractTensorMap</code> but have additional methods to facilitate indexing and manipulation of the block structure.</p></div><a class="docs-sourcelink" target="_blank" href="github.com/lkdvos/BlockTensorKit.jl.git">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="BlockTensorKit.BlockTensorMap" href="#BlockTensorKit.BlockTensorMap"><code>BlockTensorKit.BlockTensorMap</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">struct BlockTensorMap{TT&lt;:AbstractTensorMap{E,S,N₁,N₂}} &lt;: AbstractTensorMap{E,S,N₁,N₂}</code></pre><p>Dense <code>BlockTensorMap</code> type that stores tensors of type <code>TT</code> in a dense array.</p></div><a class="docs-sourcelink" target="_blank" href="github.com/lkdvos/BlockTensorKit.jl.git">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="BlockTensorKit.SparseBlockTensorMap" href="#BlockTensorKit.SparseBlockTensorMap"><code>BlockTensorKit.SparseBlockTensorMap</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">struct SparseBlockTensorMap{TT&lt;:AbstractTensorMap{E,S,N₁,N₂}} &lt;: AbstractBlockTensorMap{E,S,N₁,N₂}</code></pre><p>Sparse <code>SparseBlockTensorMap</code> type that stores tensors of type <code>TT</code> in a sparse dictionary.</p></div><a class="docs-sourcelink" target="_blank" href="github.com/lkdvos/BlockTensorKit.jl.git">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="BlockTensorKit.SumSpace" href="#BlockTensorKit.SumSpace"><code>BlockTensorKit.SumSpace</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">struct SumSpace{S&lt;:ElementarySpace} &lt;: ElementarySpace</code></pre><p>A (lazy) direct sum of elementary vector spaces of type <code>S</code>.</p></div><a class="docs-sourcelink" target="_blank" href="github.com/lkdvos/BlockTensorKit.jl.git">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="BlockTensorKit.SumSpaceIndices" href="#BlockTensorKit.SumSpaceIndices"><code>BlockTensorKit.SumSpaceIndices</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">struct SumSpaceIndices{S,N₁,N₂} &lt;: AbstractArray{TensorMapSpace{S,N₁,N₂},N₁ + N₂}</code></pre></div><a class="docs-sourcelink" target="_blank" href="github.com/lkdvos/BlockTensorKit.jl.git">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="BlockTensorKit.droptol!" href="#BlockTensorKit.droptol!"><code>BlockTensorKit.droptol!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">droptol!(t::AbstractBlockTensorMap, tol=eps(real(scalartype(t)))^(3/4))</code></pre><p>Remove the tensor entries of a blocktensor that have norm <code>≤(tol)</code>.</p></div><a class="docs-sourcelink" target="_blank" href="github.com/lkdvos/BlockTensorKit.jl.git">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="BlockTensorKit.dropzeros!-Tuple{AbstractBlockTensorMap}" href="#BlockTensorKit.dropzeros!-Tuple{AbstractBlockTensorMap}"><code>BlockTensorKit.dropzeros!</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">dropzeros!(t::AbstractBlockTensorMap)</code></pre><p>Remove the tensor entries of a blocktensor that have norm 0. Only applicable to sparse blocktensors.</p></div><a class="docs-sourcelink" target="_blank" href="github.com/lkdvos/BlockTensorKit.jl.git">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="BlockTensorKit.eachspace-Tuple{TensorKit.HomSpace{SumSpace{S}, TensorKit.ProductSpace{SumSpace{S}, N₁}, TensorKit.ProductSpace{SumSpace{S}, N₂}} where {S, N₁, N₂}}" href="#BlockTensorKit.eachspace-Tuple{TensorKit.HomSpace{SumSpace{S}, TensorKit.ProductSpace{SumSpace{S}, N₁}, TensorKit.ProductSpace{SumSpace{S}, N₂}} where {S, N₁, N₂}}"><code>BlockTensorKit.eachspace</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">eachspace(V::TensorMapSumSpace) -&gt; SumSpaceIndices</code></pre><p>Return an object that can be used to obtain the subspaces of a <code>BlockTensorMap</code>.</p></div><a class="docs-sourcelink" target="_blank" href="github.com/lkdvos/BlockTensorKit.jl.git">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="BlockTensorKit.sprand-Tuple{TensorKit.HomSpace{SumSpace{S}, TensorKit.ProductSpace{SumSpace{S}, N₁}, TensorKit.ProductSpace{SumSpace{S}, N₂}} where {S, N₁, N₂}, Real}" href="#BlockTensorKit.sprand-Tuple{TensorKit.HomSpace{SumSpace{S}, TensorKit.ProductSpace{SumSpace{S}, N₁}, TensorKit.ProductSpace{SumSpace{S}, N₂}} where {S, N₁, N₂}, Real}"><code>BlockTensorKit.sprand</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">sprand([rng], T::Type, W::TensorMapSumSpace, p::Real)</code></pre><p>Construct a sparse blocktensor with entries compatible with type <code>T</code> and space <code>W</code>. Each entry is nonzero with probability <code>p</code>.</p></div><a class="docs-sourcelink" target="_blank" href="github.com/lkdvos/BlockTensorKit.jl.git">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="BlockTensorKit.spzeros-Tuple{TensorKit.HomSpace{SumSpace{S}, TensorKit.ProductSpace{SumSpace{S}, N₁}, TensorKit.ProductSpace{SumSpace{S}, N₂}} where {S, N₁, N₂}, Vararg{Any}}" href="#BlockTensorKit.spzeros-Tuple{TensorKit.HomSpace{SumSpace{S}, TensorKit.ProductSpace{SumSpace{S}, N₁}, TensorKit.ProductSpace{SumSpace{S}, N₂}} where {S, N₁, N₂}, Vararg{Any}}"><code>BlockTensorKit.spzeros</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">spzeros(T::Type, W::TensorMapSumSpace)
spzeros(T, W, nonzero_inds)</code></pre><p>Construct a sparse blocktensor with entries compatible with type <code>T</code> and space <code>W</code>. By default, the tensor will be empty, but nonzero entries can be specified by passing a tuple of indices <code>nonzero_inds</code>.</p></div><a class="docs-sourcelink" target="_blank" href="github.com/lkdvos/BlockTensorKit.jl.git">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="BlockTensorKit.sumspacetype-Union{Tuple{Type{S}}, Tuple{S}} where S&lt;:TensorKit.ElementarySpace" href="#BlockTensorKit.sumspacetype-Union{Tuple{Type{S}}, Tuple{S}} where S&lt;:TensorKit.ElementarySpace"><code>BlockTensorKit.sumspacetype</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">sumspacetype(::Union{S,Type{S}}) where {S&lt;:ElementarySpace}</code></pre><p>Return the type of a <code>SumSpace</code> with elements of type <code>S</code>.</p></div><a class="docs-sourcelink" target="_blank" href="github.com/lkdvos/BlockTensorKit.jl.git">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../blocktensors/">« BlockTensors</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.8.0 on <span class="colophon-date" title="Monday 9 December 2024 01:57">Monday 9 December 2024</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
spzeros(T, W, nonzero_inds)</code></pre><p>Construct a sparse blocktensor with entries compatible with type <code>T</code> and space <code>W</code>. By default, the tensor will be empty, but nonzero entries can be specified by passing a tuple of indices <code>nonzero_inds</code>.</p></div><a class="docs-sourcelink" target="_blank" href="github.com/lkdvos/BlockTensorKit.jl.git">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="BlockTensorKit.sumspacetype-Union{Tuple{Type{S}}, Tuple{S}} where S&lt;:TensorKit.ElementarySpace" href="#BlockTensorKit.sumspacetype-Union{Tuple{Type{S}}, Tuple{S}} where S&lt;:TensorKit.ElementarySpace"><code>BlockTensorKit.sumspacetype</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">sumspacetype(::Union{S,Type{S}}) where {S&lt;:ElementarySpace}</code></pre><p>Return the type of a <code>SumSpace</code> with elements of type <code>S</code>.</p></div><a class="docs-sourcelink" target="_blank" href="github.com/lkdvos/BlockTensorKit.jl.git">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../blocktensors/">« BlockTensors</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.8.0 on <span class="colophon-date" title="Monday 9 December 2024 02:22">Monday 9 December 2024</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Binary file modified dev/objects.inv
View file
Binary file not shown.
Loading

0 comments on commit f63bf19

Please sign in to comment.