Finished documentation process

Author: panchoop

docs/build/doctrees/environment.pickle

@@ -228,14 +228,6 @@ <h2 id="F">F</h2>
 <h2 id="G">G</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="autoapi/src/config/index.html#src.config.g_flow_init_step">g_flow_init_step (in module src.config)</a>
-</li>
-      <li><a href="autoapi/src/config/index.html#src.config.g_flow_limit_stepsize">g_flow_limit_stepsize (in module src.config)</a>
-</li>
-      <li><a href="autoapi/src/config/index.html#src.config.g_flow_opt_in_between_iters">g_flow_opt_in_between_iters (in module src.config)</a>
-</li>
-      <li><a href="autoapi/src/config/index.html#src.config.g_flow_opt_max_iter">g_flow_opt_max_iter (in module src.config)</a>
-</li>
       <li><a href="autoapi/src/log_mod/index.html#src.log_mod.logger.generate_plots">generate_plots() (src.log_mod.logger method)</a>
 </li>
       <li><a href="autoapi/src/insertion_mod/index.html#src.insertion_mod.ordered_list_of_lists.GET">GET() (src.insertion_mod.ordered_list_of_lists method)</a>
@@ -244,12 +236,12 @@ <h2 id="G">G</h2>
 </li>
       <li><a href="autoapi/src/misc/index.html#src.misc.get_periodic_segments">get_periodic_segments() (in module src.misc)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="autoapi/src/classes/index.html#src.classes.dual_variable.get_sum_maxs">get_sum_maxs() (src.classes.dual_variable method)</a>
 </li>
       <li><a href="autoapi/src/classes/index.html#src.classes.dual_variable.grad_eval">grad_eval() (src.classes.dual_variable method)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="autoapi/src/optimization/index.html#src.optimization.grad_F">grad_F() (in module src.optimization)</a>
 </li>
       <li><a href="autoapi/src/operators/index.html#src.operators.grad_K_t">grad_K_t() (in module src.operators)</a>
@@ -435,7 +427,7 @@ <h2 id="M">M</h2>
 </li>
       <li><a href="autoapi/src/config/index.html#src.config.multistart_inter_iteration_checkup">multistart_inter_iteration_checkup (in module src.config)</a>
 </li>
-      <li><a href="autoapi/src/config/index.html#id0">multistart_max_discarded_tries (in module src.config)</a>, <a href="autoapi/src/config/index.html#src.config.multistart_max_discarded_tries">[1]</a>
+      <li><a href="autoapi/src/config/index.html#src.config.multistart_max_discarded_tries">multistart_max_discarded_tries (in module src.config)</a>
 </li>
       <li><a href="autoapi/src/config/index.html#src.config.multistart_pooling_num">multistart_pooling_num (in module src.config)</a>
 </li>
@@ -510,6 +502,14 @@ <h2 id="S">S</h2>
       <li><a href="autoapi/src/classes/index.html#src.classes.curve.set_times">set_times() (src.classes.curve method)</a>
 </li>
       <li><a href="autoapi/src/optimization/index.html#src.optimization.slide_and_optimize">slide_and_optimize() (in module src.optimization)</a>
+</li>
+      <li><a href="autoapi/src/config/index.html#src.config.slide_init_step">slide_init_step (in module src.config)</a>
+</li>
+      <li><a href="autoapi/src/config/index.html#src.config.slide_limit_stepsize">slide_limit_stepsize (in module src.config)</a>
+</li>
+      <li><a href="autoapi/src/config/index.html#src.config.slide_opt_in_between_iters">slide_opt_in_between_iters (in module src.config)</a>
+</li>
+      <li><a href="autoapi/src/config/index.html#src.config.slide_opt_max_iter">slide_opt_max_iter (in module src.config)</a>
 </li>
       <li><a href="autoapi/src/DGCG/index.html#src.DGCG.solve">solve() (in module src.DGCG)</a>
 </li>
