Skip to content

Commit 150e73a

Browse files
committed
Finished documenting operators module
1 parent 86d0086 commit 150e73a

19 files changed

+838
-620
lines changed
-53 KB
Binary file not shown.

docs/build/doctrees/src.doctree

8.39 KB
Binary file not shown.

docs/build/html/genindex.html

Lines changed: 133 additions & 132 deletions
Large diffs are not rendered by default.

docs/build/html/objects.inv

77 Bytes
Binary file not shown.

docs/build/html/py-modindex.html

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -49,52 +49,57 @@ <h1>Python Module Index</h1>
4949
<td><img src="_static/minus.png" class="toggler"
5050
id="toggle-1" style="display: none" alt="-" /></td>
5151
<td>
52-
<a href="src.html#module-src"><code class="xref">src</code></a></td><td>
52+
<a href="autoapi/src/index.html#module-src"><code class="xref">src</code></a></td><td>
5353
<em></em></td></tr>
5454
<tr class="cg-1">
5555
<td></td>
5656
<td>&#160;&#160;&#160;
57-
<a href="src.html#module-src.checker"><code class="xref">src.checker</code></a></td><td>
57+
<a href="autoapi/src/checker/index.html#module-src.checker"><code class="xref">src.checker</code></a></td><td>
5858
<em></em></td></tr>
5959
<tr class="cg-1">
6060
<td></td>
6161
<td>&#160;&#160;&#160;
62-
<a href="src.html#module-src.classes"><code class="xref">src.classes</code></a></td><td>
62+
<a href="autoapi/src/classes/index.html#module-src.classes"><code class="xref">src.classes</code></a></td><td>
6363
<em></em></td></tr>
6464
<tr class="cg-1">
6565
<td></td>
6666
<td>&#160;&#160;&#160;
67-
<a href="src.html#module-src.config"><code class="xref">src.config</code></a></td><td>
67+
<a href="autoapi/src/config/index.html#module-src.config"><code class="xref">src.config</code></a></td><td>
6868
<em></em></td></tr>
6969
<tr class="cg-1">
7070
<td></td>
7171
<td>&#160;&#160;&#160;
72-
<a href="src.html#module-src.DGCG"><code class="xref">src.DGCG</code></a></td><td>
72+
<a href="autoapi/src/DGCG/index.html#module-src.DGCG"><code class="xref">src.DGCG</code></a></td><td>
7373
<em></em></td></tr>
7474
<tr class="cg-1">
7575
<td></td>
7676
<td>&#160;&#160;&#160;
77-
<a href="src.html#module-src.insertion_mod"><code class="xref">src.insertion_mod</code></a></td><td>
77+
<a href="autoapi/src/insertion_mod/index.html#module-src.insertion_mod"><code class="xref">src.insertion_mod</code></a></td><td>
7878
<em></em></td></tr>
7979
<tr class="cg-1">
8080
<td></td>
8181
<td>&#160;&#160;&#160;
82-
<a href="src.html#module-src.insertion_step"><code class="xref">src.insertion_step</code></a></td><td>
82+
<a href="autoapi/src/insertion_step/index.html#module-src.insertion_step"><code class="xref">src.insertion_step</code></a></td><td>
8383
<em></em></td></tr>
8484
<tr class="cg-1">
8585
<td></td>
8686
<td>&#160;&#160;&#160;
87-
<a href="src.html#module-src.misc"><code class="xref">src.misc</code></a></td><td>
87+
<a href="autoapi/src/log_mod/index.html#module-src.log_mod"><code class="xref">src.log_mod</code></a></td><td>
8888
<em></em></td></tr>
8989
<tr class="cg-1">
9090
<td></td>
9191
<td>&#160;&#160;&#160;
92-
<a href="src.html#module-src.operators"><code class="xref">src.operators</code></a></td><td>
92+
<a href="autoapi/src/misc/index.html#module-src.misc"><code class="xref">src.misc</code></a></td><td>
9393
<em></em></td></tr>
9494
<tr class="cg-1">
9595
<td></td>
9696
<td>&#160;&#160;&#160;
97-
<a href="src.html#module-src.optimization"><code class="xref">src.optimization</code></a></td><td>
97+
<a href="autoapi/src/operators/index.html#module-src.operators"><code class="xref">src.operators</code></a></td><td>
98+
<em></em></td></tr>
99+
<tr class="cg-1">
100+
<td></td>
101+
<td>&#160;&#160;&#160;
102+
<a href="autoapi/src/optimization/index.html#module-src.optimization"><code class="xref">src.optimization</code></a></td><td>
98103
<em></em></td></tr>
99104
</table>
100105

docs/build/html/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/build/html/src.html

Lines changed: 230 additions & 215 deletions
Large diffs are not rendered by default.

docs/source/src.rst

Lines changed: 0 additions & 85 deletions
This file was deleted.

examples/Example_1.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ def GRAD_TEST_FUNC(t, x): # ∇φ_t(x)
190190
data = DGCG.operators.K_t_star_full(measure)
191191
# uncomment the next line to see the backprojected data
192192
# dual_variable = DGCG.classes.dual_variable(DGCG.classes.measure())
193-
# dual_variable.data = -data
193+
# dual_variable._data = -data
194194
# ani_1 = dual_variable.animate(measure = measure, block = True)
195195

