Salome HOME
Improving warning message for available DFO minimizer choice
[modules/adao.git] / src / daComposant / daAlgorithms / TabuSearch.py
index 415800da4f2c0eb7771342e8fef4db6a4ab53470..23a6c85852ca04a84bfdde1f7d46c7ea44acea5b 100644 (file)
@@ -1,6 +1,6 @@
-#-*-coding:iso-8859-1-*-
+# -*- coding: utf-8 -*-
 #
-# Copyright (C) 2008-2017 EDF R&D
+# Copyright (C) 2008-2018 EDF R&D
 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
@@ -38,7 +38,7 @@ class ElementaryAlgorithm(BasicObjects.Algorithm):
         self.defineRequiredParameter(
             name     = "SetSeed",
             typecast = numpy.random.seed,
-            message  = "Graine fixée pour le générateur aléatoire",
+            message  = "Graine fixée pour le générateur aléatoire",
             )
         self.defineRequiredParameter(
             name     = "LengthOfTabuList",
@@ -51,21 +51,21 @@ class ElementaryAlgorithm(BasicObjects.Algorithm):
             name     = "NumberOfElementaryPerturbations",
             default  = 1,
             typecast = int,
-            message  = "Nombre de perturbations élémentaires pour choisir une perturbation d'état",
+            message  = "Nombre de perturbations élémentaires pour choisir une perturbation d'état",
             minval   = 1,
             )
         self.defineRequiredParameter(
             name     = "NoiseDistribution",
             default  = "Uniform",
             typecast = str,
-            message  = "Distribution pour générer les perturbations d'état",
+            message  = "Distribution pour générer les perturbations d'état",
             listval  = ["Gaussian","Uniform"],
             )
         self.defineRequiredParameter(
             name     = "QualityCriterion",
             default  = "AugmentedWeightedLeastSquares",
             typecast = str,
-            message  = "Critère de qualité utilisé",
+            message  = "Critère de qualité utilisé",
             listval  = ["AugmentedWeightedLeastSquares","AWLS","DA",
                         "WeightedLeastSquares","WLS",
                         "LeastSquares","LS","L2",
@@ -76,19 +76,19 @@ class ElementaryAlgorithm(BasicObjects.Algorithm):
             name     = "NoiseHalfRange",
             default  = [],
             typecast = numpy.matrix,
-            message  = "Demi-amplitude des perturbations uniformes centrées d'état pour chaque composante de l'état",
+            message  = "Demi-amplitude des perturbations uniformes centrées d'état pour chaque composante de l'état",
             )
         self.defineRequiredParameter(
             name     = "StandardDeviation",
             default  = [],
             typecast = numpy.matrix,
-            message  = "Ecart-type des perturbations gaussiennes d'état pour chaque composante de l'état",
+            message  = "Ecart-type des perturbations gaussiennes d'état pour chaque composante de l'état",
             )
         self.defineRequiredParameter(
             name     = "NoiseAddingProbability",
             default  = 1.,
             typecast = float,
-            message  = "Probabilité de perturbation d'une composante de l'état",
+            message  = "Probabilité de perturbation d'une composante de l'état",
             minval   = 0.,
             maxval   = 1.,
             )
@@ -96,22 +96,25 @@ class ElementaryAlgorithm(BasicObjects.Algorithm):
             name     = "StoreInternalVariables",
             default  = False,
             typecast = bool,
-            message  = "Stockage des variables internes ou intermédiaires du calcul",
+            message  = "Stockage des variables internes ou intermédiaires du calcul",
             )
         self.defineRequiredParameter(
             name     = "StoreSupplementaryCalculations",
             default  = [],
             typecast = tuple,
-            message  = "Liste de calculs supplémentaires à stocker et/ou effectuer",
+            message  = "Liste de calculs supplémentaires à stocker et/ou effectuer",
             listval  = ["BMA", "OMA", "OMB", "CurrentState", "CostFunctionJ", "CostFunctionJb", "CostFunctionJo", "Innovation", "SimulatedObservationAtBackground", "SimulatedObservationAtCurrentState", "SimulatedObservationAtOptimum"]
             )
         self.defineRequiredParameter( # Pas de type
             name     = "Bounds",
             message  = "Liste des valeurs de bornes",
             )
+        self.requireInputArguments(
+            mandatory= ("Xb", "Y", "HO", "R", "B"),
+            )
 
     def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None):
-        self._pre_run(Parameters)
+        self._pre_run(Parameters, Xb, Y, R, B, Q)
         #
         if self._parameters["NoiseDistribution"] == "Uniform":
             nrange = numpy.ravel(self._parameters["NoiseHalfRange"]) # Vecteur
@@ -122,16 +125,16 @@ class ElementaryAlgorithm(BasicObjects.Algorithm):
             if sigma.size != Xb.size:
                 raise ValueError("Noise generation by Gaussian distribution requires standard deviation for all variable increments. The actual standard deviation vector is:\n%s"%sigma)
         #
-        # Opérateur d'observation
+        # Opérateur d'observation
         # -----------------------
         Hm = HO["Direct"].appliedTo
         #
-        # Précalcul des inversions de B et R
+        # Précalcul des inversions de B et R
         # ----------------------------------
         BI = B.getI()
         RI = R.getI()
         #
-        # Définition de la fonction de deplacement
+        # Définition de la fonction de deplacement
         # ----------------------------------------
         def Tweak( x, NoiseDistribution, NoiseAddingProbability ):
             _X  = numpy.matrix(numpy.ravel( x )).T
@@ -139,13 +142,13 @@ class ElementaryAlgorithm(BasicObjects.Algorithm):
                 for i in range(_X.size):
                     if NoiseAddingProbability >= numpy.random.uniform():
                         _increment = numpy.random.uniform(low=-nrange[i], high=nrange[i])
-                        # On ne traite pas encore le dépassement des bornes ici
+                        # On ne traite pas encore le dépassement des bornes ici
                         _X[i] += _increment
             elif NoiseDistribution == "Gaussian":
                 for i in range(_X.size):
                     if NoiseAddingProbability >= numpy.random.uniform():
                         _increment = numpy.random.normal(loc=0., scale=sigma[i])
-                        # On ne traite pas encore le dépassement des bornes ici
+                        # On ne traite pas encore le dépassement des bornes ici
                         _X[i] += _increment
             #
             return _X
@@ -199,7 +202,7 @@ class ElementaryAlgorithm(BasicObjects.Algorithm):
                 )
             for nbt in range(self._parameters["NumberOfElementaryPerturbations"]-1):
                 _W = Tweak( _S, self._parameters["NoiseDistribution"], self._parameters["NoiseAddingProbability"] )
-                # _qualityW = CostFunction( _W, self._parameters["QualityCriterion"] )
+                # _qualityW = CostFunction( _W, self._parameters["QualityCriterion"] )
                 _qualityW = BasicObjects.CostFunction3D(
                            _W,
                     _Hm  = Hm,
@@ -245,7 +248,7 @@ class ElementaryAlgorithm(BasicObjects.Algorithm):
            "SimulatedObservationAtOptimum" in self._parameters["StoreSupplementaryCalculations"]:
             HXa = Hm(Xa)
         #
-        # Calculs et/ou stockages supplémentaires
+        # Calculs et/ou stockages supplémentaires
         # ---------------------------------------
         if "Innovation" in self._parameters["StoreSupplementaryCalculations"]:
             self.StoredVariables["Innovation"].store( numpy.ravel(d) )