src/daComposant/daAlgorithms/ParticleSwarmOptimization.py

   1 #-*-coding:iso-8859-1-*-
   2 #
   3 #  Copyright (C) 2008-2015 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   = 1,
  37             )
  38         self.defineRequiredParameter(
  39             name     = "SetSeed",
  40             typecast = numpy.random.seed,
  41             message  = "Graine fixée pour le générateur aléatoire",
  42             )
  43         self.defineRequiredParameter(
  44             name     = "NumberOfInsects",
  45             default  = 100,
  46             typecast = int,
  47             message  = "Nombre d'insectes dans l'essaim",
  48             minval   = -1,
  49             )
  50         self.defineRequiredParameter(
  51             name     = "SwarmVelocity",
  52             default  = 1.,
  53             typecast = float,
  54             message  = "Vitesse de groupe imposée par l'essaim",
  55             minval   = 0.,
  56             )
  57         self.defineRequiredParameter(
  58             name     = "GroupRecallRate",
  59             default  = 0.5,
  60             typecast = float,
  61             message  = "Taux de rappel au meilleur insecte du groupe (entre 0 et 1)",
  62             minval   = 0.,
  63             maxval   = 1.,
  64             )
  65         self.defineRequiredParameter(
  66             name     = "QualityCriterion",
  67             default  = "AugmentedWeightedLeastSquares",
  68             typecast = str,
  69             message  = "Critère de qualité utilisé",
  70             listval  = ["AugmentedWeightedLeastSquares","AWLS","AugmentedPonderatedLeastSquares","APLS","DA",
  71                         "WeightedLeastSquares","WLS","PonderatedLeastSquares","PLS",
  72                         "LeastSquares","LS","L2",
  73                         "AbsoluteValue","L1",
  74                         "MaximumError","ME"],
  75             )
  76         self.defineRequiredParameter(
  77             name     = "StoreInternalVariables",
  78             default  = False,
  79             typecast = bool,
  80             message  = "Stockage des variables internes ou intermédiaires du calcul",
  81             )
  82         self.defineRequiredParameter(
  83             name     = "StoreSupplementaryCalculations",
  84             default  = [],
  85             typecast = tuple,
  86             message  = "Liste de calculs supplémentaires à stocker et/ou effectuer",
  87             listval  = ["BMA", "OMA", "OMB", "CurrentState", "CostFunctionJ", "Innovation", "SimulatedObservationAtBackground", "SimulatedObservationAtCurrentState", "SimulatedObservationAtOptimum"]
  88             )
  89
  90     def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None):
  91         self._pre_run()
  92         #
  93         # Paramètres de pilotage
  94         # ----------------------
  95         self.setParameters(Parameters)
  96         #
  97         if self._parameters.has_key("BoxBounds") and (type(self._parameters["BoxBounds"]) is type([]) or type(self._parameters["BoxBounds"]) is type(())) and (len(self._parameters["BoxBounds"]) > 0):
  98             BoxBounds = self._parameters["BoxBounds"]
  99             logging.debug("%s Prise en compte des bornes d'incréments de paramètres effectuee"%(self._name,))
 100         else:
 101             raise ValueError("Particle Swarm Optimization requires bounds on all variables to be given.")
 102         BoxBounds   = numpy.array(BoxBounds)
 103         if numpy.isnan(BoxBounds).any():
 104             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)
 105         #
 106         Phig = float( self._parameters["GroupRecallRate"] )
 107         Phip = 1. - Phig
 108         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)))
 109         #
 110         # Opérateur d'observation
 111         # -----------------------
 112         Hm = HO["Direct"].appliedTo
 113         #
 114         # Précalcul des inversions de B et R
 115         # ----------------------------------
 116         BI = B.getI()
 117         RI = R.getI()
 118         #
 119         # Définition de la fonction-coût
 120         # ------------------------------
 121         def CostFunction(x, QualityMeasure="AugmentedWeightedLeastSquares"):
 122             _X  = numpy.asmatrix(numpy.ravel( x )).T
 123             _HX = Hm( _X )
 124             _HX = numpy.asmatrix(numpy.ravel( _HX )).T
 125             #
 126             if QualityMeasure in ["AugmentedWeightedLeastSquares","AWLS","AugmentedPonderatedLeastSquares","APLS","DA"]:
 127                 if BI is None or RI is None:
 128                     raise ValueError("Background and Observation error covariance matrix has to be properly defined!")
 129                 Jb  = 0.5 * (_X - Xb).T * BI * (_X - Xb)
 130                 Jo  = 0.5 * (Y - _HX).T * RI * (Y - _HX)
 131             elif QualityMeasure in ["WeightedLeastSquares","WLS","PonderatedLeastSquares","PLS"]:
 132                 if RI is None:
 133                     raise ValueError("Observation error covariance matrix has to be properly defined!")
 134                 Jb  = 0.
 135                 Jo  = 0.5 * (Y - _HX).T * RI * (Y - _HX)
 136             elif QualityMeasure in ["LeastSquares","LS","L2"]:
 137                 Jb  = 0.
 138                 Jo  = 0.5 * (Y - _HX).T * (Y - _HX)
 139             elif QualityMeasure in ["AbsoluteValue","L1"]:
 140                 Jb  = 0.
 141                 Jo  = numpy.sum( numpy.abs(Y - _HX) )
 142             elif QualityMeasure in ["MaximumError","ME"]:
 143                 Jb  = 0.
 144                 Jo  = numpy.max( numpy.abs(Y - _HX) )
 145             #
 146             J   = float( Jb ) + float( Jo )
 147             #
 148             return J
 149         #
 150         # Point de démarrage de l'optimisation : Xini = Xb
 151         # ------------------------------------
 152         if type(Xb) is type(numpy.matrix([])):
 153             Xini = Xb.A1.tolist()
 154         elif Xb is not None:
 155             Xini = list(Xb)
 156         else:
 157             Xini = numpy.zeros(len(BoxBounds[:,0]))
 158         #
 159         # Initialisation des bornes
 160         # -------------------------
 161         SpaceUp  = BoxBounds[:,1] + Xini
 162         SpaceLow = BoxBounds[:,0] + Xini
 163         nbparam  = len(SpaceUp)
 164         #
 165         # Initialisation de l'essaim
 166         # --------------------------
 167         LimitVelocity = numpy.abs(SpaceUp-SpaceLow)
 168         #
 169         PosInsect = []
 170         VelocityInsect = []
 171         for i in range(nbparam) :
 172             PosInsect.append(numpy.random.uniform(low=SpaceLow[i], high=SpaceUp[i], size=self._parameters["NumberOfInsects"]))
 173             VelocityInsect.append(numpy.random.uniform(low=-LimitVelocity[i], high=LimitVelocity[i], size=self._parameters["NumberOfInsects"]))
 174         VelocityInsect = numpy.matrix(VelocityInsect)
 175         PosInsect = numpy.matrix(PosInsect)
 176         #
 177         BestPosInsect = numpy.array(PosInsect)
 178         qBestPosInsect = []
 179         Best = copy.copy(SpaceLow)
 180         qBest = CostFunction(Best,self._parameters["QualityCriterion"])
 181         #
 182         for i in range(self._parameters["NumberOfInsects"]):
 183             insect  = numpy.ravel(PosInsect[:,i])
 184             quality = CostFunction(insect,self._parameters["QualityCriterion"])
 185             qBestPosInsect.append(quality)
 186             if quality < qBest:
 187                 Best  = copy.copy( insect )
 188                 qBest = copy.copy( quality )
 189         logging.debug("%s Initialisation, Insecte = %s, Qualité = %s"%(self._name, str(Best), str(qBest)))
 190         #
 191         if self._parameters["StoreInternalVariables"] or "CurrentState" in self._parameters["StoreSupplementaryCalculations"]:
 192             self.StoredVariables["CurrentState"].store( Best )
 193         self.StoredVariables["CostFunctionJb"].store( 0. )
 194         self.StoredVariables["CostFunctionJo"].store( 0. )
 195         self.StoredVariables["CostFunctionJ" ].store( qBest )
 196         #
 197         # Minimisation de la fonctionnelle
 198         # --------------------------------
 199         for n in range(self._parameters["MaximumNumberOfSteps"]):
 200             for i in range(self._parameters["NumberOfInsects"]) :
 201                 insect  = numpy.ravel(PosInsect[:,i])
 202                 rp = numpy.random.uniform(size=nbparam)
 203                 rg = numpy.random.uniform(size=nbparam)
 204                 for j in range(nbparam) :
 205                     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])
 206                     PosInsect[j,i] = PosInsect[j,i]+VelocityInsect[j,i]
 207                 quality = CostFunction(insect,self._parameters["QualityCriterion"])
 208                 if quality < qBestPosInsect[i]:
 209                     BestPosInsect[:,i] = copy.copy( insect )
 210                     qBestPosInsect[i]  = copy.copy( quality )
 211                     if quality < qBest :
 212                         Best  = copy.copy( insect )
 213                         qBest = copy.copy( quality )
 214             logging.debug("%s Etape %i, Insecte = %s, Qualité = %s"%(self._name, n, str(Best), str(qBest)))
 215             #
 216             if self._parameters["StoreInternalVariables"] or "CurrentState" in self._parameters["StoreSupplementaryCalculations"]:
 217                 self.StoredVariables["CurrentState"].store( Best )
 218             if "SimulatedObservationAtCurrentState" in self._parameters["StoreSupplementaryCalculations"]:
 219                 _HmX = Hm( numpy.asmatrix(numpy.ravel( Best )).T )
 220                 _HmX = numpy.asmatrix(numpy.ravel( _HmX )).T
 221                 self.StoredVariables["SimulatedObservationAtCurrentState"].store( _HmX )
 222             self.StoredVariables["CostFunctionJb"].store( 0. )
 223             self.StoredVariables["CostFunctionJo"].store( 0. )
 224             self.StoredVariables["CostFunctionJ" ].store( qBest )
 225         #
 226         # Obtention de l'analyse
 227         # ----------------------
 228         Xa = numpy.asmatrix(numpy.ravel( Best )).T
 229         #
 230         self.StoredVariables["Analysis"].store( Xa.A1 )
 231         #
 232         if "Innovation"                       in self._parameters["StoreSupplementaryCalculations"] or \
 233            "OMB"                              in self._parameters["StoreSupplementaryCalculations"] or \
 234            "SimulatedObservationAtBackground" in self._parameters["StoreSupplementaryCalculations"]:
 235             HXb = Hm(Xb)
 236             d = Y - HXb
 237         if "OMA"                           in self._parameters["StoreSupplementaryCalculations"] or \
 238            "SimulatedObservationAtOptimum" in self._parameters["StoreSupplementaryCalculations"]:
 239             HXa = Hm(Xa)
 240         #
 241         # Calculs et/ou stockages supplémentaires
 242         # ---------------------------------------
 243         if "Innovation" in self._parameters["StoreSupplementaryCalculations"]:
 244             self.StoredVariables["Innovation"].store( numpy.ravel(d) )
 245         if "BMA" in self._parameters["StoreSupplementaryCalculations"]:
 246             self.StoredVariables["BMA"].store( numpy.ravel(Xb) - numpy.ravel(Xa) )
 247         if "OMA" in self._parameters["StoreSupplementaryCalculations"]:
 248             self.StoredVariables["OMA"].store( numpy.ravel(Y) - numpy.ravel(HXa) )
 249         if "OMB" in self._parameters["StoreSupplementaryCalculations"]:
 250             self.StoredVariables["OMB"].store( numpy.ravel(d) )
 251         if "SimulatedObservationAtBackground" in self._parameters["StoreSupplementaryCalculations"]:
 252             self.StoredVariables["SimulatedObservationAtBackground"].store( numpy.ravel(HXb) )
 253         if "SimulatedObservationAtOptimum" in self._parameters["StoreSupplementaryCalculations"]:
 254             self.StoredVariables["SimulatedObservationAtOptimum"].store( numpy.ravel(HXa) )
 255         #
 256         self._post_run(HO)
 257         return 0
 258
 259 # ==============================================================================
 260 if __name__ == "__main__":
 261     print '\n AUTODIAGNOSTIC \n'