196196
# (Optionally) Add noise to the measurements
@@ -201,7 +201,7 @@ def GRAD_TEST_FUNC(t, x): # ∇φ_t(x)
201201

202202
# uncomment to see the noisy backprojected data
203203
# dual_variable = DGCG.classes.dual_variable(DGCG.classes.measure())
204-
# dual_variable.data = -data
204+
# dual_variable._data = -data
205205
# ani_2 = dual_variable.animate(measure = measure, block = True)
206206

207207
# settings to speed up the convergence.

examples/Example_2.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -261,7 +261,7 @@ def GRAD_TEST_FUNC(t, x): # ∇φ_t(x)
261261
data = DGCG.operators.K_t_star_full(measure)
262262
# uncomment the next line to see the backprojected data
263263
# dual_variable = DGCG.classes.dual_variable(DGCG.classes.measure())
264-
# dual_variable.data = -data
264+
# dual_variable._data = -data
265265
# ani_1 = dual_variable.animate(measure = measure, block = True)
266266

267267
# Add noise to the measurements. The noise vector is saved in ./annex
@@ -274,7 +274,7 @@ def GRAD_TEST_FUNC(t, x): # ∇φ_t(x)
274274

275275
# uncomment to see the noisy backprojected data
276276
# dual_variable = DGCG.classes.dual_variable(DGCG.classes.measure())
277-
# dual_variable.data = -data
277+
# dual_variable._data = -data
278278
# ani_2 = dual_variable.animate(measure = measure, block = True)
279279

280280
# settings to speed up the convergence.

examples/Example_2b.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -261,7 +261,7 @@ def GRAD_TEST_FUNC(t, x): # ∇φ_t(x)
261261
data = DGCG.operators.K_t_star_full(measure)
262262
# uncomment the next line to see the backprojected data
263263
# dual_variable = DGCG.classes.dual_variable(DGCG.classes.measure())
264-
# dual_variable.data = -data
264+
# dual_variable._data = -data
265265
# ani_1 = dual_variable.animate(measure = measure, block = True)
266266

267267
# Add noise to the measurements. The noise vector is saved in ./annex
@@ -274,7 +274,7 @@ def GRAD_TEST_FUNC(t, x): # ∇φ_t(x)
274274

275275
# uncomment to see the noisy backprojected data
276276
# dual_variable = DGCG.classes.dual_variable(DGCG.classes.measure())
277-
# dual_variable.data = -data
277+
# dual_variable._data = -data
278278
# ani_2 = dual_variable.animate(measure = measure, block = True)
279279

280280
# settings to speed up the convergence.

examples/Example_2b_accelerated.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -261,7 +261,7 @@ def GRAD_TEST_FUNC(t, x): # ∇φ_t(x)
261261
data = DGCG.operators.K_t_star_full(measure)
262262
# uncomment the next line to see the backprojected data
263263
# dual_variable = DGCG.classes.dual_variable(DGCG.classes.measure())
264-
# dual_variable.data = -data
264+
# dual_variable._data = -data
265265
# ani_1 = dual_variable.animate(measure = measure, block = True)
266266

267267
# Add noise to the measurements. The noise vector is saved in ./annex
@@ -274,7 +274,7 @@ def GRAD_TEST_FUNC(t, x): # ∇φ_t(x)
274274

275275
# uncomment to see the noisy backprojected data
276276
# dual_variable = DGCG.classes.dual_variable(DGCG.classes.measure())
277-
# dual_variable.data = -data
277+
# dual_variable._data = -data
278278
# ani_2 = dual_variable.animate(measure = measure, block = True)
279279

280280
# Input dual-gap tolerance

examples/Example_3.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ def GRAD_TEST_FUNC(t, x): # ∇φ_t(x)
201201
data = DGCG.operators.K_t_star_full(measure)
202202
# uncomment the next line to see the backprojected data
203203
# dual_variable = DGCG.classes.dual_variable(DGCG.classes.measure())
204-
# dual_variable.data = -data
204+
# dual_variable._data = -data
205205
# ani_1 = dual_variable.animate(measure = measure, block = True)
206206

207207
# (Optionally) Add noise to the measurements
@@ -212,7 +212,7 @@ def GRAD_TEST_FUNC(t, x): # ∇φ_t(x)
212212

213213
# uncomment to see the noisy backprojected data
214214
# dual_variable = DGCG.classes.dual_variable(DGCG.classes.measure())
215-
# dual_variable.data = -data
215+
# dual_variable._data = -data
216216
# ani_2 = dual_variable.animate(measure = measure, block = True)
217217

218218
# settings to speed up the convergence.

src/DGCG.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,9 @@ def set_model_parameters(alpha, beta, time_samples, H_dimensions,
6767
rounded_H_dim = np.array([np.round(dim) for dim in H_dimensions], dtype=int)
6868
if np.any(np.abs(rounded_H_dim - np.array(H_dimensions)) > tol_error):
6969
raise Exception('The given dimensions are not integer numbers')
70-
operators.K = rounded_H_dim
71-
operators.test_func = test_func
72-
operators.grad_test_func = grad_test_func
70+
operators.H_DIMENSIONS = rounded_H_dim
71+
operators.TEST_FUNC = test_func
72+
operators.GRAD_TEST_FUNC = grad_test_func
7373

7474

7575
def solve(data, **kwargs):

0 commit comments

Comments
 (0)