In CovarianceModel, made public {g,s}etFullParameter and getFullParameterDescription methods

Fix also missing sign checking

Author: Sofiane HADDAD

lib/src/Base/Stat/CovarianceModel.cxx

@@ -302,6 +302,23 @@ Indices CovarianceModel::getActiveParameter() const
   return getImplementation()->getActiveParameter();
 }
 
+
+/* setter for the full parameter */
+void CovarianceModel::setFullParameter(const Point & parameter)
+{
+  getImplementation()->setFullParameter(parameter);
+}
+
+Point CovarianceModel::getFullParameter() const
+{
+  return getImplementation()->getFullParameter();
+}
+
+Description CovarianceModel::getFullParameterDescription() const
+{
+  return getImplementation()->getFullParameterDescription();
+}
+
 /* Is it a stationary covariance model ? */
 Bool CovarianceModel::isStationary() const
 {

lib/src/Base/Stat/CovarianceModelImplementation.cxx

@@ -574,14 +574,24 @@ void CovarianceModelImplementation::setFullParameter(const Point & parameter)
   // Here we manage only the generic parameters
   // First the scale parameter
   UnsignedInteger index = 0;
+  // Check the size
+  const UnsignedInteger totalSize = spatialDimension_ + dimension_ * (dimension_ + 1) / 2;
+  if (parameter.getSize() < totalSize)
+    throw InvalidArgumentException(HERE) << "In CovarianceModelImplementation::setFullParameter, points have incompatible size. Point size = " << parameter.getSize()
+                                         << " whereas expected size = " << totalSize ;
+
   for (UnsignedInteger i = 0; i < spatialDimension_; ++ i)
   {
+    if (!(parameter[index] > 0.0))
+      throw InvalidArgumentException(HERE) << "In CovarianceModelImplementation::setParameter, the component " << index << " of scale is non positive" ;
     scale_[i] = parameter[index];
     ++ index;
   }
   // Second the amplitude parameter
   for (UnsignedInteger i = 0; i < dimension_; ++ i)
   {
+    if (!(parameter[index] > 0.0))
+      throw InvalidArgumentException(HERE) << "In CovarianceModelImplementation::setParameter, the component " << index << " of amplitude is non positive" ;
     amplitude_[i] = parameter[index];
     ++ index;
   }

lib/src/Base/Stat/openturns/CovarianceModel.hxx

@@ -153,6 +153,12 @@ public:
   void setActiveParameter(const Indices & active);
   Indices getActiveParameter() const;
 
+
+  /* setter for the full parameter */
+  virtual void setFullParameter(const Point & parameter);
+  virtual Point getFullParameter() const;
+  virtual Description getFullParameterDescription() const;
+
   /** Is it a stationary model ? */
   virtual Bool isStationary() const;
 

lib/src/Base/Stat/openturns/CovarianceModelImplementation.hxx

@@ -177,6 +177,11 @@ public:
   virtual void setActiveParameter(const Indices & active);
   virtual Indices getActiveParameter() const;
 
+  /* setter for the full parameter */
+  virtual void setFullParameter(const Point & parameter);
+  virtual Point getFullParameter() const;
+  virtual Description getFullParameterDescription() const;
+
   /** String converter */
   virtual String __repr__() const;
 
@@ -202,9 +207,6 @@ public:
   virtual void load(Advocate & adv);
 
 protected:
-  virtual void setFullParameter(const Point & parameter);
-  virtual Point getFullParameter() const;
-  virtual Description getFullParameterDescription() const;
 
   // set the covariance structure
   void updateSpatialCovariance();

python/src/CovarianceModelImplementation_doc.i.in

@@ -661,3 +661,54 @@ graph : :class:`~openturns.Graph`
 %feature("docstring") OT::CovarianceModelImplementation::draw
 OT_CovarianceModel_draw_doc
 
+// ---------------------------------------------------------------------
+
+%define OT_CovarianceModel_setFullParameter_doc
+"Set the full parameters of the covariance function.
+
+Parameters
+----------
+parameter : :class:`~openturns.Point`
+    List the full parameter of the covariance function i.e.
+    scale parameter :math:`\vect{\theta} \in \Rset^n`, the
+    the amplitude parameter :math:`\vect{\sigma} \in \Rset^d`,
+    the Spatial correlation parameter  :math:`\mat{R} \in \cS_d^+([-1,1])`;
+    and potential other parameter depending on the model;
+
+    Must be at least of dimension :math:`n+\frac{d(d+1)}{2}`."
+%enddef
+%feature("docstring") OT::CovarianceModelImplementation::setFullParameter
+OT_CovarianceModel_setFullParameter_doc
+
+// ---------------------------------------------------------------------
+
+%define OT_CovarianceModel_getFullParameter_doc
+"Get the full parameters of the covariance function.
+
+Returns
+-------
+parameter : :class:`~openturns.Point`
+    List the full parameter of the covariance function i.e.
+    scale parameter :math:`\vect{\theta} \in \Rset^n`, the
+    the amplitude parameter :math:`\vect{\sigma} \in \Rset^d`,
+    the Spatial correlation parameter  :math:`\mat{R} \in \cS_d^+([-1,1])`;
+    and potential other parameter depending on the model;
+"
+%enddef
+%feature("docstring") OT::CovarianceModelImplementation::getFullParameter
+OT_CovarianceModel_getFullParameter_doc
+
+// ---------------------------------------------------------------------
+
+%define OT_CovarianceModel_getFullParameterDescription_doc
+"Get the description full parameters of the covariance function.
+
+Returns
+-------
+description : :class:`~openturns.Description`
+    Description of the full parameter of the covariance function.
+"
+%enddef
+%feature("docstring") OT::CovarianceModelImplementation::getFullParameterDescription
+OT_CovarianceModel_getFullParameterDescription_doc
+

python/src/CovarianceModel_doc.i.in

@@ -60,3 +60,9 @@ OT_CovarianceModel_operator_doc
 OT_CovarianceModel_setActiveParameter_doc
 %feature("docstring") OT::CovarianceModel::getActiveParameter
 OT_CovarianceModel_getActiveParameter_doc
+%feature("docstring") OT::CovarianceModel::setFullParameter
+OT_CovarianceModel_setFullParameter_doc
+%feature("docstring") OT::CovarianceModel::getFullParameter
+OT_CovarianceModel_getFullParameter_doc
+%feature("docstring") OT::CovarianceModel::getFullParameterDescription
+OT_CovarianceModel_getFullParameterDescription_doc