Added API Python doc of OrthProdFuncFact and OrthProdPolyFact

mbaudin47 · May 6, 2024 · 6bf14ae · 6bf14ae
1 parent 266a1a8
commit 6bf14ae
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 0 deletions.
diff --git a/python/src/OrthogonalProductFunctionFactory_doc.i.in b/python/src/OrthogonalProductFunctionFactory_doc.i.in
@@ -50,3 +50,18 @@ Returns
 -------
 polynomialFamily : list of :class:`~openturns.OrthogonalUniVariateFunctionFamily`
     List of orthogonal univariate function families."
+
+// ---------------------------------------------------------------------
+
+%feature("docstring") OT::OrthogonalProductFunctionFactory::getMarginal
+"Get the marginal orthogonal multivariate functions.
+
+Parameters
+----------
+indices : sequence of int, :math:`0 \leq i < n`
+    List of marginal indices.
+
+Returns
+-------
+factory : :class:`~openturns.OrthogonalProductFunctionFactory`
+    The marginal multivariate functions."
diff --git a/python/src/OrthogonalProductPolynomialFactory_doc.i.in b/python/src/OrthogonalProductPolynomialFactory_doc.i.in
@@ -104,3 +104,18 @@ Examples
 1 : [  1        -0.774597  3.75     ]
 >>> print(weights[:2])
 [0.138889,0.138889]"
+
+// ---------------------------------------------------------------------
+
+%feature("docstring") OT::OrthogonalProductPolynomialFactory::getMarginal
+"Get the marginal orthogonal multivariate polynomials.
+
+Parameters
+----------
+indices : sequence of int, :math:`0 \leq i < n`
+    List of marginal indices.
+
+Returns
+-------
+factory : :class:`~openturns.OrthogonalProductPolynomialFactory`
+    The marginal multivariate polynomials."