@@ -545,15 +545,15 @@ <h2 id="S">S</h2>
         <li><a href="_autosummary/src.config.html#module-src.config">module</a>, <a href="autoapi/src/config/index.html#module-src.config">[1]</a>
 </li>
       </ul></li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li>
     src.DGCG
 
       <ul>
         <li><a href="_autosummary/src.DGCG.html#module-src.DGCG">module</a>, <a href="autoapi/src/DGCG/index.html#module-src.DGCG">[1]</a>
 </li>
       </ul></li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li>
     src.insertion_mod
 
@@ -619,18 +619,16 @@ <h2 id="T">T</h2>
       <li><a href="autoapi/src/operators/index.html#src.operators.TEST_FUNC">TEST_FUNC (in module src.operators)</a>
 </li>
       <li><a href="autoapi/src/config/index.html#src.config.time">time (in module src.config)</a>
-</li>
-      <li><a href="autoapi/src/log_mod/index.html#src.log_mod.logger.time_string">time_string() (src.log_mod.logger method)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="autoapi/src/log_mod/index.html#src.log_mod.logger.time_string">time_string() (src.log_mod.logger method)</a>
+</li>
       <li><a href="autoapi/src/config/index.html#src.config.time_weights">time_weights (in module src.config)</a>
 </li>
       <li><a href="autoapi/src/classes/index.html#src.classes.measure.to_curve_product">to_curve_product() (src.classes.measure method)</a>
 </li>
       <li><a href="autoapi/src/classes/index.html#src.classes.curve_product.to_measure">to_measure() (src.classes.curve_product method)</a>
-</li>
-      <li><a href="autoapi/src/optimization/index.html#src.optimization.to_positive_semidefinite">to_positive_semidefinite() (in module src.optimization)</a>
 </li>
   </ul></td>
 </tr></table>

docs/build/html/genindex.html

@@ -182,7 +182,7 @@ def solve(data, **kwargs):
     if default_parameters['initial_measure'] is None:
         current_measure = classes.measure()
         M_0 = operators.int_time_H_t_product(data, data)/2
-        current_measure.main_energy = M_0
+        current_measure._main_energy = M_0
     else:
         if isinstance(default_parameters['initial_measure'], classes.measure):
             current_measure = default_parameters['initial_measure']

docs/build/html/objects.inv

@@ -1,3 +1,12 @@
+"""
+Checker module.
+
+Checks during execution that everything is working correctly (the outputs of
+the functions are mapping correctly and etc). Should be replaced by proper
+unit tests.
+
+Undocumented.
+"""
 # Standard imports
 import numpy as np
 import sys
@@ -6,13 +15,6 @@
 from . import config
 from . import operators as op
 
-
-""" Checking module that satisfies that all input variables of the methods 
-correspond to the expected ones.
-
-The operators modules
-"""
-
 def is_valid_time(t):
     # t should be an integer number in {0,1,..., T-1}
     if isinstance(t, int) or isinstance(t, np.integer):
@@ -22,11 +24,11 @@ def is_valid_time(t):
 
 def is_in_H_t(t, f_t):
     # H_t should be just a 1 dimensional vector of complex numbers of size
-    # K[t], defined on the operators module
+    # H_DIMENSIONS[t], defined on the operators module
     if is_valid_time(t):
         if isinstance(f_t, np.ndarray):
             if len(f_t.shape)==1:
-                if f_t.shape[0] == op.K[t]:
+                if f_t.shape[0] == op.H_DIMENSIONS[t]:
                     return True
     return False
 
@@ -36,7 +38,7 @@ def set_in_H_t(t, f_t):
     if is_valid_time(t):
         if isinstance(f_t, np.ndarray):
             if len(f_t.shape)==2:
-                if f_t.shape[1] == op.K[t]:
+                if f_t.shape[1] == op.H_DIMENSIONS[t]:
                     return True
     return False