Skip to content

Commit

Permalink
update documenter
Browse files Browse the repository at this point in the history
  • Loading branch information
bud-primordium committed Oct 11, 2024
1 parent 63b82d5 commit ba1b37c
Show file tree
Hide file tree
Showing 7 changed files with 99 additions and 6 deletions.
Binary file added .utils/test.pdf
Binary file not shown.
93 changes: 93 additions & 0 deletions .utils/test.tex
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
\documentclass[11pt]{article}


% 页面设置
\usepackage[top=1cm, bottom=2cm, left=1cm, right=1cm]{geometry}

% 中文支持
\usepackage{ctex}

% 数学包
\usepackage{amsmath, amssymb, amsthm}

% 算法包
\usepackage[linesnumbered, ruled]{algorithm2e}

\begin{document}

\title{伪代码test}
\author{test}
\maketitle

\begin{algorithm}[H]
\caption{Main Routine for Gaussian Elimination Solver}
\label{alg:main_routine}
\KwIn{Input File Path (string), \texttt{tol} (long double), \texttt{max\_iter} (int)}
\KwOut{Solutions (array)}

\While{True}{
\texttt{selected\_file} $\gets$ \textit{SelectInputFile}() \tcp*[r]{Select the input file}
\If{\texttt{selected\_file} is empty}{
\textbf{exit} \tcp*[r]{Exit if no file is selected}
}

\texttt{start\_time} $\gets$ \textit{StartTimer}() \tcp*[r]{Start the timer}

\textit{InitMatrix}(\texttt{matrix}, \texttt{selected\_file}, \texttt{rows}, \texttt{cols}) \tcp*[r]{Initialize the matrix}
\textit{ShowEquations}(\texttt{matrix}, \texttt{rows}, \texttt{cols}) \tcp*[r]{Display the system of equations}

\texttt{exchange\_count} $\gets$ \textit{GaussianElimination}(\texttt{matrix}, \texttt{rows}, \texttt{cols}) \tcp*[r]{Perform Gaussian elimination}

\texttt{rank} $\gets$ \textit{DetermineRank}(\texttt{matrix}, \texttt{rows}, \texttt{cols}) \tcp*[r]{Determine the rank of the matrix}
\texttt{consistent} $\gets$ \textit{CheckConsistency}(\texttt{matrix}, \texttt{rows}, \texttt{cols}) \tcp*[r]{Check if the system is consistent}

\If{not \texttt{consistent}}{
\textit{DisplaySolution}("No solution") \tcp*[r]{Display no solution message}
}
\ElseIf{\texttt{rank} $<$ (\texttt{cols} $-$ 1)}{
\textit{ShowGeneralSolution}(\texttt{matrix}, \texttt{rows}, \texttt{cols}, \texttt{rank}) \tcp*[r]{Display parameterized solution}
}
\Else{
\texttt{solution} $\gets$ \textit{BackSubstitution}(\texttt{matrix}, \texttt{rows}, \texttt{cols}, \texttt{solution}) \tcp*[r]{Perform back substitution}
\If{\texttt{solvable}}{
\textit{DisplaySolution}(\texttt{solution}) \tcp*[r]{Display the unique solution}
}
\Else{
\textit{DisplaySolution}("No solution") \tcp*[r]{Display no solution if back substitution fails}
}
}

\textit{StopTimer}(\texttt{start\_time}) \tcp*[r]{Stop the timer}
\texttt{choice} $\gets$ \textit{AskRunAgain}() \tcp*[r]{Ask if the user wants to run again}
\If{\texttt{choice} $\neq$ 'y' \textbf{and} \texttt{choice} $\neq$ 'Y'}{
\textbf{break} \tcp*[r]{Exit loop if the choice is not 'y' or 'Y'}
}
}

\textit{WaitForExit}() \tcp*[r]{Wait for program exit}
\end{algorithm}



\begin{algorithm}[H]
\caption{Pivoting to Select the Maximum Element in a Column}
\label{alg:pivoting}
\KwIn{$\texttt{matrix}$ (Matrix), $\texttt{current\_row}$ (int), $\texttt{total\_rows}$ (int)}
\KwOut{$\texttt{imax}$ (int)}

