src/daComposant/daAlgorithms/ParticleSwarmOptimization.py

   1 # -*- coding: utf-8 -*-
   2 #
   3 # Copyright (C) 2008-2019 EDF R&D
   4 #
   5 # This library is free software; you can redistribute it and/or
   6 # modify it under the terms of the GNU Lesser General Public
   7 # License as published by the Free Software Foundation; either
   8 # version 2.1 of the License.
   9 #
  10 # This library is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 # Lesser General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU Lesser General Public
  16 # License along with this library; if not, write to the Free Software
  17 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  18 #
  19 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  20 #
  21 # Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D
  22
  23 import logging
  24 from daCore import BasicObjects
  25 import numpy, copy
  26
  27 # ==============================================================================
  28 class ElementaryAlgorithm(BasicObjects.Algorithm):
  29     def __init__(self):
  30         BasicObjects.Algorithm.__init__(self, "PARTICLESWARMOPTIMIZATION")
  31         self.defineRequiredParameter(
  32             name     = "MaximumNumberOfSteps",
  33             default  = 50,
  34             typecast = int,
  35             message  = "Nombre maximal de pas d'optimisation",
  36             minval   = 0,
  37             )
  38         self.defineRequiredParameter(
  39             name     = "MaximumNumberOfFunctionEvaluations",
  40             default  = 15000,
  41             typecast = int,
  42             message  = "Nombre maximal d'évaluations de la fonction",
  43             minval   = -1,
  44             )
  45         self.defineRequiredParameter(
  46             name     = "SetSeed",
  47             typecast = numpy.random.seed,
  48             message  = "Graine fixée pour le générateur aléatoire",
  49             )
  50         self.defineRequiredParameter(
  51             name     = "NumberOfInsects",
  52             default  = 100,
  53             typecast = int,
  54             message  = "Nombre d'insectes dans l'essaim",
  55             minval   = -1,
  56             )
  57         self.defineRequiredParameter(
  58             name     = "SwarmVelocity",
  59             default  = 1.,
  60             typecast = float,
  61             message  = "Vitesse de groupe imposée par l'essaim",
  62             minval   = 0.,
  63             )
  64         self.defineRequiredParameter(
  65             name     = "GroupRecallRate",
  66             default  = 0.5,
  67             typecast = float,
  68             message  = "Taux de rappel au meilleur insecte du groupe (entre 0 et 1)",
  69             minval   = 0.,
  70             maxval   = 1.,
  71             )
  72         self.defineRequiredParameter(
  73             name     = "QualityCriterion",
  74             default  = "AugmentedWeightedLeastSquares",
  75             typecast = str,
  76             message  = "Critère de qualité utilisé",
  77             listval  = ["AugmentedWeightedLeastSquares","AWLS","AugmentedPonderatedLeastSquares","APLS","DA",
  78                         "WeightedLeastSquares","WLS","PonderatedLeastSquares","PLS",
  79                         "LeastSquares","LS","L2",
  80                         "AbsoluteValue","L1",
  81                         "MaximumError","ME"],
  82             )
  83         self.defineRequiredParameter(
  84             name     = "StoreInternalVariables",
  85             default  = False,
  86             typecast = bool,
  87             message  = "Stockage des variables internes ou intermédiaires du calcul",
  88             )
  89         self.defineRequiredParameter(
  90             name     = "StoreSupplementaryCalculations",
  91             default  = [],
  92             typecast = tuple,
  93             message  = "Liste de calculs supplémentaires à stocker et/ou effectuer",
  94             listval  = [
  95                 "Analysis",
  96                 "BMA",
  97                 "CurrentState",
  98                 "CostFunctionJ",
  99                 "CostFunctionJb",
 100                 "CostFunctionJo",
 101                 "Innovation",
 102                 "OMA",
 103                 "OMB",
 104                 "SimulatedObservationAtBackground",
 105                 "SimulatedObservationAtCurrentState",
 106                 "SimulatedObservationAtOptimum",
 107                 ]
 108             )
 109         self.defineRequiredParameter( # Pas de type
 110             name     = "BoxBounds",
 111             message  = "Liste des valeurs de bornes d'incréments de paramètres",
 112             )
 113         self.requireInputArguments(
 114             mandatory= ("Xb", "Y", "HO", "R", "B"),
 115             )
 116
 117     def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None):
 118         self._pre_run(Parameters, Xb, Y, R, B, Q)
 119         #
 120         if ("BoxBounds" in self._parameters) and isinstance(self._parameters["BoxBounds"], (list, tuple)) and (len(self._parameters["BoxBounds"]) > 0):
 121             BoxBounds = self._parameters["BoxBounds"]
 122             logging.debug("%s Prise en compte des bornes d'incréments de paramètres effectuee"%(self._name,))
 123         else:
 124             raise ValueError("Particle Swarm Optimization requires bounds on all variables to be given.")
 125         BoxBounds   = numpy.array(BoxBounds)
 126         if numpy.isnan(BoxBounds).any():
 127             raise ValueError("Particle Swarm Optimization requires bounds on all variables increments to be truly given, \"None\" is not allowed. The actual increments bounds are:\n%s"%BoxBounds)
 128         #
 129         Phig = float( self._parameters["GroupRecallRate"] )
 130         Phip = 1. - Phig
 131         logging.debug("%s Taux de rappel au meilleur insecte du groupe (entre 0 et 1) = %s et à la meilleure position précédente (son complémentaire à 1) = %s"%(self._name, str(Phig), str(Phip)))
 132         #
 133         # Opérateur d'observation
 134         # -----------------------
 135         Hm = HO["Direct"].appliedTo
 136         #
 137         # Précalcul des inversions de B et R
 138         # ----------------------------------
 139         BI = B.getI()
 140         RI = R.getI()
 141         #
 142         # Définition de la fonction-coût
 143         # ------------------------------
 144         def CostFunction(x, QualityMeasure="AugmentedWeightedLeastSquares"):
 145             _X  = numpy.asmatrix(numpy.ravel( x )).T
 146             _HX = Hm( _X )
 147             _HX = numpy.asmatrix(numpy.ravel( _HX )).T
 148             #
 149             if QualityMeasure in ["AugmentedWeightedLeastSquares","AWLS","AugmentedPonderatedLeastSquares","APLS","DA"]:
 150                 if BI is None or RI is None:
 151                     raise ValueError("Background and Observation error covariance matrix has to be properly defined!")
 152                 Jb  = 0.5 * (_X - Xb).T * BI * (_X - Xb)
 153                 Jo  = 0.5 * (Y - _HX).T * RI * (Y - _HX)
 154             elif QualityMeasure in ["WeightedLeastSquares","WLS","PonderatedLeastSquares","PLS"]:
 155                 if RI is None:
 156                     raise ValueError("Observation error covariance matrix has to be properly defined!")
 157                 Jb  = 0.
 158                 Jo  = 0.5 * (Y - _HX).T * RI * (Y - _HX)
 159             elif QualityMeasure in ["LeastSquares","LS","L2"]:
 160                 Jb  = 0.
 161                 Jo  = 0.5 * (Y - _HX).T * (Y - _HX)
 162             elif QualityMeasure in ["AbsoluteValue","L1"]:
 163                 Jb  = 0.
 164                 Jo  = numpy.sum( numpy.abs(Y - _HX) )
 165             elif QualityMeasure in ["MaximumError","ME"]:
 166                 Jb  = 0.
 167                 Jo  = numpy.max( numpy.abs(Y - _HX) )
 168             #
 169             J   = float( Jb ) + float( Jo )
 170             #
 171             return J
 172         #
 173         # Point de démarrage de l'optimisation : Xini = Xb
 174         # ------------------------------------
 175         if isinstance(Xb, type(numpy.matrix([]))):
 176             Xini = Xb.A1.tolist()
 177         elif Xb is not None:
 178             Xini = list(Xb)
 179         else:
 180             Xini = numpy.zeros(len(BoxBounds[:,0]))
 181         #
 182         # Initialisation des bornes
 183         # -------------------------
 184         SpaceUp  = BoxBounds[:,1] + Xini
 185         SpaceLow = BoxBounds[:,0] + Xini
 186         nbparam  = len(SpaceUp)
 187         #
 188         # Initialisation de l'essaim
 189         # --------------------------
 190         NumberOfFunctionEvaluations = 0
 191         LimitVelocity = numpy.abs(SpaceUp-SpaceLow)
 192         #
 193         PosInsect = []
 194         VelocityInsect = []
 195         for i in range(nbparam) :
 196             PosInsect.append(numpy.random.uniform(low=SpaceLow[i], high=SpaceUp[i], size=self._parameters["NumberOfInsects"]))
 197             VelocityInsect.append(numpy.random.uniform(low=-LimitVelocity[i], high=LimitVelocity[i], size=self._parameters["NumberOfInsects"]))
 198         VelocityInsect = numpy.matrix(VelocityInsect)
 199         PosInsect = numpy.matrix(PosInsect)
 200         #
 201         BestPosInsect = numpy.array(PosInsect)
 202         qBestPosInsect = []
 203         Best = copy.copy(SpaceLow)
 204         qBest = CostFunction(Best,self._parameters["QualityCriterion"])
 205         NumberOfFunctionEvaluations += 1
 206         #
 207         for i in range(self._parameters["NumberOfInsects"]):
 208             insect  = numpy.ravel(PosInsect[:,i])
 209             quality = CostFunction(insect,self._parameters["QualityCriterion"])
 210             NumberOfFunctionEvaluations += 1
 211             qBestPosInsect.append(quality)
 212             if quality < qBest:
 213                 Best  = copy.copy( insect )
 214                 qBest = copy.copy( quality )
 215         logging.debug("%s Initialisation, Insecte = %s, Qualité = %s"%(self._name, str(Best), str(qBest)))
 216         #
 217         if self._parameters["StoreInternalVariables"] or self._toStore("CurrentState"):
 218             self.StoredVariables["CurrentState"].store( Best )
 219         self.StoredVariables["CostFunctionJb"].store( 0. )
 220         self.StoredVariables["CostFunctionJo"].store( 0. )
 221         self.StoredVariables["CostFunctionJ" ].store( qBest )
 222         #
 223         # Minimisation de la fonctionnelle
 224         # --------------------------------
 225         for n in range(self._parameters["MaximumNumberOfSteps"]):
 226             for i in range(self._parameters["NumberOfInsects"]) :
 227                 insect  = numpy.ravel(PosInsect[:,i])
 228                 rp = numpy.random.uniform(size=nbparam)
 229                 rg = numpy.random.uniform(size=nbparam)
 230                 for j in range(nbparam) :
 231                     VelocityInsect[j,i] = self._parameters["SwarmVelocity"]*VelocityInsect[j,i] +  Phip*rp[j]*(BestPosInsect[j,i]-PosInsect[j,i]) +  Phig*rg[j]*(Best[j]-PosInsect[j,i])
 232                     PosInsect[j,i] = PosInsect[j,i]+VelocityInsect[j,i]
 233                 quality = CostFunction(insect,self._parameters["QualityCriterion"])
 234                 NumberOfFunctionEvaluations += 1
 235                 if quality < qBestPosInsect[i]:
 236                     BestPosInsect[:,i] = copy.copy( insect )
 237                     qBestPosInsect[i]  = copy.copy( quality )
 238                     if quality < qBest :
 239                         Best  = copy.copy( insect )
 240                         qBest = copy.copy( quality )
 241             logging.debug("%s Etape %i, Insecte = %s, Qualité = %s"%(self._name, n, str(Best), str(qBest)))
 242             #
 243             if self._parameters["StoreInternalVariables"] or self._toStore("CurrentState"):
 244                 self.StoredVariables["CurrentState"].store( Best )
 245             if self._toStore("SimulatedObservationAtCurrentState"):
 246                 _HmX = Hm( numpy.asmatrix(numpy.ravel( Best )).T )
 247                 _HmX = numpy.asmatrix(numpy.ravel( _HmX )).T
 248                 self.StoredVariables["SimulatedObservationAtCurrentState"].store( _HmX )
 249             self.StoredVariables["CostFunctionJb"].store( 0. )
 250             self.StoredVariables["CostFunctionJo"].store( 0. )
 251             self.StoredVariables["CostFunctionJ" ].store( qBest )
 252             if NumberOfFunctionEvaluations > self._parameters["MaximumNumberOfFunctionEvaluations"]:
 253                 logging.debug("%s Stopping search because the number %i of function evaluations is exceeding the maximum %i."%(self._name, NumberOfFunctionEvaluations, self._parameters["MaximumNumberOfFunctionEvaluations"]))
 254                 break
 255         #
 256         # Obtention de l'analyse
 257         # ----------------------
 258         Xa = numpy.asmatrix(numpy.ravel( Best )).T
 259         #
 260         self.StoredVariables["Analysis"].store( Xa.A1 )
 261         #
 262         if self._toStore("Innovation") or \
 263             self._toStore("OMB") or \
 264             self._toStore("SimulatedObservationAtBackground"):
 265             HXb = Hm(Xb)
 266             d = Y - HXb
 267         if self._toStore("OMA") or \
 268             self._toStore("SimulatedObservationAtOptimum"):
 269             HXa = Hm(Xa)
 270         #
 271         # Calculs et/ou stockages supplémentaires
 272         # ---------------------------------------
 273         if self._toStore("Innovation"):
 274             self.StoredVariables["Innovation"].store( numpy.ravel(d) )
 275         if self._toStore("BMA"):
 276             self.StoredVariables["BMA"].store( numpy.ravel(Xb) - numpy.ravel(Xa) )
 277         if self._toStore("OMA"):
 278             self.StoredVariables["OMA"].store( numpy.ravel(Y) - numpy.ravel(HXa) )
 279         if self._toStore("OMB"):
 280             self.StoredVariables["OMB"].store( numpy.ravel(d) )
 281         if self._toStore("SimulatedObservationAtBackground"):
 282             self.StoredVariables["SimulatedObservationAtBackground"].store( numpy.ravel(HXb) )
 283         if self._toStore("SimulatedObservationAtOptimum"):
 284             self.StoredVariables["SimulatedObservationAtOptimum"].store( numpy.ravel(HXa) )
 285         #
 286         self._post_run(HO)
 287         return 0
 288
 289 # ==============================================================================
 290 if __name__ == "__main__":
 291     print('\n AUTODIAGNOSTIC \n')