merge fix/generate-documentation-workflow into fix/generate-documenta…

…tion-workflow-test-merge

.github/workflows/generate-and-submit-documentation.yaml

@@ -8,11 +8,11 @@ jobs:
   generate-documentation:
     runs-on: self-hosted-k3s
     steps:
-    - name: Checkout
-      uses: actions/checkout@v3
-      with:
-        persist-credentials: false
-        fetch-depth: 0
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          persist-credentials: false
+          fetch-depth: 0
 
     - name: Generate documentation
       run: make doc

claasp/cipher.py

@@ -47,6 +47,8 @@ def __init__(self, family_name, cipher_type, cipher_inputs,
         """
         Construct an instance of the Cipher class.
 
+        TEST2
+
         This class is used to store compact representations of a editor.
 
         INPUT:

docker/Dockerfile

@@ -77,7 +77,7 @@ RUN sage -pip install bitstring==4.0.1 \
   pygments==2.12.0 \
   sage-package==0.0.7 \
   setuptools==59.6.0 \
-  sphinx==4.5.0 \
+  sphinx==5.0.0 \
   sphinxcontrib-bibtex==2.5.0 \
   tensorflow==2.13.0 \
   pytest==7.2.1 \

docs/build/html/_sources/index.rst.txt

@@ -174,6 +174,9 @@ Cipher modules
     cipher_modules/report
     cipher_modules/graph_generator
     cipher_modules/tester
+    cipher_modules/generic_functions_continuous_diffusion_analysis
+    cipher_modules/algebraic_tests
+    cipher_modules/code_generator
     cipher_modules/evaluator
     cipher_modules/generic_bit_based_c_functions
     cipher_modules/generic_functions_vectorized_bit
@@ -252,7 +255,9 @@ Utils
 
 .. toctree::
 
-    cipher_modules/models/smt/utils/utils
+    cipher_modules/models/sat/utils/mzn_predicates
+    cipher_modules/models/sat/utils/utils
+    cipher_modules/models/sat/utils/n_window_heuristic_helper
 
 Cp
 ``

docs/build/html/cipher_modules/algebraic_tests.html

@@ -37,7 +37,7 @@ <h3>Navigation</h3>
           <a href="statistical_tests/nist_statistical_tests.html" title="Nist statistical tests"
              accesskey="N">next</a> |</li>
         <li class="right" >
-          <a href="avalanche_tests.html" title="Avalanche tests"
+          <a href="generic_functions_continuous_diffusion_analysis.html" title="Generic functions continuous diffusion analysis"
              accesskey="P">previous</a> |</li>
 
 
@@ -111,8 +111,8 @@ <h3>Navigation</h3>
         <div class="sphinxsidebarwrapper">
   <div>
     <h4>Previous topic</h4>
-    <p class="topless"><a href="avalanche_tests.html"
-                          title="previous chapter">Avalanche tests</a></p>
+    <p class="topless"><a href="generic_functions_continuous_diffusion_analysis.html"
+                          title="previous chapter">Generic functions continuous diffusion analysis</a></p>
   </div>
   <div>
     <h4>Next topic</h4>
@@ -153,7 +153,7 @@ <h3>Navigation</h3>
           <a href="statistical_tests/nist_statistical_tests.html" title="Nist statistical tests"
              >next</a> |</li>
         <li class="right" >
-          <a href="avalanche_tests.html" title="Avalanche tests"
+          <a href="generic_functions_continuous_diffusion_analysis.html" title="Generic functions continuous diffusion analysis"
              >previous</a> |</li>
 
 

docs/build/html/cipher_modules/avalanche_tests.html

@@ -34,7 +34,7 @@ <h3>Navigation</h3>
           <a href="../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
         <li class="right" >
-          <a href="algebraic_tests.html" title="Algebraic tests"
+          <a href="tester.html" title="Tester"
              accesskey="N">next</a> |</li>
         <li class="right" >
           <a href="neural_network_tests.html" title="Neural network tests"
@@ -227,8 +227,8 @@ <h4>Previous topic</h4>
   </div>
   <div>
     <h4>Next topic</h4>
-    <p class="topless"><a href="algebraic_tests.html"
-                          title="next chapter">Algebraic tests</a></p>
+    <p class="topless"><a href="tester.html"
+                          title="next chapter">Tester</a></p>
   </div>
   <div role="note" aria-label="source link">
     <h3>This Page</h3>
@@ -261,7 +261,7 @@ <h3>Navigation</h3>
           <a href="../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
         <li class="right" >
-          <a href="algebraic_tests.html" title="Algebraic tests"
+          <a href="tester.html" title="Tester"
              >next</a> |</li>
         <li class="right" >
           <a href="neural_network_tests.html" title="Neural network tests"

docs/build/html/cipher_modules/code_generator.html

@@ -17,8 +17,8 @@
     <link rel="shortcut icon" href="../_static/favicon.ico"/>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
-    <link rel="next" title="Generic functions continuous diffusion analysis" href="generic_functions_continuous_diffusion_analysis.html" />
-    <link rel="prev" title="Generic functions vectorized bit" href="generic_functions_vectorized_bit.html" />
+    <link rel="next" title="Evaluator" href="evaluator.html" />
+    <link rel="prev" title="Algebraic tests" href="algebraic_tests.html" />
     <link rel="icon" href="../_static/sageicon.png" type="image/x-icon" />
     <script src="../_static/thebe.js" type="text/javascript"></script>
     <script src="../_static/thebe-sage.js" type="text/javascript"></script>
@@ -34,10 +34,10 @@ <h3>Navigation</h3>
           <a href="../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
         <li class="right" >
-          <a href="generic_functions_continuous_diffusion_analysis.html" title="Generic functions continuous diffusion analysis"
+          <a href="evaluator.html" title="Evaluator"
              accesskey="N">next</a> |</li>
         <li class="right" >
-          <a href="generic_functions_vectorized_bit.html" title="Generic functions vectorized bit"
+          <a href="algebraic_tests.html" title="Algebraic tests"
              accesskey="P">previous</a> |</li>
 
 
@@ -315,13 +315,13 @@ <h3>Navigation</h3>
         <div class="sphinxsidebarwrapper">
   <div>
     <h4>Previous topic</h4>
-    <p class="topless"><a href="generic_functions_vectorized_bit.html"
-                          title="previous chapter">Generic functions vectorized bit</a></p>
+    <p class="topless"><a href="algebraic_tests.html"
+                          title="previous chapter">Algebraic tests</a></p>
   </div>
   <div>
     <h4>Next topic</h4>
-    <p class="topless"><a href="generic_functions_continuous_diffusion_analysis.html"
-                          title="next chapter">Generic functions continuous diffusion analysis</a></p>
+    <p class="topless"><a href="evaluator.html"
+                          title="next chapter">Evaluator</a></p>
   </div>
   <div role="note" aria-label="source link">
     <h3>This Page</h3>
@@ -354,10 +354,10 @@ <h3>Navigation</h3>
           <a href="../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
         <li class="right" >
-          <a href="generic_functions_continuous_diffusion_analysis.html" title="Generic functions continuous diffusion analysis"
+          <a href="evaluator.html" title="Evaluator"
              >next</a> |</li>
         <li class="right" >
-          <a href="generic_functions_vectorized_bit.html" title="Generic functions vectorized bit"
+          <a href="algebraic_tests.html" title="Algebraic tests"
              >previous</a> |</li>
 
 

docs/build/html/cipher_modules/evaluator.html

@@ -37,7 +37,7 @@ <h3>Navigation</h3>
           <a href="generic_bit_based_c_functions.html" title="Generic bit based c functions"
              accesskey="N">next</a> |</li>
         <li class="right" >
-          <a href="tester.html" title="Tester"
+          <a href="code_generator.html" title="Code generator"
              accesskey="P">previous</a> |</li>
 
 
@@ -89,8 +89,8 @@ <h3>Navigation</h3>
         <div class="sphinxsidebarwrapper">
   <div>
     <h4>Previous topic</h4>
-    <p class="topless"><a href="tester.html"
-                          title="previous chapter">Tester</a></p>
+    <p class="topless"><a href="code_generator.html"
+                          title="previous chapter">Code generator</a></p>
   </div>
   <div>
     <h4>Next topic</h4>
@@ -131,7 +131,7 @@ <h3>Navigation</h3>
           <a href="generic_bit_based_c_functions.html" title="Generic bit based c functions"
              >next</a> |</li>
         <li class="right" >
-          <a href="tester.html" title="Tester"
+          <a href="code_generator.html" title="Code generator"
              >previous</a> |</li>
 
 

docs/build/html/cipher_modules/generic_functions_continuous_diffusion_analysis.html

@@ -37,7 +37,7 @@ <h3>Navigation</h3>
           <a href="continuous_diffusion_analysis.html" title="Continuous diffusion analysis"
              accesskey="N">next</a> |</li>
         <li class="right" >
-          <a href="code_generator.html" title="Code generator"
+          <a href="tester.html" title="Tester"
              accesskey="P">previous</a> |</li>
 
 
@@ -448,8 +448,8 @@ <h3>Navigation</h3>
         <div class="sphinxsidebarwrapper">
   <div>
     <h4>Previous topic</h4>
-    <p class="topless"><a href="code_generator.html"
-                          title="previous chapter">Code generator</a></p>
+    <p class="topless"><a href="tester.html"
+                          title="previous chapter">Tester</a></p>
   </div>
   <div>
     <h4>Next topic</h4>
@@ -490,7 +490,7 @@ <h3>Navigation</h3>
           <a href="continuous_diffusion_analysis.html" title="Continuous diffusion analysis"
              >next</a> |</li>
         <li class="right" >
-          <a href="code_generator.html" title="Code generator"
+          <a href="tester.html" title="Tester"
              >previous</a> |</li>
 
 

docs/build/html/cipher_modules/generic_functions_vectorized_bit.html

@@ -34,7 +34,7 @@ <h3>Navigation</h3>
           <a href="../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
         <li class="right" >
-          <a href="code_generator.html" title="Code generator"
+          <a href="generic_functions_vectorized_byte.html" title="Generic functions vectorized byte"
              accesskey="N">next</a> |</li>
         <li class="right" >
           <a href="generic_bit_based_c_functions.html" title="Generic bit based c functions"
@@ -301,8 +301,8 @@ <h4>Previous topic</h4>
   </div>
   <div>
     <h4>Next topic</h4>
-    <p class="topless"><a href="code_generator.html"
-                          title="next chapter">Code generator</a></p>
+    <p class="topless"><a href="generic_functions_vectorized_byte.html"
+                          title="next chapter">Generic functions vectorized byte</a></p>
   </div>
   <div role="note" aria-label="source link">
     <h3>This Page</h3>
@@ -335,7 +335,7 @@ <h3>Navigation</h3>
           <a href="../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
         <li class="right" >
-          <a href="code_generator.html" title="Code generator"
+          <a href="generic_functions_vectorized_byte.html" title="Generic functions vectorized byte"
              >next</a> |</li>
         <li class="right" >
           <a href="generic_bit_based_c_functions.html" title="Generic bit based c functions"

docs/build/html/cipher_modules/models/milp/milp_models/milp_wordwise_deterministic_truncated_xor_differential_model.html

@@ -34,7 +34,7 @@ <h3>Navigation</h3>
           <a href="../../../../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
         <li class="right" >
-          <a href="milp_xor_differential_model.html" title="Milp xor differential model"
+          <a href="milp_cipher_model.html" title="Milp cipher model"
              accesskey="N">next</a> |</li>
         <li class="right" >
           <a href="milp_cipher_model.html" title="Milp cipher model"
@@ -453,8 +453,8 @@ <h4>Previous topic</h4>
   </div>
   <div>
     <h4>Next topic</h4>
-    <p class="topless"><a href="milp_xor_differential_model.html"
-                          title="next chapter">Milp xor differential model</a></p>
+    <p class="topless"><a href="milp_cipher_model.html"
+                          title="next chapter">Milp cipher model</a></p>
   </div>
   <div role="note" aria-label="source link">
     <h3>This Page</h3>
@@ -487,7 +487,7 @@ <h3>Navigation</h3>
           <a href="../../../../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
         <li class="right" >
-          <a href="milp_xor_differential_model.html" title="Milp xor differential model"
+          <a href="milp_cipher_model.html" title="Milp cipher model"
              >next</a> |</li>
         <li class="right" >
           <a href="milp_cipher_model.html" title="Milp cipher model"

docs/build/html/cipher_modules/models/milp/milp_models/milp_xor_differential_model.html

@@ -37,7 +37,7 @@ <h3>Navigation</h3>
           <a href="milp_xor_linear_model.html" title="Milp xor linear model"
              accesskey="N">next</a> |</li>
         <li class="right" >
-          <a href="milp_wordwise_deterministic_truncated_xor_differential_model.html" title="Milp wordwise deterministic truncated xor differential model"
+          <a href="milp_xor_linear_model.html" title="Milp xor linear model"
              accesskey="P">previous</a> |</li>
 
 
@@ -602,8 +602,8 @@ <h3>Navigation</h3>
         <div class="sphinxsidebarwrapper">
   <div>
     <h4>Previous topic</h4>
-    <p class="topless"><a href="milp_wordwise_deterministic_truncated_xor_differential_model.html"
-                          title="previous chapter">Milp wordwise deterministic truncated xor differential model</a></p>
+    <p class="topless"><a href="milp_xor_linear_model.html"
+                          title="previous chapter">Milp xor linear model</a></p>
   </div>
   <div>
     <h4>Next topic</h4>
@@ -644,7 +644,7 @@ <h3>Navigation</h3>
           <a href="milp_xor_linear_model.html" title="Milp xor linear model"
              >next</a> |</li>
         <li class="right" >
-          <a href="milp_wordwise_deterministic_truncated_xor_differential_model.html" title="Milp wordwise deterministic truncated xor differential model"
+          <a href="milp_xor_linear_model.html" title="Milp xor linear model"
              >previous</a> |</li>
 
 

docs/build/html/cipher_modules/models/milp/utils/dictionary_containing_truncated_xor_inequalities_between_n_input_bits.html

@@ -37,7 +37,7 @@ <h3>Navigation</h3>
           <a href="dictionary_that_contains_inequalities_for_large_sboxes.html" title="Dictionary that contains inequalities for large sboxes"
              accesskey="N">next</a> |</li>
         <li class="right" >
-          <a href="dictionary_that_contains_inequalities_for_sboxes_with_undisturbed_bits.html" title="Dictionary that contains inequalities for sboxes with undisturbed bits"
+          <a href="generate_inequalities_for_and_operation_2_input_bits.html" title="Generate inequalities for and operation 2 input bits"
              accesskey="P">previous</a> |</li>
 
 
@@ -69,8 +69,8 @@ <h1>Dictionary containing truncated xor inequalities between n input bits<a clas
         <div class="sphinxsidebarwrapper">
   <div>
     <h4>Previous topic</h4>
-    <p class="topless"><a href="dictionary_that_contains_inequalities_for_sboxes_with_undisturbed_bits.html"
-                          title="previous chapter">Dictionary that contains inequalities for sboxes with undisturbed bits</a></p>
+    <p class="topless"><a href="generate_inequalities_for_and_operation_2_input_bits.html"
+                          title="previous chapter">Generate inequalities for and operation 2 input bits</a></p>
   </div>
   <div>
     <h4>Next topic</h4>
@@ -111,7 +111,7 @@ <h3>Navigation</h3>
           <a href="dictionary_that_contains_inequalities_for_large_sboxes.html" title="Dictionary that contains inequalities for large sboxes"
              >next</a> |</li>
         <li class="right" >
-          <a href="dictionary_that_contains_inequalities_for_sboxes_with_undisturbed_bits.html" title="Dictionary that contains inequalities for sboxes with undisturbed bits"
+          <a href="generate_inequalities_for_and_operation_2_input_bits.html" title="Generate inequalities for and operation 2 input bits"
              >previous</a> |</li>
 
 

docs/build/html/cipher_modules/models/milp/utils/dictionary_that_contains_inequalities_for_sboxes_with_undisturbed_bits.html

@@ -34,7 +34,7 @@ <h3>Navigation</h3>
           <a href="../../../../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
         <li class="right" >
-          <a href="dictionary_containing_truncated_xor_inequalities_between_n_input_bits.html" title="Dictionary containing truncated xor inequalities between n input bits"
+          <a href="dictionary_that_contains_inequalities_for_small_sboxes.html" title="Dictionary that contains inequalities for small sboxes"
              accesskey="N">next</a> |</li>
         <li class="right" >
           <a href="dictionary_that_contains_inequalities_for_small_sboxes_xor_linear.html" title="Dictionary that contains inequalities for small sboxes xor linear"
@@ -74,8 +74,8 @@ <h4>Previous topic</h4>
   </div>
   <div>
     <h4>Next topic</h4>
-    <p class="topless"><a href="dictionary_containing_truncated_xor_inequalities_between_n_input_bits.html"
-                          title="next chapter">Dictionary containing truncated xor inequalities between n input bits</a></p>
+    <p class="topless"><a href="dictionary_that_contains_inequalities_for_small_sboxes.html"
+                          title="next chapter">Dictionary that contains inequalities for small sboxes</a></p>
   </div>
   <div role="note" aria-label="source link">
     <h3>This Page</h3>
@@ -108,7 +108,7 @@ <h3>Navigation</h3>
           <a href="../../../../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
         <li class="right" >
-          <a href="dictionary_containing_truncated_xor_inequalities_between_n_input_bits.html" title="Dictionary containing truncated xor inequalities between n input bits"
+          <a href="dictionary_that_contains_inequalities_for_small_sboxes.html" title="Dictionary that contains inequalities for small sboxes"
              >next</a> |</li>
         <li class="right" >
           <a href="dictionary_that_contains_inequalities_for_small_sboxes_xor_linear.html" title="Dictionary that contains inequalities for small sboxes xor linear"