\texttt{imax} $\gets$ \texttt{current\_row}\;
\texttt{max\_val} $\gets$ $|\texttt{matrix}[\texttt{current\_row}][\texttt{current\_row}]|$\;
\For{$i \gets \texttt{current\_row} + 1$ \textbf{to} $\texttt{total\_rows} - 1$}{
\texttt{val} $\gets$ $|\texttt{matrix}[i][\texttt{current\_row}]|$\;
\If{\texttt{val} $>$ \texttt{max\_val}}{
\texttt{imax} $\gets$ $i$\;
\texttt{max\_val} $\gets$ \texttt{val}\;
}
}
\Return \texttt{imax}\;
\end{algorithm}




\end{document}
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-10-09T13:20:21","documenter_version":"1.7.0"}}
{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-10-11T16:23:08","documenter_version":"1.7.0"}}
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · SchrödingerSolver Documentation</title><meta name="title" content="Home · SchrödingerSolver Documentation"/><meta property="og:title" content="Home · SchrödingerSolver Documentation"/><meta property="twitter:title" content="Home · SchrödingerSolver Documentation"/><meta name="description" content="Documentation for SchrödingerSolver Documentation."/><meta property="og:description" content="Documentation for SchrödingerSolver Documentation."/><meta property="twitter:description" content="Documentation for SchrödingerSolver Documentation."/><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"><div class="docs-package-name"><span class="docs-autofit"><a href="index.html">SchrödingerSolver Documentation</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="index.html">Home</a></li><li><a class="tocitem" href="methods.html">Methods</a></li><li><a class="tocitem" href="utils.html">Utils</a></li><li><a class="tocitem" href="interaction.html">Interaction</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="index.html">Home</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href="index.html">Home</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/bud-primordium/Fundamentals-of-Computational-Physics--Fall-2024" 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/bud-primordium/Fundamentals-of-Computational-Physics--Fall-2024/blob/main/Assignment_3/Problem_3/src/Documenter_output/Documenter_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="SchrödingerSolver-Documentation"><a class="docs-heading-anchor" href="#SchrödingerSolver-Documentation">SchrödingerSolver Documentation</a><a id="SchrödingerSolver-Documentation-1"></a><a class="docs-heading-anchor-permalink" href="#SchrödingerSolver-Documentation" title="Permalink"></a></h1><p>Welcome to the SchrödingerSolver documentation! This module provides utilities to solve the 1D Schrödinger equation using Gaussian basis functions.</p><ul><li><a href="methods.html#Methods-Module">Methods Module</a></li><li><a href="utils.html#Utils-Module">Utils Module</a></li><li><a href="interaction.html#Interaction-Module">Interaction Module</a></li></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="methods.html">Methods »</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.7.0 on <span class="colophon-date" title="Wednesday 9 October 2024 13:20">Wednesday 9 October 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · SchrödingerSolver Documentation</title><meta name="title" content="Home · SchrödingerSolver Documentation"/><meta property="og:title" content="Home · SchrödingerSolver Documentation"/><meta property="twitter:title" content="Home · SchrödingerSolver Documentation"/><meta name="description" content="Documentation for SchrödingerSolver Documentation."/><meta property="og:description" content="Documentation for SchrödingerSolver Documentation."/><meta property="twitter:description" content="Documentation for SchrödingerSolver Documentation."/><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"><div class="docs-package-name"><span class="docs-autofit"><a href="index.html">SchrödingerSolver Documentation</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="index.html">Home</a></li><li><a class="tocitem" href="methods.html">Methods</a></li><li><a class="tocitem" href="utils.html">Utils</a></li><li><a class="tocitem" href="interaction.html">Interaction</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="index.html">Home</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href="index.html">Home</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/bud-primordium/Fundamentals-of-Computational-Physics--Fall-2024" 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/bud-primordium/Fundamentals-of-Computational-Physics--Fall-2024/blob/main/Assignment_3/Problem_3/src/documenter_output/documenter_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="SchrödingerSolver-Documentation"><a class="docs-heading-anchor" href="#SchrödingerSolver-Documentation">SchrödingerSolver Documentation</a><a id="SchrödingerSolver-Documentation-1"></a><a class="docs-heading-anchor-permalink" href="#SchrödingerSolver-Documentation" title="Permalink"></a></h1><p>Welcome to the SchrödingerSolver documentation! This module provides utilities to solve the 1D Schrödinger equation using Gaussian basis functions.</p><ul><li><a href="methods.html#Methods-Module">Methods Module</a></li><li><a href="utils.html#Utils-Module">Utils Module</a></li><li><a href="interaction.html#Interaction-Module">Interaction Module</a></li></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="methods.html">Methods »</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.7.0 on <span class="colophon-date" title="Friday 11 October 2024 16:23">Friday 11 October 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit ba1b37c

Please sign in to comment.