-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Documenter.jl
committed
Dec 3, 2023
1 parent
18eda21
commit 22af6ed
Showing
3 changed files
with
9 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| {"documenter":{"julia_version":"1.9.4","generation_timestamp":"2023-12-03T06:11:41","documenter_version":"1.2.1"}} | ||
| {"documenter":{"julia_version":"1.9.4","generation_timestamp":"2023-12-03T06:33:29","documenter_version":"1.2.1"}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,10 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · CUDSS.jl</title><meta name="title" content="Home · CUDSS.jl"/><meta property="og:title" content="Home · CUDSS.jl"/><meta property="twitter:title" content="Home · CUDSS.jl"/><meta name="description" content="Documentation for CUDSS.jl."/><meta property="og:description" content="Documentation for CUDSS.jl."/><meta property="twitter:description" content="Documentation for CUDSS.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/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>CUDSS.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 class="is-active"><a class="tocitem" href>Home</a><ul class="internal"><li><a class="tocitem" href="#Installation"><span>Installation</span></a></li><li><a class="tocitem" href="#CUDSS"><span>CUDSS</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>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-navbar-link" href="https://github.com/exanauts/CUDSS.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/exanauts/CUDSS.jl/blob/main/docs/src/index.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="Home"><a class="docs-heading-anchor" href="#Home">CUDSS.jl documentation</a><a id="Home-1"></a><a class="docs-heading-anchor-permalink" href="#Home" title="Permalink"></a></h1><h2 id="Installation"><a class="docs-heading-anchor" href="#Installation">Installation</a><a id="Installation-1"></a><a class="docs-heading-anchor-permalink" href="#Installation" title="Permalink"></a></h2><pre><code class="language-julia hljs">julia> ] | ||
| pkg> add https://github.com/exanauts/CUDSS.jl.git | ||
| pkg> test CUDSS</code></pre><h2 id="CUDSS"><a class="docs-heading-anchor" href="#CUDSS">CUDSS</a><a id="CUDSS-1"></a><a class="docs-heading-anchor-permalink" href="#CUDSS" 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="CUDSS.cudss_set" href="#CUDSS.cudss_set"><code>CUDSS.cudss_set</code></a> — <span class="docstring-category">Function</span></header><section><div><p>cudss<em>set(matrix::CudssMatrix, A::CuVector) cudss</em>set(matrix::CudssMatrix, A::CuMatrix) cudss_set(matrix::CudssMatrix, A::CuSparseMatrixCSR)</p><p>cudss_set(config::CudssConfig, param::String, value)</p><p>The available config parameters are: "reordering<em>alg" "factorization</em>alg" "solve<em>alg" "matching</em>type" "solve<em>mode" "ir</em>n<em>steps" "ir</em>tol" "pivot<em>type" "pivot</em>threshold" "pivot<em>epsilon" "max</em>lu_nnz"</p><p>cudss_set(data::CudssData, param::String, value)</p><p>The available data parameters are: "info" "lu<em>nnz" "npivots" "inertia" "perm</em>reorder" "perm<em>row" "perm</em>col" "diag" "user_perm"</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/exanauts/CUDSS.jl/blob/a683aec1c3475e88e69f77aa522f282f9f45bd9b/src/interfaces.jl#L20-L52">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="CUDSS.cudss_get" href="#CUDSS.cudss_get"><code>CUDSS.cudss_get</code></a> — <span class="docstring-category">Function</span></header><section><div><p>value = cudss_get(config::CudssConfig, param::String)</p><p>The available config parameters are: "reordering<em>alg" "factorization</em>alg" "solve<em>alg" "matching</em>type" "solve<em>mode" "ir</em>n<em>steps" "ir</em>tol" "pivot<em>type" "pivot</em>threshold" "pivot<em>epsilon" "max</em>lu_nnz"</p><p>value = cudss_get(data::CudssData, param::String)</p><p>The available data parameters are: "info" "lu<em>nnz" "npivots" "inertia" "perm</em>reorder" "perm<em>row" "perm</em>col" "diag" "user_perm"</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/exanauts/CUDSS.jl/blob/a683aec1c3475e88e69f77aa522f282f9f45bd9b/src/interfaces.jl#L81-L109">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="CUDSS.cudss" href="#CUDSS.cudss"><code>CUDSS.cudss</code></a> — <span class="docstring-category">Function</span></header><section><div><p>cudss(phase::String, solver::CudssSolver, x::CuVector, b::CuVector) cudss(phase::String, solver::CudssSolver, X::CuMatrix, B::CuMatrix) cudss(phase::String, solver::CudssSolver, X::CudssMatrix, B::CudssMatrix)</p><p>The available phases are "analysis", "factorization", "refactorization" and "solve". The phases "solve<em>fwd", "solve</em>diag" and "solve_bwd" are available but not yet functional.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/exanauts/CUDSS.jl/blob/a683aec1c3475e88e69f77aa522f282f9f45bd9b/src/interfaces.jl#L130-L137">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><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Sunday 3 December 2023 06:11">Sunday 3 December 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> | ||
| pkg> test CUDSS</code></pre><h2 id="CUDSS"><a class="docs-heading-anchor" href="#CUDSS">CUDSS</a><a id="CUDSS-1"></a><a class="docs-heading-anchor-permalink" href="#CUDSS" 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="CUDSS.cudss_set" href="#CUDSS.cudss_set"><code>CUDSS.cudss_set</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">cudss_set(matrix::CudssMatrix, A::CuVector) | ||
| cudss_set(matrix::CudssMatrix, A::CuMatrix) | ||
| cudss_set(matrix::CudssMatrix, A::CuSparseMatrixCSR) | ||
|
|
||
| cudss_set(config::CudssConfig, param::String, value)</code></pre><p>The available config parameters are: "reordering<em>alg" "factorization</em>alg" "solve<em>alg" "matching</em>type" "solve<em>mode" "ir</em>n<em>steps" "ir</em>tol" "pivot<em>type" "pivot</em>threshold" "pivot<em>epsilon" "max</em>lu_nnz"</p><pre><code class="nohighlight hljs">cudss_set(data::CudssData, param::String, value)</code></pre><p>The available data parameters are: "info" "lu<em>nnz" "npivots" "inertia" "perm</em>reorder" "perm<em>row" "perm</em>col" "diag" "user_perm"</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/exanauts/CUDSS.jl/blob/bdd7c9598fed44525691a2fe9234bff3ee14249a/src/interfaces.jl#L20-L52">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="CUDSS.cudss_get" href="#CUDSS.cudss_get"><code>CUDSS.cudss_get</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">value = cudss_get(config::CudssConfig, param::String)</code></pre><p>The available config parameters are: "reordering<em>alg" "factorization</em>alg" "solve<em>alg" "matching</em>type" "solve<em>mode" "ir</em>n<em>steps" "ir</em>tol" "pivot<em>type" "pivot</em>threshold" "pivot<em>epsilon" "max</em>lu_nnz"</p><pre><code class="nohighlight hljs">value = cudss_get(data::CudssData, param::String)</code></pre><p>The available data parameters are: "info" "lu<em>nnz" "npivots" "inertia" "perm</em>reorder" "perm<em>row" "perm</em>col" "diag" "user_perm"</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/exanauts/CUDSS.jl/blob/bdd7c9598fed44525691a2fe9234bff3ee14249a/src/interfaces.jl#L81-L109">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="CUDSS.cudss" href="#CUDSS.cudss"><code>CUDSS.cudss</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">cudss(phase::String, solver::CudssSolver, x::CuVector, b::CuVector) | ||
| cudss(phase::String, solver::CudssSolver, X::CuMatrix, B::CuMatrix) | ||
| cudss(phase::String, solver::CudssSolver, X::CudssMatrix, B::CudssMatrix)</code></pre><p>The available phases are "analysis", "factorization", "refactorization" and "solve". The phases "solve<em>fwd", "solve</em>diag" and "solve_bwd" are available but not yet functional.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/exanauts/CUDSS.jl/blob/bdd7c9598fed44525691a2fe9234bff3ee14249a/src/interfaces.jl#L130-L137">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><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Sunday 3 December 2023 06:33">Sunday 3 December 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.