[doc] CtcInverse in Matlab

Author: godardma

doc/manual/manual/contractors/analytic/ctcinverse.rst

@@ -84,6 +84,14 @@ To represent the vectors :math:`\mathbf{x}\in\mathbb{R}^n` consistent with the c
       :end-before: [ctcinv-1-end]
       :dedent: 4
 
+  .. group-tab:: Matlab
+
+    .. literalinclude:: src.m
+      :language: matlab
+      :start-after: [ctcinv-1-beg]
+      :end-before: [ctcinv-1-end]
+      :dedent: 0
+
 The contractor can be used as an operator to contract a 2d box :math:`[\mathbf{x}]`. It can also be involved in a paver in order to reveal the constraint:
 
 .. tabs::
@@ -104,6 +112,14 @@ The contractor can be used as an operator to contract a 2d box :math:`[\mathbf{x
       :end-before: [ctcinv-2-end]
       :dedent: 4
 
+  .. group-tab:: Matlab
+
+    .. literalinclude:: src.m
+      :language: matlab
+      :start-after: [ctcinv-2-beg]
+      :end-before: [ctcinv-2-end]
+      :dedent: 0
+
 Which produces the following output:
 
 .. figure:: ./himmelblau_50.png
@@ -131,6 +147,15 @@ We recall that for thick solution sets, one should prefer the use of the ``SepIn
       :end-before: [ctcinv-3-end]
       :dedent: 4
 
+  .. group-tab:: Matlab
+
+    .. literalinclude:: src.m
+      :language: matlab
+      :start-after: [ctcinv-3-beg]
+      :end-before: [ctcinv-3-end]
+      :dedent: 0
+
+
 .. figure:: ./himmelblau_50_inner.png
   :width: 400px
 
@@ -163,6 +188,14 @@ can be easily approximated by the following union of contractors:
       :end-before: [ctcinv-4-end]
       :dedent: 4
 
+  .. group-tab:: Matlab
+
+    .. literalinclude:: src.m
+      :language: matlab
+      :start-after: [ctcinv-4-beg]
+      :end-before: [ctcinv-4-end]
+      :dedent: 0
+
 .. figure:: ./himmelblau_50_150_250.png
   :width: 400px
 
@@ -302,14 +335,22 @@ When the constraint is a complement constraint :math:`\mathbf{f}(\mathbf{x})\not
       :end-before: [ctcinv-5-end]
       :dedent: 4
 
+  .. group-tab:: Matlab
+
+    .. literalinclude:: src.m
+      :language: matlab
+      :start-after: [ctcinv-5-beg]
+      :end-before: [ctcinv-5-end]
+      :dedent: 0
+
 
 Miscellaneous
 -------------
 
 Access to the underlying function
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-The underlying analytic function can be accessed through ``.function()`` (useful for dimension checks or meta-programming).
+The underlying analytic function can be accessed through ``.f()`` (useful for dimension checks or meta-programming).
 
 .. tabs::
 
@@ -329,6 +370,14 @@ The underlying analytic function can be accessed through ``.function()`` (useful
       :end-before: [ctcinv-6-end]
       :dedent: 4
 
+  .. group-tab:: Matlab
+
+    .. literalinclude:: src.m
+      :language: matlab
+      :start-after: [ctcinv-6-beg]
+      :end-before: [ctcinv-6-end]
+      :dedent: 0
+
 Centered form option
 ^^^^^^^^^^^^^^^^^^^^
 

doc/manual/manual/contractors/analytic/src.cpp

@@ -64,11 +64,11 @@ TEST_CASE("CtcInverse - manual")
     VectorVar x(2);
     AnalyticFunction f({x}, x[0]-x[1]);
     CtcInverse c(f, 0);
-    // c.function().input_size() == 2
-    // c.function().output_size() == 1
+    // c.f().input_size() == 2
+    // c.f().output_size() == 1
     // [ctcinv-6-end]
 
-    CHECK(c.function().input_size() == 2);
-    CHECK(c.function().output_size() == 1);
+    CHECK(c.f().input_size() == 2);
+    CHECK(c.f().output_size() == 1);
   }
 }

doc/manual/manual/contractors/analytic/src.m

@@ -48,6 +48,6 @@
 x = VectorVar(2);
 f = AnalyticFunction({x}, x(1)-x(2));
 c = CtcInverse(f, 0);
-assert(c.function().input_size()==2);
-assert(c.function().output_size()==1);
+assert(c.f().input_size()==2);
+assert(c.f().output_size()==1);
 % [ctcinv-6-end]

doc/manual/manual/contractors/analytic/src.py

@@ -56,8 +56,8 @@ def tests_CtcInverse_manual(test):
     x = VectorVar(2)
     f = AnalyticFunction([x], x[0]-x[1])
     c = CtcInverse(f, 0)
-    assert c.function().input_size() == 2
-    assert c.function().output_size() == 1
+    assert c.f().input_size() == 2
+    assert c.f().output_size() == 1
     # [ctcinv-6-end]
 
 if __name__ ==  '__main__':

python/codac/core/__init__.py

@@ -183,8 +183,8 @@ def contract_tube(self,*x):
   def copy(self):
     return self.c.copy()
 
-  def function(self):
-    return self.c.function()
+  def f(self):
+    return self.c.f()
 
 
 class CtcInverseNotIn(Ctc_IntervalVector):

python/src/core/contractors/codac2_py_CtcInverse.h

@@ -65,8 +65,8 @@ void export_CtcInverse(py::module& m, const std::string& export_name, py::class_
       VOID_CTCBASE_X_CONTRACT_TUBE_SLICEDTUBE_X_REF_VARIADIC_CONST,
       "x"_a)
 
-    .def("function", &C::function,
-      CONST_ANALYTICFUNCTION_TYPENAME_EXPRTYPE_Y_TYPE_REF_CTCINVERSE_YX_FUNCTION_CONST)
+    .def("f", &C::f,
+      CONST_ANALYTICFUNCTION_TYPENAME_EXPRTYPE_Y_TYPE_REF_CTCINVERSE_YX_F_CONST)
 
   ;
 }

src/core/contractors/codac2_CtcInverse.h

@@ -117,7 +117,7 @@ namespace codac2
         _f.intersect_from_args(v, x...); // updating input values
       }
 
-      const AnalyticFunction<typename ExprType<Y>::Type>& function() const
+      const AnalyticFunction<typename ExprType<Y>::Type>& f() const
       {
         return _f;
       }

tests/core/contractors/codac2_tests_CtcInverse.cpp

@@ -43,7 +43,7 @@ TEST_CASE("CtcInverse")
     ScalarVar x,y;
     AnalyticFunction f { {x,y}, x-y };
     CtcInverse<Interval,Interval,Interval> c(f, Interval(0.));
-    CHECK(c.function().input_size() == 2);
+    CHECK(c.f().input_size() == 2);
 
     Interval a,b;
 

tests/core/contractors/codac2_tests_CtcInverse.py

@@ -30,7 +30,7 @@ def test_CtcInverse_1(self):
     x = VectorVar(2)
     f = AnalyticFunction([x], x[0]-x[1])
     c = CtcInverse(f, 0)
-    self.assertTrue(c.function().input_size() == 2)
+    self.assertTrue(c.f().input_size() == 2)
 
     b = IntervalVector(2)