Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Dec 21, 2023
1 parent d28c315 commit 9a35e16
Show file tree
Hide file tree
Showing 4 changed files with 3 additions and 3 deletions.
Binary file modified nightly/.doctrees/environment.pickle
Binary file not shown.
Binary file modified nightly/.doctrees/optimisation.doctree
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -261,9 +261,9 @@ <h1>Source code for cil.optimisation.operators.DiagonalOperator</h1><div class="

<div class="viewcode-block" id="DiagonalOperator.adjoint"><a class="viewcode-back" href="../../../../optimisation.html#cil.optimisation.operators.DiagonalOperator.adjoint">[docs]</a> <span class="k">def</span> <span class="nf">adjoint</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">out</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>

<span class="s2">&quot;Returns :math:`D\circ x` &quot;</span>
<span class="s2">&quot;Returns :math:`D^*\circ x` &quot;</span>

<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">direct</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">out</span><span class="o">=</span><span class="n">out</span><span class="p">)</span></div>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">diagonal</span><span class="o">.</span><span class="n">conjugate</span><span class="p">()</span><span class="o">.</span><span class="n">multiply</span><span class="p">(</span><span class="n">x</span><span class="p">,</span><span class="n">out</span><span class="o">=</span><span class="n">out</span><span class="p">)</span></div>


<div class="viewcode-block" id="DiagonalOperator.calculate_norm"><a class="viewcode-back" href="../../../../optimisation.html#cil.optimisation.operators.DiagonalOperator.calculate_norm">[docs]</a> <span class="k">def</span> <span class="nf">calculate_norm</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
Expand Down
2 changes: 1 addition & 1 deletion nightly/optimisation.html
Original file line number Diff line number Diff line change
Expand Up @@ -2797,7 +2797,7 @@ <h3>Operator base classes<a class="headerlink" href="#operator-base-classes" tit
<dl class="py method">
<dt id="cil.optimisation.operators.DiagonalOperator.adjoint">
<code class="sig-name descname"><span class="pre">adjoint</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">out</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cil/optimisation/operators/DiagonalOperator.html#DiagonalOperator.adjoint"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cil.optimisation.operators.DiagonalOperator.adjoint" title="Permalink to this definition">#</a></dt>
<dd><p>Returns <span class="math notranslate nohighlight">\(D\circ x\)</span></p>
<dd><p>Returns <span class="math notranslate nohighlight">\(D^*\circ x\)</span></p>
</dd></dl>

<dl class="py method">
Expand Down

0 comments on commit 9a35e16

Please sign in to comment.