Skip to content

Commit

Permalink
Deploy docs to develop by GitHub Actions triggered by 307119c
Browse files Browse the repository at this point in the history
  • Loading branch information
PHYSBO Developers committed Mar 11, 2024
1 parent 013654e commit 7b405a4
Show file tree
Hide file tree
Showing 219 changed files with 6,137 additions and 3,493 deletions.
2 changes: 1 addition & 1 deletion manual/develop/en/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: e015b6dc9bfc7443fb19c91af7441403
config: 3acbb30cac794629572a38a5d72c4acc
tags: 645f666f9bcd5a90fca523b33c5a78b7
20 changes: 12 additions & 8 deletions manual/develop/en/_modules/index.html
Original file line number Diff line number Diff line change
@@ -1,18 +1,22 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<html class="writer-html5" lang="en" data-content_root="../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Overview: module code &mdash; PHYSBO 1.2-dev documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<title>Overview: module code &mdash; PHYSBO 1.1.1 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />


<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->

<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.js"></script>
<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=58fbf978"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
Expand All @@ -31,7 +35,7 @@
PHYSBO
</a>
<div class="version">
1.2
1.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down
40 changes: 28 additions & 12 deletions manual/develop/en/_modules/physbo/blm/basis/fourier.html
Original file line number Diff line number Diff line change
@@ -1,18 +1,22 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<html class="writer-html5" lang="en" data-content_root="../../../../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>physbo.blm.basis.fourier &mdash; PHYSBO 1.2-dev documentation</title>
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
<title>physbo.blm.basis.fourier &mdash; PHYSBO 1.1.1 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css?v=19f00094" />


<!--[if lt IE 9]>
<script src="../../../../_static/js/html5shiv.min.js"></script>
<![endif]-->

<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
<script src="../../../../_static/doctools.js"></script>
<script src="../../../../_static/sphinx_highlight.js"></script>
<script src="../../../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../../../_static/documentation_options.js?v=58fbf978"></script>
<script src="../../../../_static/doctools.js?v=888ff710"></script>
<script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
<script src="../../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../../genindex.html" />
Expand All @@ -31,7 +35,7 @@
PHYSBO
</a>
<div class="version">
1.2
1.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
Expand Down Expand Up @@ -81,7 +85,9 @@ <h1>Source code for physbo.blm.basis.fourier</h1><div class="highlight"><pre>
<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>


<div class="viewcode-block" id="fourier"><a class="viewcode-back" href="../../../../api/physbo.blm.basis.fourier.html#physbo.blm.basis.fourier.fourier">[docs]</a><span class="k">class</span> <span class="nc">fourier</span><span class="p">:</span>
<div class="viewcode-block" id="fourier">
<a class="viewcode-back" href="../../../../api/physbo.blm.basis.fourier.html#physbo.blm.basis.fourier.fourier">[docs]</a>
<span class="k">class</span> <span class="nc">fourier</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> random feature maps</span>
<span class="sd"> ``Psi(X; W,b) = cos[X * Wt + b] * alpha``</span>
Expand Down Expand Up @@ -124,7 +130,9 @@ <h1>Source code for physbo.blm.basis.fourier</h1><div class="highlight"><pre>
<span class="bp">self</span><span class="o">.</span><span class="n">params</span> <span class="o">=</span> <span class="n">params</span>
<span class="bp">self</span><span class="o">.</span><span class="n">nbasis</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>

<div class="viewcode-block" id="fourier.get_basis"><a class="viewcode-back" href="../../../../api/physbo.blm.basis.fourier.html#physbo.blm.basis.fourier.fourier.get_basis">[docs]</a> <span class="k">def</span> <span class="nf">get_basis</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">X</span><span class="p">,</span> <span class="n">params</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<div class="viewcode-block" id="fourier.get_basis">
<a class="viewcode-back" href="../../../../api/physbo.blm.basis.fourier.html#physbo.blm.basis.fourier.fourier.get_basis">[docs]</a>
<span class="k">def</span> <span class="nf">get_basis</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">X</span><span class="p">,</span> <span class="n">params</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> compute the value of basis</span>

Expand Down Expand Up @@ -153,7 +161,10 @@ <h1>Source code for physbo.blm.basis.fourier</h1><div class="highlight"><pre>

<span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">cos</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">dot</span><span class="p">(</span><span class="n">X</span><span class="p">,</span> <span class="n">params</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">transpose</span><span class="p">())</span> <span class="o">+</span> <span class="n">params</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span> <span class="o">*</span> <span class="n">params</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span></div>

<div class="viewcode-block" id="fourier.set_params"><a class="viewcode-back" href="../../../../api/physbo.blm.basis.fourier.html#physbo.blm.basis.fourier.fourier.set_params">[docs]</a> <span class="k">def</span> <span class="nf">set_params</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span>

<div class="viewcode-block" id="fourier.set_params">
<a class="viewcode-back" href="../../../../api/physbo.blm.basis.fourier.html#physbo.blm.basis.fourier.fourier.set_params">[docs]</a>
<span class="k">def</span> <span class="nf">set_params</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> update basis parameters</span>

Expand All @@ -167,14 +178,18 @@ <h1>Source code for physbo.blm.basis.fourier</h1><div class="highlight"><pre>
<span class="bp">self</span><span class="o">.</span><span class="n">_check_len_params</span><span class="p">(</span><span class="n">params</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">params</span> <span class="o">=</span> <span class="n">params</span></div>

<div class="viewcode-block" id="fourier.show"><a class="viewcode-back" href="../../../../api/physbo.blm.basis.fourier.html#physbo.blm.basis.fourier.fourier.show">[docs]</a> <span class="k">def</span> <span class="nf">show</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>

<div class="viewcode-block" id="fourier.show">
<a class="viewcode-back" href="../../../../api/physbo.blm.basis.fourier.html#physbo.blm.basis.fourier.fourier.show">[docs]</a>
<span class="k">def</span> <span class="nf">show</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> print parameters</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">&quot;W = &quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">&quot;b = &quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">&quot;alpha = &quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="mi">2</span><span class="p">])</span></div>


<span class="k">def</span> <span class="nf">_check_params</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Parameters</span>
Expand Down Expand Up @@ -218,6 +233,7 @@ <h1>Source code for physbo.blm.basis.fourier</h1><div class="highlight"><pre>
<span class="k">else</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="mi">2</span><span class="p">],</span> <span class="nb">str</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;The third entry of &lt;params&gt; must be a scalar.&quot;</span><span class="p">)</span></div>

</pre></div>

</div>
Expand Down
Loading

0 comments on commit 7b405a4

Please sign in to comment.