-MatrixAlgebraKit.select_algorithm(f, A, (; kwargs...))</code></pre><p>Decide on an algorithm to use for implementing the function <code>f</code> on inputs of type <code>A</code>. This can be obtained both for values <code>A</code> or types <code>A</code>.</p><p>If <code>alg</code> is an <code>AbstractAlgorithm</code> instance, it will be returned as-is.</p><p>If <code>alg</code> is a <code>Symbol</code> or a <code>Type</code> of algorithm, the return value is obtained by calling the corresponding algorithm constructor; keyword arguments in <code>kwargs</code> are passed along to this constructor.</p><p>If <code>alg</code> is not specified (or <code>nothing</code>), an algorithm will be selected automatically with <a href="../library/#MatrixAlgebraKit.default_algorithm"><code>MatrixAlgebraKit.default_algorithm</code></a> and the keyword arguments in <code>kwargs</code> will be passed to the algorithm constructor. Finally, the same behavior is obtained when the keyword arguments are passed as the third positional argument in the form of a <code>NamedTuple</code>. </p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/QuantumKitHub/MatrixAlgebraKit.jl/blob/4863bc9b1bbdef48c0544767bf0cee8c3cfb3f98/src/algorithms.jl#L68-L89">source</a></section></details></article><article><details class="docstring"><summary id="MatrixAlgebraKit.findtruncated-dev_interface"><a class="docstring-binding" href="#MatrixAlgebraKit.findtruncated-dev_interface"><code>MatrixAlgebraKit.findtruncated</code></a> — <span class="docstring-category">Function</span></summary><section><div><pre><code class="language-julia hljs">MatrixAlgebraKit.findtruncated(values::AbstractVector, strategy::TruncationStrategy)</code></pre><p>Generic interface for finding truncated values of the spectrum of a decomposition based on the <code>strategy</code>. The output should be a collection of indices specifying which values to keep. <code>MatrixAlgebraKit.findtruncated</code> is used inside of the default implementation of <a href="../library/#MatrixAlgebraKit.truncate"><code>truncate</code></a> to perform the truncation. It does not assume that the values are sorted. For a version that assumes the values are reverse sorted (which is the standard case for SVD) see <a href="../library/#MatrixAlgebraKit.findtruncated_svd"><code>MatrixAlgebraKit.findtruncated_svd</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/QuantumKitHub/MatrixAlgebraKit.jl/blob/4863bc9b1bbdef48c0544767bf0cee8c3cfb3f98/src/algorithms.jl#L193-L202">source</a></section></details></article><article><details class="docstring"><summary id="MatrixAlgebraKit.findtruncated_svd-dev_interface"><a class="docstring-binding" href="#MatrixAlgebraKit.findtruncated_svd-dev_interface"><code>MatrixAlgebraKit.findtruncated_svd</code></a> — <span class="docstring-category">Function</span></summary><section><div><pre><code class="language-julia hljs">MatrixAlgebraKit.findtruncated_svd(values::AbstractVector, strategy::TruncationStrategy)</code></pre><p>Like <a href="../library/#MatrixAlgebraKit.findtruncated"><code>MatrixAlgebraKit.findtruncated</code></a> but assumes that the values are real and sorted in descending order, as typically obtained by the SVD. This assumption is not checked, and this is used in the default implementation of <a href="../library/#MatrixAlgebraKit.svd_trunc!"><code>svd_trunc!</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/QuantumKitHub/MatrixAlgebraKit.jl/blob/4863bc9b1bbdef48c0544767bf0cee8c3cfb3f98/src/algorithms.jl#L204-L210">source</a></section></details></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../user_interface/matrix_functions/">« Matrix functions</a><a class="docs-footer-nextpage" href="../library/">Library »</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.16.1 on <span class="colophon-date" title="Wednesday 21 January 2026 06:16">Wednesday 21 January 2026</span>. Using Julia version 1.12.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body><div data-docstringscollapsed="true"></div></html>
0 commit comments