src/daComposant/daCore/BasicObjects.py

   1 # -*- coding: utf-8 -*-
   2 #
   3 # Copyright (C) 2008-2021 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 """
  24     Définit les outils généraux élémentaires.
  25 """
  26 __author__ = "Jean-Philippe ARGAUD"
  27 __all__ = []
  28
  29 import os
  30 import sys
  31 import logging
  32 import copy
  33 import time
  34 import numpy
  35 from functools import partial
  36 from daCore import Persistence, PlatformInfo, Interfaces
  37 from daCore import Templates
  38
  39 # ==============================================================================
  40 class CacheManager(object):
  41     """
  42     Classe générale de gestion d'un cache de calculs
  43     """
  44     def __init__(self,
  45                  toleranceInRedundancy = 1.e-18,
  46                  lenghtOfRedundancy    = -1,
  47                 ):
  48         """
  49         Les caractéristiques de tolérance peuvent être modifiées à la création.
  50         """
  51         self.__tolerBP   = float(toleranceInRedundancy)
  52         self.__lenghtOR  = int(lenghtOfRedundancy)
  53         self.__initlnOR  = self.__lenghtOR
  54         self.__seenNames = []
  55         self.__enabled   = True
  56         self.clearCache()
  57
  58     def clearCache(self):
  59         "Vide le cache"
  60         self.__listOPCV  = []
  61         self.__seenNames = []
  62
  63     def wasCalculatedIn(self, xValue, oName="" ):
  64         "Vérifie l'existence d'un calcul correspondant à la valeur"
  65         __alc = False
  66         __HxV = None
  67         if self.__enabled:
  68             for i in range(min(len(self.__listOPCV),self.__lenghtOR)-1,-1,-1):
  69                 if not hasattr(xValue, 'size'):
  70                     pass
  71                 elif (str(oName) != self.__listOPCV[i][3]):
  72                     pass
  73                 elif (xValue.size != self.__listOPCV[i][0].size):
  74                     pass
  75                 elif (numpy.ravel(xValue)[0] - self.__listOPCV[i][0][0]) > (self.__tolerBP * self.__listOPCV[i][2] / self.__listOPCV[i][0].size):
  76                     pass
  77                 elif numpy.linalg.norm(numpy.ravel(xValue) - self.__listOPCV[i][0]) < (self.__tolerBP * self.__listOPCV[i][2]):
  78                     __alc  = True
  79                     __HxV = self.__listOPCV[i][1]
  80                     break
  81         return __alc, __HxV
  82
  83     def storeValueInX(self, xValue, HxValue, oName="" ):
  84         "Stocke pour un opérateur o un calcul Hx correspondant à la valeur x"
  85         if self.__lenghtOR < 0:
  86             self.__lenghtOR = 2 * min(xValue.size, 50) + 2 # 2 * xValue.size + 2
  87             self.__initlnOR = self.__lenghtOR
  88             self.__seenNames.append(str(oName))
  89         if str(oName) not in self.__seenNames: # Etend la liste si nouveau
  90             self.__lenghtOR += 2 * min(xValue.size, 50) + 2 # 2 * xValue.size + 2
  91             self.__initlnOR += self.__lenghtOR
  92             self.__seenNames.append(str(oName))
  93         while len(self.__listOPCV) > self.__lenghtOR:
  94             self.__listOPCV.pop(0)
  95         self.__listOPCV.append( (
  96             copy.copy(numpy.ravel(xValue)), # 0 Previous point
  97             copy.copy(HxValue),             # 1 Previous value
  98             numpy.linalg.norm(xValue),      # 2 Norm
  99             str(oName),                     # 3 Operator name
 100             ) )
 101
 102     def disable(self):
 103         "Inactive le cache"
 104         self.__initlnOR = self.__lenghtOR
 105         self.__lenghtOR = 0
 106         self.__enabled  = False
 107
 108     def enable(self):
 109         "Active le cache"
 110         self.__lenghtOR = self.__initlnOR
 111         self.__enabled  = True
 112
 113 # ==============================================================================
 114 class Operator(object):
 115     """
 116     Classe générale d'interface de type opérateur simple
 117     """
 118     NbCallsAsMatrix = 0
 119     NbCallsAsMethod = 0
 120     NbCallsOfCached = 0
 121     CM = CacheManager()
 122     #
 123     def __init__(self,
 124         name                 = "GenericOperator",
 125         fromMethod           = None,
 126         fromMatrix           = None,
 127         avoidingRedundancy   = True,
 128         inputAsMultiFunction = False,
 129         enableMultiProcess   = False,
 130         extraArguments       = None,
 131         ):
 132         """
 133         On construit un objet de ce type en fournissant, à l'aide de l'un des
 134         deux mots-clé, soit une fonction ou un multi-fonction python, soit une
 135         matrice.
 136         Arguments :
 137         - name : nom d'opérateur
 138         - fromMethod : argument de type fonction Python
 139         - fromMatrix : argument adapté au constructeur numpy.matrix
 140         - avoidingRedundancy : booléen évitant (ou pas) les calculs redondants
 141         - inputAsMultiFunction : booléen indiquant une fonction explicitement
 142           définie (ou pas) en multi-fonction
 143         - extraArguments : arguments supplémentaires passés à la fonction de
 144           base et ses dérivées (tuple ou dictionnaire)
 145         """
 146         self.__name      = str(name)
 147         self.__NbCallsAsMatrix, self.__NbCallsAsMethod, self.__NbCallsOfCached = 0, 0, 0
 148         self.__AvoidRC   = bool( avoidingRedundancy )
 149         self.__inputAsMF = bool( inputAsMultiFunction )
 150         self.__mpEnabled = bool( enableMultiProcess )
 151         self.__extraArgs = extraArguments
 152         if   fromMethod is not None and self.__inputAsMF:
 153             self.__Method = fromMethod # logtimer(fromMethod)
 154             self.__Matrix = None
 155             self.__Type   = "Method"
 156         elif fromMethod is not None and not self.__inputAsMF:
 157             self.__Method = partial( MultiFonction, _sFunction=fromMethod, _mpEnabled=self.__mpEnabled)
 158             self.__Matrix = None
 159             self.__Type   = "Method"
 160         elif fromMatrix is not None:
 161             self.__Method = None
 162             self.__Matrix = numpy.matrix( fromMatrix, numpy.float )
 163             self.__Type   = "Matrix"
 164         else:
 165             self.__Method = None
 166             self.__Matrix = None
 167             self.__Type   = None
 168
 169     def disableAvoidingRedundancy(self):
 170         "Inactive le cache"
 171         Operator.CM.disable()
 172
 173     def enableAvoidingRedundancy(self):
 174         "Active le cache"
 175         if self.__AvoidRC:
 176             Operator.CM.enable()
 177         else:
 178             Operator.CM.disable()
 179
 180     def isType(self):
 181         "Renvoie le type"
 182         return self.__Type
 183
 184     def appliedTo(self, xValue, HValue = None, argsAsSerie = False, returnSerieAsArrayMatrix = False):
 185         """
 186         Permet de restituer le résultat de l'application de l'opérateur à une
 187         série d'arguments xValue. Cette méthode se contente d'appliquer, chaque
 188         argument devant a priori être du bon type.
 189         Arguments :
 190         - les arguments par série sont :
 191             - xValue : argument adapté pour appliquer l'opérateur
 192             - HValue : valeur précalculée de l'opérateur en ce point
 193         - argsAsSerie : indique si les arguments sont une mono ou multi-valeur
 194         """
 195         if argsAsSerie:
 196             _xValue = xValue
 197             _HValue = HValue
 198         else:
 199             _xValue = (xValue,)
 200             if HValue is not None:
 201                 _HValue = (HValue,)
 202             else:
 203                 _HValue = HValue
 204         PlatformInfo.isIterable( _xValue, True, " in Operator.appliedTo" )
 205         #
 206         if _HValue is not None:
 207             assert len(_xValue) == len(_HValue), "Incompatible number of elements in xValue and HValue"
 208             _HxValue = []
 209             for i in range(len(_HValue)):
 210                 _HxValue.append( numpy.asmatrix( numpy.ravel( _HValue[i] ) ).T )
 211                 if self.__AvoidRC:
 212                     Operator.CM.storeValueInX(_xValue[i],_HxValue[-1],self.__name)
 213         else:
 214             _HxValue = []
 215             _xserie = []
 216             _hindex = []
 217             for i, xv in enumerate(_xValue):
 218                 if self.__AvoidRC:
 219                     __alreadyCalculated, __HxV = Operator.CM.wasCalculatedIn(xv,self.__name)
 220                 else:
 221                     __alreadyCalculated = False
 222                 #
 223                 if __alreadyCalculated:
 224                     self.__addOneCacheCall()
 225                     _hv = __HxV
 226                 else:
 227                     if self.__Matrix is not None:
 228                         self.__addOneMatrixCall()
 229                         _xv = numpy.matrix(numpy.ravel(xv)).T
 230                         _hv = self.__Matrix * _xv
 231                     else:
 232                         self.__addOneMethodCall()
 233                         _xserie.append( xv )
 234                         _hindex.append(  i )
 235                         _hv = None
 236                 _HxValue.append( _hv )
 237             #
 238             if len(_xserie)>0 and self.__Matrix is None:
 239                 if self.__extraArgs is None:
 240                     _hserie = self.__Method( _xserie ) # Calcul MF
 241                 else:
 242                     _hserie = self.__Method( _xserie, self.__extraArgs ) # Calcul MF
 243                 if not hasattr(_hserie, "pop"):
 244                     raise TypeError("The user input multi-function doesn't seem to return sequence results, behaving like a mono-function. It has to be checked.")
 245                 for i in _hindex:
 246                     _xv = _xserie.pop(0)
 247                     _hv = _hserie.pop(0)
 248                     _HxValue[i] = _hv
 249                     if self.__AvoidRC:
 250                         Operator.CM.storeValueInX(_xv,_hv,self.__name)
 251         #
 252         if returnSerieAsArrayMatrix:
 253             _HxValue = numpy.stack([numpy.ravel(_hv) for _hv in _HxValue], axis=1)
 254         #
 255         if argsAsSerie: return _HxValue
 256         else:           return _HxValue[-1]
 257
 258     def appliedControledFormTo(self, paires, argsAsSerie = False, returnSerieAsArrayMatrix = False):
 259         """
 260         Permet de restituer le résultat de l'application de l'opérateur à des
 261         paires (xValue, uValue). Cette méthode se contente d'appliquer, son
 262         argument devant a priori être du bon type. Si la uValue est None,
 263         on suppose que l'opérateur ne s'applique qu'à xValue.
 264         Arguments :
 265         - paires : les arguments par paire sont :
 266             - xValue : argument X adapté pour appliquer l'opérateur
 267             - uValue : argument U adapté pour appliquer l'opérateur
 268         - argsAsSerie : indique si l'argument est une mono ou multi-valeur
 269         """
 270         if argsAsSerie: _xuValue = paires
 271         else:           _xuValue = (paires,)
 272         PlatformInfo.isIterable( _xuValue, True, " in Operator.appliedControledFormTo" )
 273         #
 274         if self.__Matrix is not None:
 275             _HxValue = []
 276             for paire in _xuValue:
 277                 _xValue, _uValue = paire
 278                 _xValue = numpy.matrix(numpy.ravel(_xValue)).T
 279                 self.__addOneMatrixCall()
 280                 _HxValue.append( self.__Matrix * _xValue )
 281         else:
 282             _xuArgs = []
 283             for paire in _xuValue:
 284                 _xValue, _uValue = paire
 285                 if _uValue is not None:
 286                     _xuArgs.append( paire )
 287                 else:
 288                     _xuArgs.append( _xValue )
 289             self.__addOneMethodCall( len(_xuArgs) )
 290             if self.__extraArgs is None:
 291                 _HxValue = self.__Method( _xuArgs ) # Calcul MF
 292             else:
 293                 _HxValue = self.__Method( _xuArgs, self.__extraArgs ) # Calcul MF
 294         #
 295         if returnSerieAsArrayMatrix:
 296             _HxValue = numpy.stack([numpy.ravel(_hv) for _hv in _HxValue], axis=1)
 297         #
 298         if argsAsSerie: return _HxValue
 299         else:           return _HxValue[-1]
 300
 301     def appliedInXTo(self, paires, argsAsSerie = False, returnSerieAsArrayMatrix = False):
 302         """
 303         Permet de restituer le résultat de l'application de l'opérateur à une
 304         série d'arguments xValue, sachant que l'opérateur est valable en
 305         xNominal. Cette méthode se contente d'appliquer, son argument devant a
 306         priori être du bon type. Si l'opérateur est linéaire car c'est une
 307         matrice, alors il est valable en tout point nominal et xNominal peut
 308         être quelconque. Il n'y a qu'une seule paire par défaut, et argsAsSerie
 309         permet d'indiquer que l'argument est multi-paires.
 310         Arguments :
 311         - paires : les arguments par paire sont :
 312             - xNominal : série d'arguments permettant de donner le point où
 313               l'opérateur est construit pour être ensuite appliqué
 314             - xValue : série d'arguments adaptés pour appliquer l'opérateur
 315         - argsAsSerie : indique si l'argument est une mono ou multi-valeur
 316         """
 317         if argsAsSerie: _nxValue = paires
 318         else:           _nxValue = (paires,)
 319         PlatformInfo.isIterable( _nxValue, True, " in Operator.appliedInXTo" )
 320         #
 321         if self.__Matrix is not None:
 322             _HxValue = []
 323             for paire in _nxValue:
 324                 _xNominal, _xValue = paire
 325                 _xValue = numpy.matrix(numpy.ravel(_xValue)).T
 326                 self.__addOneMatrixCall()
 327                 _HxValue.append( self.__Matrix * _xValue )
 328         else:
 329             self.__addOneMethodCall( len(_nxValue) )
 330             if self.__extraArgs is None:
 331                 _HxValue = self.__Method( _nxValue ) # Calcul MF
 332             else:
 333                 _HxValue = self.__Method( _nxValue, self.__extraArgs ) # Calcul MF
 334         #
 335         if returnSerieAsArrayMatrix:
 336             _HxValue = numpy.stack([numpy.ravel(_hv) for _hv in _HxValue], axis=1)
 337         #
 338         if argsAsSerie: return _HxValue
 339         else:           return _HxValue[-1]
 340
 341     def asMatrix(self, ValueForMethodForm = "UnknownVoidValue", argsAsSerie = False):
 342         """
 343         Permet de renvoyer l'opérateur sous la forme d'une matrice
 344         """
 345         if self.__Matrix is not None:
 346             self.__addOneMatrixCall()
 347             mValue = [self.__Matrix,]
 348         elif not isinstance(ValueForMethodForm,str) or ValueForMethodForm != "UnknownVoidValue": # Ne pas utiliser "None"
 349             mValue = []
 350             if argsAsSerie:
 351                 self.__addOneMethodCall( len(ValueForMethodForm) )
 352                 for _vfmf in ValueForMethodForm:
 353                     mValue.append( numpy.matrix( self.__Method(((_vfmf, None),)) ) )
 354             else:
 355                 self.__addOneMethodCall()
 356                 mValue = self.__Method(((ValueForMethodForm, None),))
 357         else:
 358             raise ValueError("Matrix form of the operator defined as a function/method requires to give an operating point.")
 359         #
 360         if argsAsSerie: return mValue
 361         else:           return mValue[-1]
 362
 363     def shape(self):
 364         """
 365         Renvoie la taille sous forme numpy si l'opérateur est disponible sous
 366         la forme d'une matrice
 367         """
 368         if self.__Matrix is not None:
 369             return self.__Matrix.shape
 370         else:
 371             raise ValueError("Matrix form of the operator is not available, nor the shape")
 372
 373     def nbcalls(self, which=None):
 374         """
 375         Renvoie les nombres d'évaluations de l'opérateur
 376         """
 377         __nbcalls = (
 378             self.__NbCallsAsMatrix+self.__NbCallsAsMethod,
 379             self.__NbCallsAsMatrix,
 380             self.__NbCallsAsMethod,
 381             self.__NbCallsOfCached,
 382             Operator.NbCallsAsMatrix+Operator.NbCallsAsMethod,
 383             Operator.NbCallsAsMatrix,
 384             Operator.NbCallsAsMethod,
 385             Operator.NbCallsOfCached,
 386             )
 387         if which is None: return __nbcalls
 388         else:             return __nbcalls[which]
 389
 390     def __addOneMatrixCall(self):
 391         "Comptabilise un appel"
 392         self.__NbCallsAsMatrix   += 1 # Decompte local
 393         Operator.NbCallsAsMatrix += 1 # Decompte global
 394
 395     def __addOneMethodCall(self, nb = 1):
 396         "Comptabilise un appel"
 397         self.__NbCallsAsMethod   += nb # Decompte local
 398         Operator.NbCallsAsMethod += nb # Decompte global
 399
 400     def __addOneCacheCall(self):
 401         "Comptabilise un appel"
 402         self.__NbCallsOfCached   += 1 # Decompte local
 403         Operator.NbCallsOfCached += 1 # Decompte global
 404
 405 # ==============================================================================
 406 class FullOperator(object):
 407     """
 408     Classe générale d'interface de type opérateur complet
 409     (Direct, Linéaire Tangent, Adjoint)
 410     """
 411     def __init__(self,
 412                  name             = "GenericFullOperator",
 413                  asMatrix         = None,
 414                  asOneFunction    = None, # 1 Fonction
 415                  asThreeFunctions = None, # 3 Fonctions in a dictionary
 416                  asScript         = None, # 1 or 3 Fonction(s) by script
 417                  asDict           = None, # Parameters
 418                  appliedInX       = None,
 419                  extraArguments   = None,
 420                  avoidRC          = True,
 421                  inputAsMF        = False,# Fonction(s) as Multi-Functions
 422                  scheduledBy      = None,
 423                  toBeChecked      = False,
 424                  ):
 425         ""
 426         self.__name      = str(name)
 427         self.__check     = bool(toBeChecked)
 428         self.__extraArgs = extraArguments
 429         #
 430         self.__FO        = {}
 431         #
 432         __Parameters = {}
 433         if (asDict is not None) and isinstance(asDict, dict):
 434             __Parameters.update( asDict )
 435         # Priorité à EnableMultiProcessingInDerivatives=True
 436         if "EnableMultiProcessing" in __Parameters and __Parameters["EnableMultiProcessing"]:
 437             __Parameters["EnableMultiProcessingInDerivatives"] = True
 438             __Parameters["EnableMultiProcessingInEvaluation"]  = False
 439         if "EnableMultiProcessingInDerivatives"  not in __Parameters:
 440             __Parameters["EnableMultiProcessingInDerivatives"]  = False
 441         if __Parameters["EnableMultiProcessingInDerivatives"]:
 442             __Parameters["EnableMultiProcessingInEvaluation"]  = False
 443         if "EnableMultiProcessingInEvaluation"  not in __Parameters:
 444             __Parameters["EnableMultiProcessingInEvaluation"]  = False
 445         if "withIncrement" in __Parameters: # Temporaire
 446             __Parameters["DifferentialIncrement"] = __Parameters["withIncrement"]
 447         #
 448         if asScript is not None:
 449             __Matrix, __Function = None, None
 450             if asMatrix:
 451                 __Matrix = Interfaces.ImportFromScript(asScript).getvalue( self.__name )
 452             elif asOneFunction:
 453                 __Function = { "Direct":Interfaces.ImportFromScript(asScript).getvalue( "DirectOperator" ) }
 454                 __Function.update({"useApproximatedDerivatives":True})
 455                 __Function.update(__Parameters)
 456             elif asThreeFunctions:
 457                 __Function = {
 458                     "Direct" :Interfaces.ImportFromScript(asScript).getvalue( "DirectOperator" ),
 459                     "Tangent":Interfaces.ImportFromScript(asScript).getvalue( "TangentOperator" ),
 460                     "Adjoint":Interfaces.ImportFromScript(asScript).getvalue( "AdjointOperator" ),
 461                     }
 462                 __Function.update(__Parameters)
 463         else:
 464             __Matrix = asMatrix
 465             if asOneFunction is not None:
 466                 if isinstance(asOneFunction, dict) and "Direct" in asOneFunction:
 467                     if asOneFunction["Direct"] is not None:
 468                         __Function = asOneFunction
 469                     else:
 470                         raise ValueError("The function has to be given in a dictionnary which have 1 key (\"Direct\")")
 471                 else:
 472                     __Function = { "Direct":asOneFunction }
 473                 __Function.update({"useApproximatedDerivatives":True})
 474                 __Function.update(__Parameters)
 475             elif asThreeFunctions is not None:
 476                 if isinstance(asThreeFunctions, dict) and \
 477                    ("Tangent" in asThreeFunctions) and (asThreeFunctions["Tangent"] is not None) and \
 478                    ("Adjoint" in asThreeFunctions) and (asThreeFunctions["Adjoint"] is not None) and \
 479                    (("useApproximatedDerivatives" not in asThreeFunctions) or not bool(asThreeFunctions["useApproximatedDerivatives"])):
 480                     __Function = asThreeFunctions
 481                 elif isinstance(asThreeFunctions, dict) and \
 482                    ("Direct" in asThreeFunctions) and (asThreeFunctions["Direct"] is not None):
 483                     __Function = asThreeFunctions
 484                     __Function.update({"useApproximatedDerivatives":True})
 485                 else:
 486                     raise ValueError("The functions has to be given in a dictionnary which have either 1 key (\"Direct\") or 3 keys (\"Direct\" (optionnal), \"Tangent\" and \"Adjoint\")")
 487                 if "Direct"  not in asThreeFunctions:
 488                     __Function["Direct"] = asThreeFunctions["Tangent"]
 489                 __Function.update(__Parameters)
 490             else:
 491                 __Function = None
 492         #
 493         # if sys.version_info[0] < 3 and isinstance(__Function, dict):
 494         #     for k in ("Direct", "Tangent", "Adjoint"):
 495         #         if k in __Function and hasattr(__Function[k],"__class__"):
 496         #             if type(__Function[k]) is type(self.__init__):
 497         #                 raise TypeError("can't use a class method (%s) as a function for the \"%s\" operator. Use a real function instead."%(type(__Function[k]),k))
 498         #
 499         if   appliedInX is not None and isinstance(appliedInX, dict):
 500             __appliedInX = appliedInX
 501         elif appliedInX is not None:
 502             __appliedInX = {"HXb":appliedInX}
 503         else:
 504             __appliedInX = None
 505         #
 506         if scheduledBy is not None:
 507             self.__T = scheduledBy
 508         #
 509         if isinstance(__Function, dict) and \
 510                 ("useApproximatedDerivatives" in __Function) and bool(__Function["useApproximatedDerivatives"]) and \
 511                 ("Direct" in __Function) and (__Function["Direct"] is not None):
 512             if "CenteredFiniteDifference"           not in __Function: __Function["CenteredFiniteDifference"]           = False
 513             if "DifferentialIncrement"              not in __Function: __Function["DifferentialIncrement"]              = 0.01
 514             if "withdX"                             not in __Function: __Function["withdX"]                             = None
 515             if "withAvoidingRedundancy"             not in __Function: __Function["withAvoidingRedundancy"]             = avoidRC
 516             if "withToleranceInRedundancy"          not in __Function: __Function["withToleranceInRedundancy"]          = 1.e-18
 517             if "withLenghtOfRedundancy"             not in __Function: __Function["withLenghtOfRedundancy"]             = -1
 518             if "NumberOfProcesses"                  not in __Function: __Function["NumberOfProcesses"]                  = None
 519             if "withmfEnabled"                      not in __Function: __Function["withmfEnabled"]                      = inputAsMF
 520             from daCore import NumericObjects
 521             FDA = NumericObjects.FDApproximation(
 522                 name                  = self.__name,
 523                 Function              = __Function["Direct"],
 524                 centeredDF            = __Function["CenteredFiniteDifference"],
 525                 increment             = __Function["DifferentialIncrement"],
 526                 dX                    = __Function["withdX"],
 527                 extraArguments        = self.__extraArgs,
 528                 avoidingRedundancy    = __Function["withAvoidingRedundancy"],
 529                 toleranceInRedundancy = __Function["withToleranceInRedundancy"],
 530                 lenghtOfRedundancy    = __Function["withLenghtOfRedundancy"],
 531                 mpEnabled             = __Function["EnableMultiProcessingInDerivatives"],
 532                 mpWorkers             = __Function["NumberOfProcesses"],
 533                 mfEnabled             = __Function["withmfEnabled"],
 534                 )
 535             self.__FO["Direct"]  = Operator( name = self.__name,           fromMethod = FDA.DirectOperator,  avoidingRedundancy = avoidRC, inputAsMultiFunction = inputAsMF, extraArguments = self.__extraArgs, enableMultiProcess = __Parameters["EnableMultiProcessingInEvaluation"] )
 536             self.__FO["Tangent"] = Operator( name = self.__name+"Tangent", fromMethod = FDA.TangentOperator, avoidingRedundancy = avoidRC, inputAsMultiFunction = inputAsMF, extraArguments = self.__extraArgs )
 537             self.__FO["Adjoint"] = Operator( name = self.__name+"Adjoint", fromMethod = FDA.AdjointOperator, avoidingRedundancy = avoidRC, inputAsMultiFunction = inputAsMF, extraArguments = self.__extraArgs )
 538         elif isinstance(__Function, dict) and \
 539                 ("Direct" in __Function) and ("Tangent" in __Function) and ("Adjoint" in __Function) and \
 540                 (__Function["Direct"] is not None) and (__Function["Tangent"] is not None) and (__Function["Adjoint"] is not None):
 541             self.__FO["Direct"]  = Operator( name = self.__name,           fromMethod = __Function["Direct"],  avoidingRedundancy = avoidRC, inputAsMultiFunction = inputAsMF, extraArguments = self.__extraArgs, enableMultiProcess = __Parameters["EnableMultiProcessingInEvaluation"] )
 542             self.__FO["Tangent"] = Operator( name = self.__name+"Tangent", fromMethod = __Function["Tangent"], avoidingRedundancy = avoidRC, inputAsMultiFunction = inputAsMF, extraArguments = self.__extraArgs )
 543             self.__FO["Adjoint"] = Operator( name = self.__name+"Adjoint", fromMethod = __Function["Adjoint"], avoidingRedundancy = avoidRC, inputAsMultiFunction = inputAsMF, extraArguments = self.__extraArgs )
 544         elif asMatrix is not None:
 545             __matrice = numpy.matrix( __Matrix, numpy.float )
 546             self.__FO["Direct"]  = Operator( name = self.__name,           fromMatrix = __matrice,   avoidingRedundancy = avoidRC, inputAsMultiFunction = inputAsMF, enableMultiProcess = __Parameters["EnableMultiProcessingInEvaluation"] )
 547             self.__FO["Tangent"] = Operator( name = self.__name+"Tangent", fromMatrix = __matrice,   avoidingRedundancy = avoidRC, inputAsMultiFunction = inputAsMF )
 548             self.__FO["Adjoint"] = Operator( name = self.__name+"Adjoint", fromMatrix = __matrice.T, avoidingRedundancy = avoidRC, inputAsMultiFunction = inputAsMF )
 549             del __matrice
 550         else:
 551             raise ValueError("The %s object is improperly defined or undefined, it requires at minima either a matrix, a Direct operator for approximate derivatives or a Tangent/Adjoint operators pair. Please check your operator input."%self.__name)
 552         #
 553         if __appliedInX is not None:
 554             self.__FO["AppliedInX"] = {}
 555             for key in list(__appliedInX.keys()):
 556                 if type( __appliedInX[key] ) is type( numpy.matrix([]) ):
 557                     # Pour le cas où l'on a une vraie matrice
 558                     self.__FO["AppliedInX"][key] = numpy.matrix( __appliedInX[key].A1, numpy.float ).T
 559                 elif type( __appliedInX[key] ) is type( numpy.array([]) ) and len(__appliedInX[key].shape) > 1:
 560                     # Pour le cas où l'on a un vecteur représenté en array avec 2 dimensions
 561                     self.__FO["AppliedInX"][key] = numpy.matrix( __appliedInX[key].reshape(len(__appliedInX[key]),), numpy.float ).T
 562                 else:
 563                     self.__FO["AppliedInX"][key] = numpy.matrix( __appliedInX[key],    numpy.float ).T
 564         else:
 565             self.__FO["AppliedInX"] = None
 566
 567     def getO(self):
 568         return self.__FO
 569
 570     def __repr__(self):
 571         "x.__repr__() <==> repr(x)"
 572         return repr(self.__FO)
 573
 574     def __str__(self):
 575         "x.__str__() <==> str(x)"
 576         return str(self.__FO)
 577
 578 # ==============================================================================
 579 class Algorithm(object):
 580     """
 581     Classe générale d'interface de type algorithme
 582
 583     Elle donne un cadre pour l'écriture d'une classe élémentaire d'algorithme
 584     d'assimilation, en fournissant un container (dictionnaire) de variables
 585     persistantes initialisées, et des méthodes d'accès à ces variables stockées.
 586
 587     Une classe élémentaire d'algorithme doit implémenter la méthode "run".
 588     """
 589     def __init__(self, name):
 590         """
 591         L'initialisation présente permet de fabriquer des variables de stockage
 592         disponibles de manière générique dans les algorithmes élémentaires. Ces
 593         variables de stockage sont ensuite conservées dans un dictionnaire
 594         interne à l'objet, mais auquel on accède par la méthode "get".
 595
 596         Les variables prévues sont :
 597             - APosterioriCorrelations : matrice de corrélations de la matrice A
 598             - APosterioriCovariance : matrice de covariances a posteriori : A
 599             - APosterioriStandardDeviations : vecteur des écart-types de la matrice A
 600             - APosterioriVariances : vecteur des variances de la matrice A
 601             - Analysis : vecteur d'analyse : Xa
 602             - BMA : Background moins Analysis : Xa - Xb
 603             - CostFunctionJ  : fonction-coût globale, somme des deux parties suivantes Jb et Jo
 604             - CostFunctionJAtCurrentOptimum : fonction-coût globale à l'état optimal courant lors d'itérations
 605             - CostFunctionJb : partie ébauche ou background de la fonction-coût : Jb
 606             - CostFunctionJbAtCurrentOptimum : partie ébauche à l'état optimal courant lors d'itérations
 607             - CostFunctionJo : partie observations de la fonction-coût : Jo
 608             - CostFunctionJoAtCurrentOptimum : partie observations à l'état optimal courant lors d'itérations
 609             - CurrentIterationNumber : numéro courant d'itération dans les algorithmes itératifs, à partir de 0
 610             - CurrentOptimum : état optimal courant lors d'itérations
 611             - CurrentState : état courant lors d'itérations
 612             - GradientOfCostFunctionJ  : gradient de la fonction-coût globale
 613             - GradientOfCostFunctionJb : gradient de la partie ébauche de la fonction-coût
 614             - GradientOfCostFunctionJo : gradient de la partie observations de la fonction-coût
 615             - IndexOfOptimum : index de l'état optimal courant lors d'itérations
 616             - Innovation : l'innovation : d = Y - H(X)
 617             - InnovationAtCurrentState : l'innovation à l'état courant : dn = Y - H(Xn)
 618             - JacobianMatrixAtBackground : matrice jacobienne à l'état d'ébauche
 619             - JacobianMatrixAtCurrentState : matrice jacobienne à l'état courant
 620             - JacobianMatrixAtOptimum : matrice jacobienne à l'optimum
 621             - KalmanGainAtOptimum : gain de Kalman à l'optimum
 622             - MahalanobisConsistency : indicateur de consistance des covariances
 623             - OMA : Observation moins Analyse : Y - Xa
 624             - OMB : Observation moins Background : Y - Xb
 625             - ForecastState : état prédit courant lors d'itérations
 626             - Residu : dans le cas des algorithmes de vérification
 627             - SampledStateForQuantiles : échantillons d'états pour l'estimation des quantiles
 628             - SigmaBck2 : indicateur de correction optimale des erreurs d'ébauche
 629             - SigmaObs2 : indicateur de correction optimale des erreurs d'observation
 630             - SimulatedObservationAtBackground : l'état observé H(Xb) à l'ébauche
 631             - SimulatedObservationAtCurrentOptimum : l'état observé H(X) à l'état optimal courant
 632             - SimulatedObservationAtCurrentState : l'état observé H(X) à l'état courant
 633             - SimulatedObservationAtOptimum : l'état observé H(Xa) à l'optimum
 634             - SimulationQuantiles : états observés H(X) pour les quantiles demandés
 635         On peut rajouter des variables à stocker dans l'initialisation de
 636         l'algorithme élémentaire qui va hériter de cette classe
 637         """
 638         logging.debug("%s Initialisation", str(name))
 639         self._m = PlatformInfo.SystemUsage()
 640         #
 641         self._name = str( name )
 642         self._parameters = {"StoreSupplementaryCalculations":[]}
 643         self.__required_parameters = {}
 644         self.__required_inputs = {
 645             "RequiredInputValues":{"mandatory":(), "optional":()},
 646             "ClassificationTags":[],
 647             }
 648         self.__variable_names_not_public = {"nextStep":False} # Duplication dans AlgorithmAndParameters
 649         self.__canonical_parameter_name = {} # Correspondance "lower"->"correct"
 650         self.__canonical_stored_name = {}    # Correspondance "lower"->"correct"
 651         #
 652         self.StoredVariables = {}
 653         self.StoredVariables["APosterioriCorrelations"]              = Persistence.OneMatrix(name = "APosterioriCorrelations")
 654         self.StoredVariables["APosterioriCovariance"]                = Persistence.OneMatrix(name = "APosterioriCovariance")
 655         self.StoredVariables["APosterioriStandardDeviations"]        = Persistence.OneVector(name = "APosterioriStandardDeviations")
 656         self.StoredVariables["APosterioriVariances"]                 = Persistence.OneVector(name = "APosterioriVariances")
 657         self.StoredVariables["Analysis"]                             = Persistence.OneVector(name = "Analysis")
 658         self.StoredVariables["BMA"]                                  = Persistence.OneVector(name = "BMA")
 659         self.StoredVariables["CostFunctionJ"]                        = Persistence.OneScalar(name = "CostFunctionJ")
 660         self.StoredVariables["CostFunctionJAtCurrentOptimum"]        = Persistence.OneScalar(name = "CostFunctionJAtCurrentOptimum")
 661         self.StoredVariables["CostFunctionJb"]                       = Persistence.OneScalar(name = "CostFunctionJb")
 662         self.StoredVariables["CostFunctionJbAtCurrentOptimum"]       = Persistence.OneScalar(name = "CostFunctionJbAtCurrentOptimum")
 663         self.StoredVariables["CostFunctionJo"]                       = Persistence.OneScalar(name = "CostFunctionJo")
 664         self.StoredVariables["CostFunctionJoAtCurrentOptimum"]       = Persistence.OneScalar(name = "CostFunctionJoAtCurrentOptimum")
 665         self.StoredVariables["CurrentEnsembleState"]                 = Persistence.OneMatrix(name = "CurrentEnsembleState")
 666         self.StoredVariables["CurrentIterationNumber"]               = Persistence.OneIndex(name  = "CurrentIterationNumber")
 667         self.StoredVariables["CurrentOptimum"]                       = Persistence.OneVector(name = "CurrentOptimum")
 668         self.StoredVariables["CurrentState"]                         = Persistence.OneVector(name = "CurrentState")
 669         self.StoredVariables["ForecastState"]                        = Persistence.OneVector(name = "ForecastState")
 670         self.StoredVariables["GradientOfCostFunctionJ"]              = Persistence.OneVector(name = "GradientOfCostFunctionJ")
 671         self.StoredVariables["GradientOfCostFunctionJb"]             = Persistence.OneVector(name = "GradientOfCostFunctionJb")
 672         self.StoredVariables["GradientOfCostFunctionJo"]             = Persistence.OneVector(name = "GradientOfCostFunctionJo")
 673         self.StoredVariables["IndexOfOptimum"]                       = Persistence.OneIndex(name  = "IndexOfOptimum")
 674         self.StoredVariables["Innovation"]                           = Persistence.OneVector(name = "Innovation")
 675         self.StoredVariables["InnovationAtCurrentAnalysis"]          = Persistence.OneVector(name = "InnovationAtCurrentAnalysis")
 676         self.StoredVariables["InnovationAtCurrentState"]             = Persistence.OneVector(name = "InnovationAtCurrentState")
 677         self.StoredVariables["JacobianMatrixAtBackground"]           = Persistence.OneMatrix(name = "JacobianMatrixAtBackground")
 678         self.StoredVariables["JacobianMatrixAtCurrentState"]         = Persistence.OneMatrix(name = "JacobianMatrixAtCurrentState")
 679         self.StoredVariables["JacobianMatrixAtOptimum"]              = Persistence.OneMatrix(name = "JacobianMatrixAtOptimum")
 680         self.StoredVariables["KalmanGainAtOptimum"]                  = Persistence.OneMatrix(name = "KalmanGainAtOptimum")
 681         self.StoredVariables["MahalanobisConsistency"]               = Persistence.OneScalar(name = "MahalanobisConsistency")
 682         self.StoredVariables["OMA"]                                  = Persistence.OneVector(name = "OMA")
 683         self.StoredVariables["OMB"]                                  = Persistence.OneVector(name = "OMB")
 684         self.StoredVariables["Residu"]                               = Persistence.OneScalar(name = "Residu")
 685         self.StoredVariables["SampledStateForQuantiles"]             = Persistence.OneMatrix(name = "SampledStateForQuantiles")
 686         self.StoredVariables["SigmaBck2"]                            = Persistence.OneScalar(name = "SigmaBck2")
 687         self.StoredVariables["SigmaObs2"]                            = Persistence.OneScalar(name = "SigmaObs2")
 688         self.StoredVariables["SimulatedObservationAtBackground"]     = Persistence.OneVector(name = "SimulatedObservationAtBackground")
 689         self.StoredVariables["SimulatedObservationAtCurrentAnalysis"]= Persistence.OneVector(name = "SimulatedObservationAtCurrentAnalysis")
 690         self.StoredVariables["SimulatedObservationAtCurrentOptimum"] = Persistence.OneVector(name = "SimulatedObservationAtCurrentOptimum")
 691         self.StoredVariables["SimulatedObservationAtCurrentState"]   = Persistence.OneVector(name = "SimulatedObservationAtCurrentState")
 692         self.StoredVariables["SimulatedObservationAtOptimum"]        = Persistence.OneVector(name = "SimulatedObservationAtOptimum")
 693         self.StoredVariables["SimulationQuantiles"]                  = Persistence.OneMatrix(name = "SimulationQuantiles")
 694         #
 695         for k in self.StoredVariables:
 696             self.__canonical_stored_name[k.lower()] = k
 697         #
 698         for k, v in self.__variable_names_not_public.items():
 699             self.__canonical_parameter_name[k.lower()] = k
 700         self.__canonical_parameter_name["algorithm"] = "Algorithm"
 701         self.__canonical_parameter_name["storesupplementarycalculations"] = "StoreSupplementaryCalculations"
 702
 703     def _pre_run(self, Parameters, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None ):
 704         "Pré-calcul"
 705         logging.debug("%s Lancement", self._name)
 706         logging.debug("%s Taille mémoire utilisée de %.0f Mio"%(self._name, self._m.getUsedMemory("Mio")))
 707         self._getTimeState(reset=True)
 708         #
 709         # Mise a jour des paramètres internes avec le contenu de Parameters, en
 710         # reprenant les valeurs par défauts pour toutes celles non définies
 711         self.__setParameters(Parameters, reset=True)
 712         for k, v in self.__variable_names_not_public.items():
 713             if k not in self._parameters:  self.__setParameters( {k:v} )
 714         #
 715         # Corrections et compléments des vecteurs
 716         def __test_vvalue(argument, variable, argname, symbol=None):
 717             if symbol is None: symbol = variable
 718             if argument is None:
 719                 if variable in self.__required_inputs["RequiredInputValues"]["mandatory"]:
 720                     raise ValueError("%s %s vector %s is not set and has to be properly defined!"%(self._name,argname,symbol))
 721                 elif variable in self.__required_inputs["RequiredInputValues"]["optional"]:
 722                     logging.debug("%s %s vector %s is not set, but is optional."%(self._name,argname,symbol))
 723                 else:
 724                     logging.debug("%s %s vector %s is not set, but is not required."%(self._name,argname,symbol))
 725             else:
 726                 logging.debug("%s %s vector %s is set, and its size is %i."%(self._name,argname,symbol,numpy.array(argument).size))
 727             return 0
 728         __test_vvalue( Xb, "Xb", "Background or initial state" )
 729         __test_vvalue( Y,  "Y",  "Observation" )
 730         __test_vvalue( U,  "U",  "Control" )
 731         #
 732         # Corrections et compléments des covariances
 733         def __test_cvalue(argument, variable, argname, symbol=None):
 734             if symbol is None: symbol = variable
 735             if argument is None:
 736                 if variable in self.__required_inputs["RequiredInputValues"]["mandatory"]:
 737                     raise ValueError("%s %s error covariance matrix %s is not set and has to be properly defined!"%(self._name,argname,symbol))
 738                 elif variable in self.__required_inputs["RequiredInputValues"]["optional"]:
 739                     logging.debug("%s %s error covariance matrix %s is not set, but is optional."%(self._name,argname,symbol))
 740                 else:
 741                     logging.debug("%s %s error covariance matrix %s is not set, but is not required."%(self._name,argname,symbol))
 742             else:
 743                 logging.debug("%s %s error covariance matrix %s is set."%(self._name,argname,symbol))
 744             return 0
 745         __test_cvalue( B, "B", "Background" )
 746         __test_cvalue( R, "R", "Observation" )
 747         __test_cvalue( Q, "Q", "Evolution" )
 748         #
 749         # Corrections et compléments des opérateurs
 750         def __test_ovalue(argument, variable, argname, symbol=None):
 751             if symbol is None: symbol = variable
 752             if argument is None or (isinstance(argument,dict) and len(argument)==0):
 753                 if variable in self.__required_inputs["RequiredInputValues"]["mandatory"]:
 754                     raise ValueError("%s %s operator %s is not set and has to be properly defined!"%(self._name,argname,symbol))
 755                 elif variable in self.__required_inputs["RequiredInputValues"]["optional"]:
 756                     logging.debug("%s %s operator %s is not set, but is optional."%(self._name,argname,symbol))
 757                 else:
 758                     logging.debug("%s %s operator %s is not set, but is not required."%(self._name,argname,symbol))
 759             else:
 760                 logging.debug("%s %s operator %s is set."%(self._name,argname,symbol))
 761             return 0
 762         __test_ovalue( HO, "HO", "Observation", "H" )
 763         __test_ovalue( EM, "EM", "Evolution", "M" )
 764         __test_ovalue( CM, "CM", "Control Model", "C" )
 765         #
 766         # Corrections et compléments des bornes
 767         if ("Bounds" in self._parameters) and isinstance(self._parameters["Bounds"], (list, tuple)) and (len(self._parameters["Bounds"]) > 0):
 768             logging.debug("%s Prise en compte des bornes effectuee"%(self._name,))
 769         else:
 770             self._parameters["Bounds"] = None
 771         #
 772         # Corrections et compléments de l'initialisation en X
 773         if  "InitializationPoint" in self._parameters:
 774             if Xb is not None:
 775                 if self._parameters["InitializationPoint"] is not None and hasattr(self._parameters["InitializationPoint"],'size'):
 776                     if self._parameters["InitializationPoint"].size != numpy.ravel(Xb).size:
 777                         raise ValueError("Incompatible size %i of forced initial point that have to replace the background of size %i" \
 778                             %(self._parameters["InitializationPoint"].size,numpy.ravel(Xb).size))
 779                     # Obtenu par typecast : numpy.ravel(self._parameters["InitializationPoint"])
 780                 else:
 781                     self._parameters["InitializationPoint"] = numpy.ravel(Xb)
 782             else:
 783                 if self._parameters["InitializationPoint"] is None:
 784                     raise ValueError("Forced initial point can not be set without any given Background or required value")
 785         #
 786         # Correction pour pallier a un bug de TNC sur le retour du Minimum
 787         if "Minimizer" in self._parameters and self._parameters["Minimizer"] == "TNC":
 788             self.setParameterValue("StoreInternalVariables",True)
 789         #
 790         # Verbosité et logging
 791         if logging.getLogger().level < logging.WARNING:
 792             self._parameters["optiprint"], self._parameters["optdisp"] = 1, 1
 793             if PlatformInfo.has_scipy:
 794                 import scipy.optimize
 795                 self._parameters["optmessages"] = scipy.optimize.tnc.MSG_ALL
 796             else:
 797                 self._parameters["optmessages"] = 15
 798         else:
 799             self._parameters["optiprint"], self._parameters["optdisp"] = -1, 0
 800             if PlatformInfo.has_scipy:
 801                 import scipy.optimize
 802                 self._parameters["optmessages"] = scipy.optimize.tnc.MSG_NONE
 803             else:
 804                 self._parameters["optmessages"] = 15
 805         #
 806         return 0
 807
 808     def _post_run(self,_oH=None):
 809         "Post-calcul"
 810         if ("StoreSupplementaryCalculations" in self._parameters) and \
 811             "APosterioriCovariance" in self._parameters["StoreSupplementaryCalculations"]:
 812             for _A in self.StoredVariables["APosterioriCovariance"]:
 813                 if "APosterioriVariances" in self._parameters["StoreSupplementaryCalculations"]:
 814                     self.StoredVariables["APosterioriVariances"].store( numpy.diag(_A) )
 815                 if "APosterioriStandardDeviations" in self._parameters["StoreSupplementaryCalculations"]:
 816                     self.StoredVariables["APosterioriStandardDeviations"].store( numpy.sqrt(numpy.diag(_A)) )
 817                 if "APosterioriCorrelations" in self._parameters["StoreSupplementaryCalculations"]:
 818                     _EI = numpy.diag(1./numpy.sqrt(numpy.diag(_A)))
 819                     _C = numpy.dot(_EI, numpy.dot(_A, _EI))
 820                     self.StoredVariables["APosterioriCorrelations"].store( _C )
 821         if _oH is not None and "Direct" in _oH and "Tangent" in _oH and "Adjoint" in _oH:
 822             logging.debug("%s Nombre d'évaluation(s) de l'opérateur d'observation direct/tangent/adjoint.: %i/%i/%i", self._name, _oH["Direct"].nbcalls(0),_oH["Tangent"].nbcalls(0),_oH["Adjoint"].nbcalls(0))
 823             logging.debug("%s Nombre d'appels au cache d'opérateur d'observation direct/tangent/adjoint..: %i/%i/%i", self._name, _oH["Direct"].nbcalls(3),_oH["Tangent"].nbcalls(3),_oH["Adjoint"].nbcalls(3))
 824         logging.debug("%s Taille mémoire utilisée de %.0f Mio", self._name, self._m.getUsedMemory("Mio"))
 825         logging.debug("%s Durées d'utilisation CPU de %.1fs et elapsed de %.1fs", self._name, self._getTimeState()[0], self._getTimeState()[1])
 826         logging.debug("%s Terminé", self._name)
 827         return 0
 828
 829     def _toStore(self, key):
 830         "True if in StoreSupplementaryCalculations, else False"
 831         return key in self._parameters["StoreSupplementaryCalculations"]
 832
 833     def get(self, key=None):
 834         """
 835         Renvoie l'une des variables stockées identifiée par la clé, ou le
 836         dictionnaire de l'ensemble des variables disponibles en l'absence de
 837         clé. Ce sont directement les variables sous forme objet qui sont
 838         renvoyées, donc les méthodes d'accès à l'objet individuel sont celles
 839         des classes de persistance.
 840         """
 841         if key is not None:
 842             return self.StoredVariables[self.__canonical_stored_name[key.lower()]]
 843         else:
 844             return self.StoredVariables
 845
 846     def __contains__(self, key=None):
 847         "D.__contains__(k) -> True if D has a key k, else False"
 848         if key is None or key.lower() not in self.__canonical_stored_name:
 849             return False
 850         else:
 851             return self.__canonical_stored_name[key.lower()] in self.StoredVariables
 852
 853     def keys(self):
 854         "D.keys() -> list of D's keys"
 855         if hasattr(self, "StoredVariables"):
 856             return self.StoredVariables.keys()
 857         else:
 858             return []
 859
 860     def pop(self, k, d):
 861         "D.pop(k[,d]) -> v, remove specified key and return the corresponding value"
 862         if hasattr(self, "StoredVariables") and k.lower() in self.__canonical_stored_name:
 863             return self.StoredVariables.pop(self.__canonical_stored_name[k.lower()], d)
 864         else:
 865             try:
 866                 msg = "'%s'"%k
 867             except:
 868                 raise TypeError("pop expected at least 1 arguments, got 0")
 869             "If key is not found, d is returned if given, otherwise KeyError is raised"
 870             try:
 871                 return d
 872             except:
 873                 raise KeyError(msg)
 874
 875     def run(self, Xb=None, Y=None, H=None, M=None, R=None, B=None, Q=None, Parameters=None):
 876         """
 877         Doit implémenter l'opération élémentaire de calcul d'assimilation sous
 878         sa forme mathématique la plus naturelle possible.
 879         """
 880         raise NotImplementedError("Mathematical assimilation calculation has not been implemented!")
 881
 882     def defineRequiredParameter(self, name = None, default = None, typecast = None, message = None, minval = None, maxval = None, listval = None, listadv = None):
 883         """
 884         Permet de définir dans l'algorithme des paramètres requis et leurs
 885         caractéristiques par défaut.
 886         """
 887         if name is None:
 888             raise ValueError("A name is mandatory to define a required parameter.")
 889         #
 890         self.__required_parameters[name] = {
 891             "default"  : default,
 892             "typecast" : typecast,
 893             "minval"   : minval,
 894             "maxval"   : maxval,
 895             "listval"  : listval,
 896             "listadv"  : listadv,
 897             "message"  : message,
 898             }
 899         self.__canonical_parameter_name[name.lower()] = name
 900         logging.debug("%s %s (valeur par défaut = %s)", self._name, message, self.setParameterValue(name))
 901
 902     def getRequiredParameters(self, noDetails=True):
 903         """
 904         Renvoie la liste des noms de paramètres requis ou directement le
 905         dictionnaire des paramètres requis.
 906         """
 907         if noDetails:
 908             return sorted(self.__required_parameters.keys())
 909         else:
 910             return self.__required_parameters
 911
 912     def setParameterValue(self, name=None, value=None):
 913         """
 914         Renvoie la valeur d'un paramètre requis de manière contrôlée
 915         """
 916         __k = self.__canonical_parameter_name[name.lower()]
 917         default  = self.__required_parameters[__k]["default"]
 918         typecast = self.__required_parameters[__k]["typecast"]
 919         minval   = self.__required_parameters[__k]["minval"]
 920         maxval   = self.__required_parameters[__k]["maxval"]
 921         listval  = self.__required_parameters[__k]["listval"]
 922         listadv  = self.__required_parameters[__k]["listadv"]
 923         #
 924         if value is None and default is None:
 925             __val = None
 926         elif value is None and default is not None:
 927             if typecast is None: __val = default
 928             else:                __val = typecast( default )
 929         else:
 930             if typecast is None: __val = value
 931             else:
 932                 try:
 933                     __val = typecast( value )
 934                 except:
 935                     raise ValueError("The value '%s' for the parameter named '%s' can not be correctly evaluated with type '%s'."%(value, __k, typecast))
 936         #
 937         if minval is not None and (numpy.array(__val, float) < minval).any():
 938             raise ValueError("The parameter named '%s' of value '%s' can not be less than %s."%(__k, __val, minval))
 939         if maxval is not None and (numpy.array(__val, float) > maxval).any():
 940             raise ValueError("The parameter named '%s' of value '%s' can not be greater than %s."%(__k, __val, maxval))
 941         if listval is not None or listadv is not None:
 942             if typecast is list or typecast is tuple or isinstance(__val,list) or isinstance(__val,tuple):
 943                 for v in __val:
 944                     if listval is not None and v in listval: continue
 945                     elif listadv is not None and v in listadv: continue
 946                     else:
 947                         raise ValueError("The value '%s' is not allowed for the parameter named '%s', it has to be in the list %s."%(v, __k, listval))
 948             elif not (listval is not None and __val in listval) and not (listadv is not None and __val in listadv):
 949                 raise ValueError("The value '%s' is not allowed for the parameter named '%s', it has to be in the list %s."%( __val, __k,listval))
 950         #
 951         return __val
 952
 953     def requireInputArguments(self, mandatory=(), optional=()):
 954         """
 955         Permet d'imposer des arguments de calcul requis en entrée.
 956         """
 957         self.__required_inputs["RequiredInputValues"]["mandatory"] = tuple( mandatory )
 958         self.__required_inputs["RequiredInputValues"]["optional"]  = tuple( optional )
 959
 960     def getInputArguments(self):
 961         """
 962         Permet d'obtenir les listes des arguments de calcul requis en entrée.
 963         """
 964         return self.__required_inputs["RequiredInputValues"]["mandatory"], self.__required_inputs["RequiredInputValues"]["optional"]
 965
 966     def setAttributes(self, tags=()):
 967         """
 968         Permet d'adjoindre des attributs comme les tags de classification.
 969         Renvoie la liste actuelle dans tous les cas.
 970         """
 971         self.__required_inputs["ClassificationTags"].extend( tags )
 972         return self.__required_inputs["ClassificationTags"]
 973
 974     def __setParameters(self, fromDico={}, reset=False):
 975         """
 976         Permet de stocker les paramètres reçus dans le dictionnaire interne.
 977         """
 978         self._parameters.update( fromDico )
 979         __inverse_fromDico_keys = {}
 980         for k in fromDico.keys():
 981             if k.lower() in self.__canonical_parameter_name:
 982                 __inverse_fromDico_keys[self.__canonical_parameter_name[k.lower()]] = k
 983         #~ __inverse_fromDico_keys = dict([(self.__canonical_parameter_name[k.lower()],k) for k in fromDico.keys()])
 984         __canonic_fromDico_keys = __inverse_fromDico_keys.keys()
 985         for k in self.__required_parameters.keys():
 986             if k in __canonic_fromDico_keys:
 987                 self._parameters[k] = self.setParameterValue(k,fromDico[__inverse_fromDico_keys[k]])
 988             elif reset:
 989                 self._parameters[k] = self.setParameterValue(k)
 990             else:
 991                 pass
 992             logging.debug("%s %s : %s", self._name, self.__required_parameters[k]["message"], self._parameters[k])
 993
 994     def _getTimeState(self, reset=False):
 995         """
 996         Initialise ou restitue le temps de calcul (cpu/elapsed) à la seconde
 997         """
 998         if reset:
 999             self.__initial_cpu_time      = time.process_time()
1000             self.__initial_elapsed_time  = time.perf_counter()
1001             return 0., 0.
1002         else:
1003             self.__cpu_time     = time.process_time() - self.__initial_cpu_time
1004             self.__elapsed_time = time.perf_counter() - self.__initial_elapsed_time
1005             return self.__cpu_time, self.__elapsed_time
1006
1007     def _StopOnTimeLimit(self, X=None, withReason=False):
1008         "Stop criteria on time limit: True/False [+ Reason]"
1009         c, e = self._getTimeState()
1010         if "MaximumCpuTime" in self._parameters and c > self._parameters["MaximumCpuTime"]:
1011             __SC, __SR = True, "Reached maximum CPU time (%.1fs > %.1fs)"%(c, self._parameters["MaximumCpuTime"])
1012         elif "MaximumElapsedTime" in self._parameters and e > self._parameters["MaximumElapsedTime"]:
1013             __SC, __SR = True, "Reached maximum elapsed time (%.1fs > %.1fs)"%(e, self._parameters["MaximumElapsedTime"])
1014         else:
1015             __SC, __SR = False, ""
1016         if withReason:
1017             return __SC, __SR
1018         else:
1019             return __SC
1020
1021 # ==============================================================================
1022 class AlgorithmAndParameters(object):
1023     """
1024     Classe générale d'interface d'action pour l'algorithme et ses paramètres
1025     """
1026     def __init__(self,
1027                  name               = "GenericAlgorithm",
1028                  asAlgorithm        = None,
1029                  asDict             = None,
1030                  asScript           = None,
1031                 ):
1032         """
1033         """
1034         self.__name       = str(name)
1035         self.__A          = None
1036         self.__P          = {}
1037         #
1038         self.__algorithm         = {}
1039         self.__algorithmFile     = None
1040         self.__algorithmName     = None
1041         #
1042         self.updateParameters( asDict, asScript )
1043         #
1044         if asAlgorithm is None and asScript is not None:
1045             __Algo = Interfaces.ImportFromScript(asScript).getvalue( "Algorithm" )
1046         else:
1047             __Algo = asAlgorithm
1048         #
1049         if __Algo is not None:
1050             self.__A = str(__Algo)
1051             self.__P.update( {"Algorithm":self.__A} )
1052         #
1053         self.__setAlgorithm( self.__A )
1054         #
1055         self.__variable_names_not_public = {"nextStep":False} # Duplication dans Algorithm
1056
1057     def updateParameters(self,
1058                  asDict     = None,
1059                  asScript   = None,
1060                 ):
1061         "Mise a jour des parametres"
1062         if asDict is None and asScript is not None:
1063             __Dict = Interfaces.ImportFromScript(asScript).getvalue( self.__name, "Parameters" )
1064         else:
1065             __Dict = asDict
1066         #
1067         if __Dict is not None:
1068             self.__P.update( dict(__Dict) )
1069
1070     def executePythonScheme(self, asDictAO = None):
1071         "Permet de lancer le calcul d'assimilation"
1072         Operator.CM.clearCache()
1073         #
1074         if not isinstance(asDictAO, dict):
1075             raise ValueError("The objects for algorithm calculation have to be given together as a dictionnary, and they are not")
1076         if   hasattr(asDictAO["Background"],"getO"):        self.__Xb = asDictAO["Background"].getO()
1077         elif hasattr(asDictAO["CheckingPoint"],"getO"):     self.__Xb = asDictAO["CheckingPoint"].getO()
1078         else:                                               self.__Xb = None
1079         if hasattr(asDictAO["Observation"],"getO"):         self.__Y  = asDictAO["Observation"].getO()
1080         else:                                               self.__Y  = asDictAO["Observation"]
1081         if hasattr(asDictAO["ControlInput"],"getO"):        self.__U  = asDictAO["ControlInput"].getO()
1082         else:                                               self.__U  = asDictAO["ControlInput"]
1083         if hasattr(asDictAO["ObservationOperator"],"getO"): self.__HO = asDictAO["ObservationOperator"].getO()
1084         else:                                               self.__HO = asDictAO["ObservationOperator"]
1085         if hasattr(asDictAO["EvolutionModel"],"getO"):      self.__EM = asDictAO["EvolutionModel"].getO()
1086         else:                                               self.__EM = asDictAO["EvolutionModel"]
1087         if hasattr(asDictAO["ControlModel"],"getO"):        self.__CM = asDictAO["ControlModel"].getO()
1088         else:                                               self.__CM = asDictAO["ControlModel"]
1089         self.__B = asDictAO["BackgroundError"]
1090         self.__R = asDictAO["ObservationError"]
1091         self.__Q = asDictAO["EvolutionError"]
1092         #
1093         self.__shape_validate()
1094         #
1095         self.__algorithm.run(
1096             Xb         = self.__Xb,
1097             Y          = self.__Y,
1098             U          = self.__U,
1099             HO         = self.__HO,
1100             EM         = self.__EM,
1101             CM         = self.__CM,
1102             R          = self.__R,
1103             B          = self.__B,
1104             Q          = self.__Q,
1105             Parameters = self.__P,
1106             )
1107         return 0
1108
1109     def executeYACSScheme(self, FileName=None):
1110         "Permet de lancer le calcul d'assimilation"
1111         if FileName is None or not os.path.exists(FileName):
1112             raise ValueError("a YACS file name has to be given for YACS execution.\n")
1113         else:
1114             __file    = os.path.abspath(FileName)
1115             logging.debug("The YACS file name is \"%s\"."%__file)
1116         if not PlatformInfo.has_salome or \
1117             not PlatformInfo.has_yacs or \
1118             not PlatformInfo.has_adao:
1119             raise ImportError("\n\n"+\
1120                 "Unable to get SALOME, YACS or ADAO environnement variables.\n"+\
1121                 "Please load the right environnement before trying to use it.\n")
1122         #
1123         import pilot
1124         import SALOMERuntime
1125         import loader
1126         SALOMERuntime.RuntimeSALOME_setRuntime()
1127
1128         r = pilot.getRuntime()
1129         xmlLoader = loader.YACSLoader()
1130         xmlLoader.registerProcCataLoader()
1131         try:
1132             catalogAd = r.loadCatalog("proc", __file)
1133             r.addCatalog(catalogAd)
1134         except:
1135             pass
1136
1137         try:
1138             p = xmlLoader.load(__file)
1139         except IOError as ex:
1140             print("The YACS XML schema file can not be loaded: %s"%(ex,))
1141
1142         logger = p.getLogger("parser")
1143         if not logger.isEmpty():
1144             print("The imported YACS XML schema has errors on parsing:")
1145             print(logger.getStr())
1146
1147         if not p.isValid():
1148             print("The YACS XML schema is not valid and will not be executed:")
1149             print(p.getErrorReport())
1150
1151         info=pilot.LinkInfo(pilot.LinkInfo.ALL_DONT_STOP)
1152         p.checkConsistency(info)
1153         if info.areWarningsOrErrors():
1154             print("The YACS XML schema is not coherent and will not be executed:")
1155             print(info.getGlobalRepr())
1156
1157         e = pilot.ExecutorSwig()
1158         e.RunW(p)
1159         if p.getEffectiveState() != pilot.DONE:
1160             print(p.getErrorReport())
1161         #
1162         return 0
1163
1164     def get(self, key = None):
1165         "Vérifie l'existence d'une clé de variable ou de paramètres"
1166         if key in self.__algorithm:
1167             return self.__algorithm.get( key )
1168         elif key in self.__P:
1169             return self.__P[key]
1170         else:
1171             allvariables = self.__P
1172             for k in self.__variable_names_not_public: allvariables.pop(k, None)
1173             return allvariables
1174
1175     def pop(self, k, d):
1176         "Necessaire pour le pickling"
1177         return self.__algorithm.pop(k, d)
1178
1179     def getAlgorithmRequiredParameters(self, noDetails=True):
1180         "Renvoie la liste des paramètres requis selon l'algorithme"
1181         return self.__algorithm.getRequiredParameters(noDetails)
1182
1183     def getAlgorithmInputArguments(self):
1184         "Renvoie la liste des entrées requises selon l'algorithme"
1185         return self.__algorithm.getInputArguments()
1186
1187     def getAlgorithmAttributes(self):
1188         "Renvoie la liste des attributs selon l'algorithme"
1189         return self.__algorithm.setAttributes()
1190
1191     def setObserver(self, __V, __O, __I, __S):
1192         if self.__algorithm is None \
1193             or isinstance(self.__algorithm, dict) \
1194             or not hasattr(self.__algorithm,"StoredVariables"):
1195             raise ValueError("No observer can be build before choosing an algorithm.")
1196         if __V not in self.__algorithm:
1197             raise ValueError("An observer requires to be set on a variable named %s which does not exist."%__V)
1198         else:
1199             self.__algorithm.StoredVariables[ __V ].setDataObserver(
1200                     Scheduler      = __S,
1201                     HookFunction   = __O,
1202                     HookParameters = __I,
1203                     )
1204
1205     def removeObserver(self, __V, __O, __A = False):
1206         if self.__algorithm is None \
1207             or isinstance(self.__algorithm, dict) \
1208             or not hasattr(self.__algorithm,"StoredVariables"):
1209             raise ValueError("No observer can be removed before choosing an algorithm.")
1210         if __V not in self.__algorithm:
1211             raise ValueError("An observer requires to be removed on a variable named %s which does not exist."%__V)
1212         else:
1213             return self.__algorithm.StoredVariables[ __V ].removeDataObserver(
1214                     HookFunction   = __O,
1215                     AllObservers   = __A,
1216                     )
1217
1218     def hasObserver(self, __V):
1219         if self.__algorithm is None \
1220             or isinstance(self.__algorithm, dict) \
1221             or not hasattr(self.__algorithm,"StoredVariables"):
1222             return False
1223         if __V not in self.__algorithm:
1224             return False
1225         return self.__algorithm.StoredVariables[ __V ].hasDataObserver()
1226
1227     def keys(self):
1228         __allvariables = list(self.__algorithm.keys()) + list(self.__P.keys())
1229         for k in self.__variable_names_not_public:
1230             if k in __allvariables: __allvariables.remove(k)
1231         return __allvariables
1232
1233     def __contains__(self, key=None):
1234         "D.__contains__(k) -> True if D has a key k, else False"
1235         return key in self.__algorithm or key in self.__P
1236
1237     def __repr__(self):
1238         "x.__repr__() <==> repr(x)"
1239         return repr(self.__A)+", "+repr(self.__P)
1240
1241     def __str__(self):
1242         "x.__str__() <==> str(x)"
1243         return str(self.__A)+", "+str(self.__P)
1244
1245     def __setAlgorithm(self, choice = None ):
1246         """
1247         Permet de sélectionner l'algorithme à utiliser pour mener à bien l'étude
1248         d'assimilation. L'argument est un champ caractère se rapportant au nom
1249         d'un algorithme réalisant l'opération sur les arguments fixes.
1250         """
1251         if choice is None:
1252             raise ValueError("Error: algorithm choice has to be given")
1253         if self.__algorithmName is not None:
1254             raise ValueError("Error: algorithm choice has already been done as \"%s\", it can't be changed."%self.__algorithmName)
1255         daDirectory = "daAlgorithms"
1256         #
1257         # Recherche explicitement le fichier complet
1258         # ------------------------------------------
1259         module_path = None
1260         for directory in sys.path:
1261             if os.path.isfile(os.path.join(directory, daDirectory, str(choice)+'.py')):
1262                 module_path = os.path.abspath(os.path.join(directory, daDirectory))
1263         if module_path is None:
1264             raise ImportError("No algorithm module named \"%s\" has been found in the search path.\n             The search path is %s"%(choice, sys.path))
1265         #
1266         # Importe le fichier complet comme un module
1267         # ------------------------------------------
1268         try:
1269             sys_path_tmp = sys.path ; sys.path.insert(0,module_path)
1270             self.__algorithmFile = __import__(str(choice), globals(), locals(), [])
1271             if not hasattr(self.__algorithmFile, "ElementaryAlgorithm"):
1272                 raise ImportError("this module does not define a valid elementary algorithm.")
1273             self.__algorithmName = str(choice)
1274             sys.path = sys_path_tmp ; del sys_path_tmp
1275         except ImportError as e:
1276             raise ImportError("The module named \"%s\" was found, but is incorrect at the import stage.\n             The import error message is: %s"%(choice,e))
1277         #
1278         # Instancie un objet du type élémentaire du fichier
1279         # -------------------------------------------------
1280         self.__algorithm = self.__algorithmFile.ElementaryAlgorithm()
1281         return 0
1282
1283     def __shape_validate(self):
1284         """
1285         Validation de la correspondance correcte des tailles des variables et
1286         des matrices s'il y en a.
1287         """
1288         if self.__Xb is None:                      __Xb_shape = (0,)
1289         elif hasattr(self.__Xb,"size"):            __Xb_shape = (self.__Xb.size,)
1290         elif hasattr(self.__Xb,"shape"):
1291             if isinstance(self.__Xb.shape, tuple): __Xb_shape = self.__Xb.shape
1292             else:                                  __Xb_shape = self.__Xb.shape()
1293         else: raise TypeError("The background (Xb) has no attribute of shape: problem !")
1294         #
1295         if self.__Y is None:                       __Y_shape = (0,)
1296         elif hasattr(self.__Y,"size"):             __Y_shape = (self.__Y.size,)
1297         elif hasattr(self.__Y,"shape"):
1298             if isinstance(self.__Y.shape, tuple):  __Y_shape = self.__Y.shape
1299             else:                                  __Y_shape = self.__Y.shape()
1300         else: raise TypeError("The observation (Y) has no attribute of shape: problem !")
1301         #
1302         if self.__U is None:                       __U_shape = (0,)
1303         elif hasattr(self.__U,"size"):             __U_shape = (self.__U.size,)
1304         elif hasattr(self.__U,"shape"):
1305             if isinstance(self.__U.shape, tuple):  __U_shape = self.__U.shape
1306             else:                                  __U_shape = self.__U.shape()
1307         else: raise TypeError("The control (U) has no attribute of shape: problem !")
1308         #
1309         if self.__B is None:                       __B_shape = (0,0)
1310         elif hasattr(self.__B,"shape"):
1311             if isinstance(self.__B.shape, tuple):  __B_shape = self.__B.shape
1312             else:                                  __B_shape = self.__B.shape()
1313         else: raise TypeError("The a priori errors covariance matrix (B) has no attribute of shape: problem !")
1314         #
1315         if self.__R is None:                       __R_shape = (0,0)
1316         elif hasattr(self.__R,"shape"):
1317             if isinstance(self.__R.shape, tuple):  __R_shape = self.__R.shape
1318             else:                                  __R_shape = self.__R.shape()
1319         else: raise TypeError("The observation errors covariance matrix (R) has no attribute of shape: problem !")
1320         #
1321         if self.__Q is None:                       __Q_shape = (0,0)
1322         elif hasattr(self.__Q,"shape"):
1323             if isinstance(self.__Q.shape, tuple):  __Q_shape = self.__Q.shape
1324             else:                                  __Q_shape = self.__Q.shape()
1325         else: raise TypeError("The evolution errors covariance matrix (Q) has no attribute of shape: problem !")
1326         #
1327         if len(self.__HO) == 0:                              __HO_shape = (0,0)
1328         elif isinstance(self.__HO, dict):                    __HO_shape = (0,0)
1329         elif hasattr(self.__HO["Direct"],"shape"):
1330             if isinstance(self.__HO["Direct"].shape, tuple): __HO_shape = self.__HO["Direct"].shape
1331             else:                                            __HO_shape = self.__HO["Direct"].shape()
1332         else: raise TypeError("The observation operator (H) has no attribute of shape: problem !")
1333         #
1334         if len(self.__EM) == 0:                              __EM_shape = (0,0)
1335         elif isinstance(self.__EM, dict):                    __EM_shape = (0,0)
1336         elif hasattr(self.__EM["Direct"],"shape"):
1337             if isinstance(self.__EM["Direct"].shape, tuple): __EM_shape = self.__EM["Direct"].shape
1338             else:                                            __EM_shape = self.__EM["Direct"].shape()
1339         else: raise TypeError("The evolution model (EM) has no attribute of shape: problem !")
1340         #
1341         if len(self.__CM) == 0:                              __CM_shape = (0,0)
1342         elif isinstance(self.__CM, dict):                    __CM_shape = (0,0)
1343         elif hasattr(self.__CM["Direct"],"shape"):
1344             if isinstance(self.__CM["Direct"].shape, tuple): __CM_shape = self.__CM["Direct"].shape
1345             else:                                            __CM_shape = self.__CM["Direct"].shape()
1346         else: raise TypeError("The control model (CM) has no attribute of shape: problem !")
1347         #
1348         # Vérification des conditions
1349         # ---------------------------
1350         if not( len(__Xb_shape) == 1 or min(__Xb_shape) == 1 ):
1351             raise ValueError("Shape characteristic of background (Xb) is incorrect: \"%s\"."%(__Xb_shape,))
1352         if not( len(__Y_shape) == 1 or min(__Y_shape) == 1 ):
1353             raise ValueError("Shape characteristic of observation (Y) is incorrect: \"%s\"."%(__Y_shape,))
1354         #
1355         if not( min(__B_shape) == max(__B_shape) ):
1356             raise ValueError("Shape characteristic of a priori errors covariance matrix (B) is incorrect: \"%s\"."%(__B_shape,))
1357         if not( min(__R_shape) == max(__R_shape) ):
1358             raise ValueError("Shape characteristic of observation errors covariance matrix (R) is incorrect: \"%s\"."%(__R_shape,))
1359         if not( min(__Q_shape) == max(__Q_shape) ):
1360             raise ValueError("Shape characteristic of evolution errors covariance matrix (Q) is incorrect: \"%s\"."%(__Q_shape,))
1361         if not( min(__EM_shape) == max(__EM_shape) ):
1362             raise ValueError("Shape characteristic of evolution operator (EM) is incorrect: \"%s\"."%(__EM_shape,))
1363         #
1364         if len(self.__HO) > 0 and not isinstance(self.__HO, dict) and not( __HO_shape[1] == max(__Xb_shape) ):
1365             raise ValueError("Shape characteristic of observation operator (H) \"%s\" and state (X) \"%s\" are incompatible."%(__HO_shape,__Xb_shape))
1366         if len(self.__HO) > 0 and not isinstance(self.__HO, dict) and not( __HO_shape[0] == max(__Y_shape) ):
1367             raise ValueError("Shape characteristic of observation operator (H) \"%s\" and observation (Y) \"%s\" are incompatible."%(__HO_shape,__Y_shape))
1368         if len(self.__HO) > 0 and not isinstance(self.__HO, dict) and len(self.__B) > 0 and not( __HO_shape[1] == __B_shape[0] ):
1369             raise ValueError("Shape characteristic of observation operator (H) \"%s\" and a priori errors covariance matrix (B) \"%s\" are incompatible."%(__HO_shape,__B_shape))
1370         if len(self.__HO) > 0 and not isinstance(self.__HO, dict) and len(self.__R) > 0 and not( __HO_shape[0] == __R_shape[1] ):
1371             raise ValueError("Shape characteristic of observation operator (H) \"%s\" and observation errors covariance matrix (R) \"%s\" are incompatible."%(__HO_shape,__R_shape))
1372         #
1373         if self.__B is not None and len(self.__B) > 0 and not( __B_shape[1] == max(__Xb_shape) ):
1374             if self.__algorithmName in ["EnsembleBlue",]:
1375                 asPersistentVector = self.__Xb.reshape((-1,min(__B_shape)))
1376                 self.__Xb = Persistence.OneVector("Background", basetype=numpy.matrix)
1377                 for member in asPersistentVector:
1378                     self.__Xb.store( numpy.matrix( numpy.ravel(member), numpy.float ).T )
1379                 __Xb_shape = min(__B_shape)
1380             else:
1381                 raise ValueError("Shape characteristic of a priori errors covariance matrix (B) \"%s\" and background (Xb) \"%s\" are incompatible."%(__B_shape,__Xb_shape))
1382         #
1383         if self.__R is not None and len(self.__R) > 0 and not( __R_shape[1] == max(__Y_shape) ):
1384             raise ValueError("Shape characteristic of observation errors covariance matrix (R) \"%s\" and observation (Y) \"%s\" are incompatible."%(__R_shape,__Y_shape))
1385         #
1386         if self.__EM is not None and len(self.__EM) > 0 and not isinstance(self.__EM, dict) and not( __EM_shape[1] == max(__Xb_shape) ):
1387             raise ValueError("Shape characteristic of evolution model (EM) \"%s\" and state (X) \"%s\" are incompatible."%(__EM_shape,__Xb_shape))
1388         #
1389         if self.__CM is not None and len(self.__CM) > 0 and not isinstance(self.__CM, dict) and not( __CM_shape[1] == max(__U_shape) ):
1390             raise ValueError("Shape characteristic of control model (CM) \"%s\" and control (U) \"%s\" are incompatible."%(__CM_shape,__U_shape))
1391         #
1392         if ("Bounds" in self.__P) \
1393             and (isinstance(self.__P["Bounds"], list) or isinstance(self.__P["Bounds"], tuple)) \
1394             and (len(self.__P["Bounds"]) != max(__Xb_shape)):
1395             raise ValueError("The number \"%s\" of bound pairs for the state (X) components is different of the size \"%s\" of the state itself." \
1396                 %(len(self.__P["Bounds"]),max(__Xb_shape)))
1397         #
1398         return 1
1399
1400 # ==============================================================================
1401 class RegulationAndParameters(object):
1402     """
1403     Classe générale d'interface d'action pour la régulation et ses paramètres
1404     """
1405     def __init__(self,
1406                  name               = "GenericRegulation",
1407                  asAlgorithm        = None,
1408                  asDict             = None,
1409                  asScript           = None,
1410                 ):
1411         """
1412         """
1413         self.__name       = str(name)
1414         self.__P          = {}
1415         #
1416         if asAlgorithm is None and asScript is not None:
1417             __Algo = Interfaces.ImportFromScript(asScript).getvalue( "Algorithm" )
1418         else:
1419             __Algo = asAlgorithm
1420         #
1421         if asDict is None and asScript is not None:
1422             __Dict = Interfaces.ImportFromScript(asScript).getvalue( self.__name, "Parameters" )
1423         else:
1424             __Dict = asDict
1425         #
1426         if __Dict is not None:
1427             self.__P.update( dict(__Dict) )
1428         #
1429         if __Algo is not None:
1430             self.__P.update( {"Algorithm":str(__Algo)} )
1431
1432     def get(self, key = None):
1433         "Vérifie l'existence d'une clé de variable ou de paramètres"
1434         if key in self.__P:
1435             return self.__P[key]
1436         else:
1437             return self.__P
1438
1439 # ==============================================================================
1440 class DataObserver(object):
1441     """
1442     Classe générale d'interface de type observer
1443     """
1444     def __init__(self,
1445                  name        = "GenericObserver",
1446                  onVariable  = None,
1447                  asTemplate  = None,
1448                  asString    = None,
1449                  asScript    = None,
1450                  asObsObject = None,
1451                  withInfo    = None,
1452                  scheduledBy = None,
1453                  withAlgo    = None,
1454                 ):
1455         """
1456         """
1457         self.__name       = str(name)
1458         self.__V          = None
1459         self.__O          = None
1460         self.__I          = None
1461         #
1462         if onVariable is None:
1463             raise ValueError("setting an observer has to be done over a variable name or a list of variable names, not over None.")
1464         elif type(onVariable) in (tuple, list):
1465             self.__V = tuple(map( str, onVariable ))
1466             if withInfo is None:
1467                 self.__I = self.__V
1468             else:
1469                 self.__I = (str(withInfo),)*len(self.__V)
1470         elif isinstance(onVariable, str):
1471             self.__V = (onVariable,)
1472             if withInfo is None:
1473                 self.__I = (onVariable,)
1474             else:
1475                 self.__I = (str(withInfo),)
1476         else:
1477             raise ValueError("setting an observer has to be done over a variable name or a list of variable names.")
1478         #
1479         if asObsObject is not None:
1480             self.__O = asObsObject
1481         else:
1482             __FunctionText = str(UserScript('Observer', asTemplate, asString, asScript))
1483             __Function = Observer2Func(__FunctionText)
1484             self.__O = __Function.getfunc()
1485         #
1486         for k in range(len(self.__V)):
1487             ename = self.__V[k]
1488             einfo = self.__I[k]
1489             if ename not in withAlgo:
1490                 raise ValueError("An observer is asked to be set on a variable named %s which does not exist."%ename)
1491             else:
1492                 withAlgo.setObserver(ename, self.__O, einfo, scheduledBy)
1493
1494     def __repr__(self):
1495         "x.__repr__() <==> repr(x)"
1496         return repr(self.__V)+"\n"+repr(self.__O)
1497
1498     def __str__(self):
1499         "x.__str__() <==> str(x)"
1500         return str(self.__V)+"\n"+str(self.__O)
1501
1502 # ==============================================================================
1503 class UserScript(object):
1504     """
1505     Classe générale d'interface de type texte de script utilisateur
1506     """
1507     def __init__(self,
1508                  name       = "GenericUserScript",
1509                  asTemplate = None,
1510                  asString   = None,
1511                  asScript   = None,
1512                 ):
1513         """
1514         """
1515         self.__name       = str(name)
1516         #
1517         if asString is not None:
1518             self.__F = asString
1519         elif self.__name == "UserPostAnalysis" and (asTemplate is not None) and (asTemplate in Templates.UserPostAnalysisTemplates):
1520             self.__F = Templates.UserPostAnalysisTemplates[asTemplate]
1521         elif self.__name == "Observer" and (asTemplate is not None) and (asTemplate in Templates.ObserverTemplates):
1522             self.__F = Templates.ObserverTemplates[asTemplate]
1523         elif asScript is not None:
1524             self.__F = Interfaces.ImportFromScript(asScript).getstring()
1525         else:
1526             self.__F = ""
1527
1528     def __repr__(self):
1529         "x.__repr__() <==> repr(x)"
1530         return repr(self.__F)
1531
1532     def __str__(self):
1533         "x.__str__() <==> str(x)"
1534         return str(self.__F)
1535
1536 # ==============================================================================
1537 class ExternalParameters(object):
1538     """
1539     Classe générale d'interface de type texte de script utilisateur
1540     """
1541     def __init__(self,
1542                  name        = "GenericExternalParameters",
1543                  asDict      = None,
1544                  asScript    = None,
1545                 ):
1546         """
1547         """
1548         self.__name = str(name)
1549         self.__P    = {}
1550         #
1551         self.updateParameters( asDict, asScript )
1552
1553     def updateParameters(self,
1554                  asDict     = None,
1555                  asScript   = None,
1556                 ):
1557         "Mise a jour des parametres"
1558         if asDict is None and asScript is not None:
1559             __Dict = Interfaces.ImportFromScript(asScript).getvalue( self.__name, "ExternalParameters" )
1560         else:
1561             __Dict = asDict
1562         #
1563         if __Dict is not None:
1564             self.__P.update( dict(__Dict) )
1565
1566     def get(self, key = None):
1567         if key in self.__P:
1568             return self.__P[key]
1569         else:
1570             return list(self.__P.keys())
1571
1572     def keys(self):
1573         return list(self.__P.keys())
1574
1575     def pop(self, k, d):
1576         return self.__P.pop(k, d)
1577
1578     def items(self):
1579         return self.__P.items()
1580
1581     def __contains__(self, key=None):
1582         "D.__contains__(k) -> True if D has a key k, else False"
1583         return key in self.__P
1584
1585 # ==============================================================================
1586 class State(object):
1587     """
1588     Classe générale d'interface de type état
1589     """
1590     def __init__(self,
1591                  name               = "GenericVector",
1592                  asVector           = None,
1593                  asPersistentVector = None,
1594                  asScript           = None,
1595                  asDataFile         = None,
1596                  colNames           = None,
1597                  colMajor           = False,
1598                  scheduledBy        = None,
1599                  toBeChecked        = False,
1600                 ):
1601         """
1602         Permet de définir un vecteur :
1603         - asVector : entrée des données, comme un vecteur compatible avec le
1604           constructeur de numpy.matrix, ou "True" si entrée par script.
1605         - asPersistentVector : entrée des données, comme une série de vecteurs
1606           compatible avec le constructeur de numpy.matrix, ou comme un objet de
1607           type Persistence, ou "True" si entrée par script.
1608         - asScript : si un script valide est donné contenant une variable
1609           nommée "name", la variable est de type "asVector" (par défaut) ou
1610           "asPersistentVector" selon que l'une de ces variables est placée à
1611           "True".
1612         - asDataFile : si un ou plusieurs fichiers valides sont donnés
1613           contenant des valeurs en colonnes, elles-mêmes nommées "colNames"
1614           (s'il n'y a pas de nom de colonne indiquée, on cherche une colonne
1615           nommée "name"), on récupère les colonnes et on les range ligne après
1616           ligne (colMajor=False, par défaut) ou colonne après colonne
1617           (colMajor=True). La variable résultante est de type "asVector" (par
1618           défaut) ou "asPersistentVector" selon que l'une de ces variables est
1619           placée à "True".
1620         """
1621         self.__name       = str(name)
1622         self.__check      = bool(toBeChecked)
1623         #
1624         self.__V          = None
1625         self.__T          = None
1626         self.__is_vector  = False
1627         self.__is_series  = False
1628         #
1629         if asScript is not None:
1630             __Vector, __Series = None, None
1631             if asPersistentVector:
1632                 __Series = Interfaces.ImportFromScript(asScript).getvalue( self.__name )
1633             else:
1634                 __Vector = Interfaces.ImportFromScript(asScript).getvalue( self.__name )
1635         elif asDataFile is not None:
1636             __Vector, __Series = None, None
1637             if asPersistentVector:
1638                 if colNames is not None:
1639                     __Series = Interfaces.ImportFromFile(asDataFile).getvalue( colNames )[1]
1640                 else:
1641                     __Series = Interfaces.ImportFromFile(asDataFile).getvalue( [self.__name,] )[1]
1642                 if bool(colMajor) and not Interfaces.ImportFromFile(asDataFile).getformat() == "application/numpy.npz":
1643                     __Series = numpy.transpose(__Series)
1644                 elif not bool(colMajor) and Interfaces.ImportFromFile(asDataFile).getformat() == "application/numpy.npz":
1645                     __Series = numpy.transpose(__Series)
1646             else:
1647                 if colNames is not None:
1648                     __Vector = Interfaces.ImportFromFile(asDataFile).getvalue( colNames )[1]
1649                 else:
1650                     __Vector = Interfaces.ImportFromFile(asDataFile).getvalue( [self.__name,] )[1]
1651                 if bool(colMajor):
1652                     __Vector = numpy.ravel(__Vector, order = "F")
1653                 else:
1654                     __Vector = numpy.ravel(__Vector, order = "C")
1655         else:
1656             __Vector, __Series = asVector, asPersistentVector
1657         #
1658         if __Vector is not None:
1659             self.__is_vector = True
1660             self.__V         = numpy.matrix( numpy.asmatrix(__Vector).A1, numpy.float ).T
1661             self.shape       = self.__V.shape
1662             self.size        = self.__V.size
1663         elif __Series is not None:
1664             self.__is_series  = True
1665             if isinstance(__Series, (tuple, list, numpy.ndarray, numpy.matrix, str)):
1666                 self.__V = Persistence.OneVector(self.__name, basetype=numpy.matrix)
1667                 if isinstance(__Series, str): __Series = eval(__Series)
1668                 for member in __Series:
1669                     self.__V.store( numpy.matrix( numpy.asmatrix(member).A1, numpy.float ).T )
1670             else:
1671                 self.__V = __Series
1672             if isinstance(self.__V.shape, (tuple, list)):
1673                 self.shape       = self.__V.shape
1674             else:
1675                 self.shape       = self.__V.shape()
1676             if len(self.shape) == 1:
1677                 self.shape       = (self.shape[0],1)
1678             self.size        = self.shape[0] * self.shape[1]
1679         else:
1680             raise ValueError("The %s object is improperly defined or undefined, it requires at minima either a vector, a list/tuple of vectors or a persistent object. Please check your vector input."%self.__name)
1681         #
1682         if scheduledBy is not None:
1683             self.__T = scheduledBy
1684
1685     def getO(self, withScheduler=False):
1686         if withScheduler:
1687             return self.__V, self.__T
1688         elif self.__T is None:
1689             return self.__V
1690         else:
1691             return self.__V
1692
1693     def isvector(self):
1694         "Vérification du type interne"
1695         return self.__is_vector
1696
1697     def isseries(self):
1698         "Vérification du type interne"
1699         return self.__is_series
1700
1701     def __repr__(self):
1702         "x.__repr__() <==> repr(x)"
1703         return repr(self.__V)
1704
1705     def __str__(self):
1706         "x.__str__() <==> str(x)"
1707         return str(self.__V)
1708
1709 # ==============================================================================
1710 class Covariance(object):
1711     """
1712     Classe générale d'interface de type covariance
1713     """
1714     def __init__(self,
1715                  name          = "GenericCovariance",
1716                  asCovariance  = None,
1717                  asEyeByScalar = None,
1718                  asEyeByVector = None,
1719                  asCovObject   = None,
1720                  asScript      = None,
1721                  toBeChecked   = False,
1722                 ):
1723         """
1724         Permet de définir une covariance :
1725         - asCovariance : entrée des données, comme une matrice compatible avec
1726           le constructeur de numpy.matrix
1727         - asEyeByScalar : entrée des données comme un seul scalaire de variance,
1728           multiplicatif d'une matrice de corrélation identité, aucune matrice
1729           n'étant donc explicitement à donner
1730         - asEyeByVector : entrée des données comme un seul vecteur de variance,
1731           à mettre sur la diagonale d'une matrice de corrélation, aucune matrice
1732           n'étant donc explicitement à donner
1733         - asCovObject : entrée des données comme un objet python, qui a les
1734           methodes obligatoires "getT", "getI", "diag", "trace", "__add__",
1735           "__sub__", "__neg__", "__mul__", "__rmul__" et facultatives "shape",
1736           "size", "cholesky", "choleskyI", "asfullmatrix", "__repr__", "__str__"
1737         - toBeChecked : booléen indiquant si le caractère SDP de la matrice
1738           pleine doit être vérifié
1739         """
1740         self.__name       = str(name)
1741         self.__check      = bool(toBeChecked)
1742         #
1743         self.__C          = None
1744         self.__is_scalar  = False
1745         self.__is_vector  = False
1746         self.__is_matrix  = False
1747         self.__is_object  = False
1748         #
1749         if asScript is not None:
1750             __Matrix, __Scalar, __Vector, __Object = None, None, None, None
1751             if asEyeByScalar:
1752                 __Scalar = Interfaces.ImportFromScript(asScript).getvalue( self.__name )
1753             elif asEyeByVector:
1754                 __Vector = Interfaces.ImportFromScript(asScript).getvalue( self.__name )
1755             elif asCovObject:
1756                 __Object = Interfaces.ImportFromScript(asScript).getvalue( self.__name )
1757             else:
1758                 __Matrix = Interfaces.ImportFromScript(asScript).getvalue( self.__name )
1759         else:
1760             __Matrix, __Scalar, __Vector, __Object = asCovariance, asEyeByScalar, asEyeByVector, asCovObject
1761         #
1762         if __Scalar is not None:
1763             if numpy.matrix(__Scalar).size != 1:
1764                 raise ValueError('  The diagonal multiplier given to define a sparse matrix is not a unique scalar value.\n  Its actual measured size is %i. Please check your scalar input.'%numpy.matrix(__Scalar).size)
1765             self.__is_scalar = True
1766             self.__C         = numpy.abs( float(__Scalar) )
1767             self.shape       = (0,0)
1768             self.size        = 0
1769         elif __Vector is not None:
1770             self.__is_vector = True
1771             self.__C         = numpy.abs( numpy.array( numpy.ravel( numpy.matrix(__Vector, float ) ) ) )
1772             self.shape       = (self.__C.size,self.__C.size)
1773             self.size        = self.__C.size**2
1774         elif __Matrix is not None:
1775             self.__is_matrix = True
1776             self.__C         = numpy.matrix( __Matrix, float )
1777             self.shape       = self.__C.shape
1778             self.size        = self.__C.size
1779         elif __Object is not None:
1780             self.__is_object = True
1781             self.__C         = __Object
1782             for at in ("getT","getI","diag","trace","__add__","__sub__","__neg__","__matmul__","__mul__","__rmatmul__","__rmul__"):
1783                 if not hasattr(self.__C,at):
1784                     raise ValueError("The matrix given for %s as an object has no attribute \"%s\". Please check your object input."%(self.__name,at))
1785             if hasattr(self.__C,"shape"):
1786                 self.shape       = self.__C.shape
1787             else:
1788                 self.shape       = (0,0)
1789             if hasattr(self.__C,"size"):
1790                 self.size        = self.__C.size
1791             else:
1792                 self.size        = 0
1793         else:
1794             pass
1795             # raise ValueError("The %s covariance matrix has to be specified either as a matrix, a vector for its diagonal or a scalar multiplying an identity matrix."%self.__name)
1796         #
1797         self.__validate()
1798
1799     def __validate(self):
1800         "Validation"
1801         if self.__C is None:
1802             raise UnboundLocalError("%s covariance matrix value has not been set!"%(self.__name,))
1803         if self.ismatrix() and min(self.shape) != max(self.shape):
1804             raise ValueError("The given matrix for %s is not a square one, its shape is %s. Please check your matrix input."%(self.__name,self.shape))
1805         if self.isobject() and min(self.shape) != max(self.shape):
1806             raise ValueError("The matrix given for \"%s\" is not a square one, its shape is %s. Please check your object input."%(self.__name,self.shape))
1807         if self.isscalar() and self.__C <= 0:
1808             raise ValueError("The \"%s\" covariance matrix is not positive-definite. Please check your scalar input %s."%(self.__name,self.__C))
1809         if self.isvector() and (self.__C <= 0).any():
1810             raise ValueError("The \"%s\" covariance matrix is not positive-definite. Please check your vector input."%(self.__name,))
1811         if self.ismatrix() and (self.__check or logging.getLogger().level < logging.WARNING):
1812             try:
1813                 L = numpy.linalg.cholesky( self.__C )
1814             except:
1815                 raise ValueError("The %s covariance matrix is not symmetric positive-definite. Please check your matrix input."%(self.__name,))
1816         if self.isobject() and (self.__check or logging.getLogger().level < logging.WARNING):
1817             try:
1818                 L = self.__C.cholesky()
1819             except:
1820                 raise ValueError("The %s covariance object is not symmetric positive-definite. Please check your matrix input."%(self.__name,))
1821
1822     def isscalar(self):
1823         "Vérification du type interne"
1824         return self.__is_scalar
1825
1826     def isvector(self):
1827         "Vérification du type interne"
1828         return self.__is_vector
1829
1830     def ismatrix(self):
1831         "Vérification du type interne"
1832         return self.__is_matrix
1833
1834     def isobject(self):
1835         "Vérification du type interne"
1836         return self.__is_object
1837
1838     def getI(self):
1839         "Inversion"
1840         if   self.ismatrix():
1841             return Covariance(self.__name+"I", asCovariance  = numpy.linalg.inv(self.__C) )
1842         elif self.isvector():
1843             return Covariance(self.__name+"I", asEyeByVector = 1. / self.__C )
1844         elif self.isscalar():
1845             return Covariance(self.__name+"I", asEyeByScalar = 1. / self.__C )
1846         elif self.isobject() and hasattr(self.__C,"getI"):
1847             return Covariance(self.__name+"I", asCovObject   = self.__C.getI() )
1848         else:
1849             return None # Indispensable
1850
1851     def getT(self):
1852         "Transposition"
1853         if   self.ismatrix():
1854             return Covariance(self.__name+"T", asCovariance  = self.__C.T )
1855         elif self.isvector():
1856             return Covariance(self.__name+"T", asEyeByVector = self.__C )
1857         elif self.isscalar():
1858             return Covariance(self.__name+"T", asEyeByScalar = self.__C )
1859         elif self.isobject() and hasattr(self.__C,"getT"):
1860             return Covariance(self.__name+"T", asCovObject   = self.__C.getT() )
1861         else:
1862             raise AttributeError("the %s covariance matrix has no getT attribute."%(self.__name,))
1863
1864     def cholesky(self):
1865         "Décomposition de Cholesky"
1866         if   self.ismatrix():
1867             return Covariance(self.__name+"C", asCovariance  = numpy.linalg.cholesky(self.__C) )
1868         elif self.isvector():
1869             return Covariance(self.__name+"C", asEyeByVector = numpy.sqrt( self.__C ) )
1870         elif self.isscalar():
1871             return Covariance(self.__name+"C", asEyeByScalar = numpy.sqrt( self.__C ) )
1872         elif self.isobject() and hasattr(self.__C,"cholesky"):
1873             return Covariance(self.__name+"C", asCovObject   = self.__C.cholesky() )
1874         else:
1875             raise AttributeError("the %s covariance matrix has no cholesky attribute."%(self.__name,))
1876
1877     def choleskyI(self):
1878         "Inversion de la décomposition de Cholesky"
1879         if   self.ismatrix():
1880             return Covariance(self.__name+"H", asCovariance  = numpy.linalg.inv(numpy.linalg.cholesky(self.__C)) )
1881         elif self.isvector():
1882             return Covariance(self.__name+"H", asEyeByVector = 1.0 / numpy.sqrt( self.__C ) )
1883         elif self.isscalar():
1884             return Covariance(self.__name+"H", asEyeByScalar = 1.0 / numpy.sqrt( self.__C ) )
1885         elif self.isobject() and hasattr(self.__C,"choleskyI"):
1886             return Covariance(self.__name+"H", asCovObject   = self.__C.choleskyI() )
1887         else:
1888             raise AttributeError("the %s covariance matrix has no choleskyI attribute."%(self.__name,))
1889
1890     def sqrtm(self):
1891         "Racine carrée matricielle"
1892         if   self.ismatrix():
1893             import scipy
1894             return Covariance(self.__name+"C", asCovariance  = numpy.real(scipy.linalg.sqrtm(self.__C)) )
1895         elif self.isvector():
1896             return Covariance(self.__name+"C", asEyeByVector = numpy.sqrt( self.__C ) )
1897         elif self.isscalar():
1898             return Covariance(self.__name+"C", asEyeByScalar = numpy.sqrt( self.__C ) )
1899         elif self.isobject() and hasattr(self.__C,"sqrtm"):
1900             return Covariance(self.__name+"C", asCovObject   = self.__C.sqrtm() )
1901         else:
1902             raise AttributeError("the %s covariance matrix has no sqrtm attribute."%(self.__name,))
1903
1904     def sqrtmI(self):
1905         "Inversion de la racine carrée matricielle"
1906         if   self.ismatrix():
1907             import scipy
1908             return Covariance(self.__name+"H", asCovariance  = numpy.linalg.inv(numpy.real(scipy.linalg.sqrtm(self.__C))) )
1909         elif self.isvector():
1910             return Covariance(self.__name+"H", asEyeByVector = 1.0 / numpy.sqrt( self.__C ) )
1911         elif self.isscalar():
1912             return Covariance(self.__name+"H", asEyeByScalar = 1.0 / numpy.sqrt( self.__C ) )
1913         elif self.isobject() and hasattr(self.__C,"sqrtmI"):
1914             return Covariance(self.__name+"H", asCovObject   = self.__C.sqrtmI() )
1915         else:
1916             raise AttributeError("the %s covariance matrix has no sqrtmI attribute."%(self.__name,))
1917
1918     def diag(self, msize=None):
1919         "Diagonale de la matrice"
1920         if   self.ismatrix():
1921             return numpy.diag(self.__C)
1922         elif self.isvector():
1923             return self.__C
1924         elif self.isscalar():
1925             if msize is None:
1926                 raise ValueError("the size of the %s covariance matrix has to be given in case of definition as a scalar over the diagonal."%(self.__name,))
1927             else:
1928                 return self.__C * numpy.ones(int(msize))
1929         elif self.isobject() and hasattr(self.__C,"diag"):
1930             return self.__C.diag()
1931         else:
1932             raise AttributeError("the %s covariance matrix has no diag attribute."%(self.__name,))
1933
1934     def asfullmatrix(self, msize=None):
1935         "Matrice pleine"
1936         if   self.ismatrix():
1937             return numpy.asarray(self.__C)
1938         elif self.isvector():
1939             return numpy.asarray( numpy.diag(self.__C), float )
1940         elif self.isscalar():
1941             if msize is None:
1942                 raise ValueError("the size of the %s covariance matrix has to be given in case of definition as a scalar over the diagonal."%(self.__name,))
1943             else:
1944                 return numpy.asarray( self.__C * numpy.eye(int(msize)), float )
1945         elif self.isobject() and hasattr(self.__C,"asfullmatrix"):
1946             return self.__C.asfullmatrix()
1947         else:
1948             raise AttributeError("the %s covariance matrix has no asfullmatrix attribute."%(self.__name,))
1949
1950     def trace(self, msize=None):
1951         "Trace de la matrice"
1952         if   self.ismatrix():
1953             return numpy.trace(self.__C)
1954         elif self.isvector():
1955             return float(numpy.sum(self.__C))
1956         elif self.isscalar():
1957             if msize is None:
1958                 raise ValueError("the size of the %s covariance matrix has to be given in case of definition as a scalar over the diagonal."%(self.__name,))
1959             else:
1960                 return self.__C * int(msize)
1961         elif self.isobject():
1962             return self.__C.trace()
1963         else:
1964             raise AttributeError("the %s covariance matrix has no trace attribute."%(self.__name,))
1965
1966     def getO(self):
1967         return self
1968
1969     def __repr__(self):
1970         "x.__repr__() <==> repr(x)"
1971         return repr(self.__C)
1972
1973     def __str__(self):
1974         "x.__str__() <==> str(x)"
1975         return str(self.__C)
1976
1977     def __add__(self, other):
1978         "x.__add__(y) <==> x+y"
1979         if   self.ismatrix() or self.isobject():
1980             return self.__C + numpy.asmatrix(other)
1981         elif self.isvector() or self.isscalar():
1982             _A = numpy.asarray(other)
1983             _A.reshape(_A.size)[::_A.shape[1]+1] += self.__C
1984             return numpy.asmatrix(_A)
1985
1986     def __radd__(self, other):
1987         "x.__radd__(y) <==> y+x"
1988         raise NotImplementedError("%s covariance matrix __radd__ method not available for %s type!"%(self.__name,type(other)))
1989
1990     def __sub__(self, other):
1991         "x.__sub__(y) <==> x-y"
1992         if   self.ismatrix() or self.isobject():
1993             return self.__C - numpy.asmatrix(other)
1994         elif self.isvector() or self.isscalar():
1995             _A = numpy.asarray(other)
1996             _A.reshape(_A.size)[::_A.shape[1]+1] = self.__C - _A.reshape(_A.size)[::_A.shape[1]+1]
1997             return numpy.asmatrix(_A)
1998
1999     def __rsub__(self, other):
2000         "x.__rsub__(y) <==> y-x"
2001         raise NotImplementedError("%s covariance matrix __rsub__ method not available for %s type!"%(self.__name,type(other)))
2002
2003     def __neg__(self):
2004         "x.__neg__() <==> -x"
2005         return - self.__C
2006
2007     def __matmul__(self, other):
2008         "x.__mul__(y) <==> x@y"
2009         if   self.ismatrix() and isinstance(other, (int, float)):
2010             return numpy.asarray(self.__C) * other
2011         elif self.ismatrix() and isinstance(other, (list, numpy.matrix, numpy.ndarray, tuple)):
2012             if numpy.ravel(other).size == self.shape[1]: # Vecteur
2013                 return numpy.ravel(self.__C @ numpy.ravel(other))
2014             elif numpy.asarray(other).shape[0] == self.shape[1]: # Matrice
2015                 return numpy.asarray(self.__C) @ numpy.asarray(other)
2016             else:
2017                 raise ValueError("operands could not be broadcast together with shapes %s %s in %s matrix"%(self.shape,numpy.asarray(other).shape,self.__name))
2018         elif self.isvector() and isinstance(other, (list, numpy.matrix, numpy.ndarray, tuple)):
2019             if numpy.ravel(other).size == self.shape[1]: # Vecteur
2020                 return numpy.ravel(self.__C) * numpy.ravel(other)
2021             elif numpy.asarray(other).shape[0] == self.shape[1]: # Matrice
2022                 return numpy.ravel(self.__C).reshape((-1,1)) * numpy.asarray(other)
2023             else:
2024                 raise ValueError("operands could not be broadcast together with shapes %s %s in %s matrix"%(self.shape,numpy.ravel(other).shape,self.__name))
2025         elif self.isscalar() and isinstance(other,numpy.matrix):
2026             return numpy.asarray(self.__C * other)
2027         elif self.isscalar() and isinstance(other, (list, numpy.ndarray, tuple)):
2028             if len(numpy.asarray(other).shape) == 1 or numpy.asarray(other).shape[1] == 1 or numpy.asarray(other).shape[0] == 1:
2029                 return self.__C * numpy.ravel(other)
2030             else:
2031                 return self.__C * numpy.asarray(other)
2032         elif self.isobject():
2033             return self.__C.__matmul__(other)
2034         else:
2035             raise NotImplementedError("%s covariance matrix __matmul__ method not available for %s type!"%(self.__name,type(other)))
2036
2037     def __mul__(self, other):
2038         "x.__mul__(y) <==> x*y"
2039         if   self.ismatrix() and isinstance(other, (int, numpy.matrix, float)):
2040             return self.__C * other
2041         elif self.ismatrix() and isinstance(other, (list, numpy.ndarray, tuple)):
2042             if numpy.ravel(other).size == self.shape[1]: # Vecteur
2043                 return self.__C * numpy.asmatrix(numpy.ravel(other)).T
2044             elif numpy.asmatrix(other).shape[0] == self.shape[1]: # Matrice
2045                 return self.__C * numpy.asmatrix(other)
2046             else:
2047                 raise ValueError("operands could not be broadcast together with shapes %s %s in %s matrix"%(self.shape,numpy.asmatrix(other).shape,self.__name))
2048         elif self.isvector() and isinstance(other, (list, numpy.matrix, numpy.ndarray, tuple)):
2049             if numpy.ravel(other).size == self.shape[1]: # Vecteur
2050                 return numpy.asmatrix(self.__C * numpy.ravel(other)).T
2051             elif numpy.asmatrix(other).shape[0] == self.shape[1]: # Matrice
2052                 return numpy.asmatrix((self.__C * (numpy.asarray(other).transpose())).transpose())
2053             else:
2054                 raise ValueError("operands could not be broadcast together with shapes %s %s in %s matrix"%(self.shape,numpy.ravel(other).shape,self.__name))
2055         elif self.isscalar() and isinstance(other,numpy.matrix):
2056             return self.__C * other
2057         elif self.isscalar() and isinstance(other, (list, numpy.ndarray, tuple)):
2058             if len(numpy.asarray(other).shape) == 1 or numpy.asarray(other).shape[1] == 1 or numpy.asarray(other).shape[0] == 1:
2059                 return self.__C * numpy.asmatrix(numpy.ravel(other)).T
2060             else:
2061                 return self.__C * numpy.asmatrix(other)
2062         elif self.isobject():
2063             return self.__C.__mul__(other)
2064         else:
2065             raise NotImplementedError("%s covariance matrix __mul__ method not available for %s type!"%(self.__name,type(other)))
2066
2067     def __rmatmul__(self, other):
2068         "x.__rmul__(y) <==> y@x"
2069         if self.ismatrix() and isinstance(other, (int, numpy.matrix, float)):
2070             return other * self.__C
2071         elif self.ismatrix() and isinstance(other, (list, numpy.ndarray, tuple)):
2072             if numpy.ravel(other).size == self.shape[1]: # Vecteur
2073                 return numpy.asmatrix(numpy.ravel(other)) * self.__C
2074             elif numpy.asmatrix(other).shape[0] == self.shape[1]: # Matrice
2075                 return numpy.asmatrix(other) * self.__C
2076             else:
2077                 raise ValueError("operands could not be broadcast together with shapes %s %s in %s matrix"%(numpy.asmatrix(other).shape,self.shape,self.__name))
2078         elif self.isvector() and isinstance(other,numpy.matrix):
2079             if numpy.ravel(other).size == self.shape[0]: # Vecteur
2080                 return numpy.asmatrix(numpy.ravel(other) * self.__C)
2081             elif numpy.asmatrix(other).shape[1] == self.shape[0]: # Matrice
2082                 return numpy.asmatrix(numpy.array(other) * self.__C)
2083             else:
2084                 raise ValueError("operands could not be broadcast together with shapes %s %s in %s matrix"%(numpy.ravel(other).shape,self.shape,self.__name))
2085         elif self.isscalar() and isinstance(other,numpy.matrix):
2086             return other * self.__C
2087         elif self.isobject():
2088             return self.__C.__rmatmul__(other)
2089         else:
2090             raise NotImplementedError("%s covariance matrix __rmatmul__ method not available for %s type!"%(self.__name,type(other)))
2091
2092     def __rmul__(self, other):
2093         "x.__rmul__(y) <==> y*x"
2094         if self.ismatrix() and isinstance(other, (int, numpy.matrix, float)):
2095             return other * self.__C
2096         elif self.ismatrix() and isinstance(other, (list, numpy.ndarray, tuple)):
2097             if numpy.ravel(other).size == self.shape[1]: # Vecteur
2098                 return numpy.asmatrix(numpy.ravel(other)) * self.__C
2099             elif numpy.asmatrix(other).shape[0] == self.shape[1]: # Matrice
2100                 return numpy.asmatrix(other) * self.__C
2101             else:
2102                 raise ValueError("operands could not be broadcast together with shapes %s %s in %s matrix"%(numpy.asmatrix(other).shape,self.shape,self.__name))
2103         elif self.isvector() and isinstance(other,numpy.matrix):
2104             if numpy.ravel(other).size == self.shape[0]: # Vecteur
2105                 return numpy.asmatrix(numpy.ravel(other) * self.__C)
2106             elif numpy.asmatrix(other).shape[1] == self.shape[0]: # Matrice
2107                 return numpy.asmatrix(numpy.array(other) * self.__C)
2108             else:
2109                 raise ValueError("operands could not be broadcast together with shapes %s %s in %s matrix"%(numpy.ravel(other).shape,self.shape,self.__name))
2110         elif self.isscalar() and isinstance(other,numpy.matrix):
2111             return other * self.__C
2112         elif self.isobject():
2113             return self.__C.__rmul__(other)
2114         else:
2115             raise NotImplementedError("%s covariance matrix __rmul__ method not available for %s type!"%(self.__name,type(other)))
2116
2117     def __len__(self):
2118         "x.__len__() <==> len(x)"
2119         return self.shape[0]
2120
2121 # ==============================================================================
2122 class Observer2Func(object):
2123     """
2124     Creation d'une fonction d'observateur a partir de son texte
2125     """
2126     def __init__(self, corps=""):
2127         self.__corps = corps
2128     def func(self,var,info):
2129         "Fonction d'observation"
2130         exec(self.__corps)
2131     def getfunc(self):
2132         "Restitution du pointeur de fonction dans l'objet"
2133         return self.func
2134
2135 # ==============================================================================
2136 class CaseLogger(object):
2137     """
2138     Conservation des commandes de creation d'un cas
2139     """
2140     def __init__(self, __name="", __objname="case", __addViewers=None, __addLoaders=None):
2141         self.__name     = str(__name)
2142         self.__objname  = str(__objname)
2143         self.__logSerie = []
2144         self.__switchoff = False
2145         self.__viewers = {
2146             "TUI" :Interfaces._TUIViewer,
2147             "SCD" :Interfaces._SCDViewer,
2148             "YACS":Interfaces._YACSViewer,
2149             }
2150         self.__loaders = {
2151             "TUI" :Interfaces._TUIViewer,
2152             "COM" :Interfaces._COMViewer,
2153             }
2154         if __addViewers is not None:
2155             self.__viewers.update(dict(__addViewers))
2156         if __addLoaders is not None:
2157             self.__loaders.update(dict(__addLoaders))
2158
2159     def register(self, __command=None, __keys=None, __local=None, __pre=None, __switchoff=False):
2160         "Enregistrement d'une commande individuelle"
2161         if __command is not None and __keys is not None and __local is not None and not self.__switchoff:
2162             if "self" in __keys: __keys.remove("self")
2163             self.__logSerie.append( (str(__command), __keys, __local, __pre, __switchoff) )
2164             if __switchoff:
2165                 self.__switchoff = True
2166         if not __switchoff:
2167             self.__switchoff = False
2168
2169     def dump(self, __filename=None, __format="TUI", __upa=""):
2170         "Restitution normalisée des commandes"
2171         if __format in self.__viewers:
2172             __formater = self.__viewers[__format](self.__name, self.__objname, self.__logSerie)
2173         else:
2174             raise ValueError("Dumping as \"%s\" is not available"%__format)
2175         return __formater.dump(__filename, __upa)
2176
2177     def load(self, __filename=None, __content=None, __object=None, __format="TUI"):
2178         "Chargement normalisé des commandes"
2179         if __format in self.__loaders:
2180             __formater = self.__loaders[__format]()
2181         else:
2182             raise ValueError("Loading as \"%s\" is not available"%__format)
2183         return __formater.load(__filename, __content, __object)
2184
2185 # ==============================================================================
2186 def MultiFonction(
2187         __xserie,
2188         _extraArguments = None,
2189         _sFunction      = lambda x: x,
2190         _mpEnabled      = False,
2191         _mpWorkers      = None,
2192         ):
2193     """
2194     Pour une liste ordonnée de vecteurs en entrée, renvoie en sortie la liste
2195     correspondante de valeurs de la fonction en argument
2196     """
2197     # Vérifications et définitions initiales
2198     # logging.debug("MULTF Internal multifonction calculations begin with function %s"%(_sFunction.__name__,))
2199     if not PlatformInfo.isIterable( __xserie ):
2200         raise TypeError("MultiFonction not iterable unkown input type: %s"%(type(__xserie),))
2201     if _mpEnabled:
2202         if (_mpWorkers is None) or (_mpWorkers is not None and _mpWorkers < 1):
2203             __mpWorkers = None
2204         else:
2205             __mpWorkers = int(_mpWorkers)
2206         try:
2207             import multiprocessing
2208             __mpEnabled = True
2209         except ImportError:
2210             __mpEnabled = False
2211     else:
2212         __mpEnabled = False
2213         __mpWorkers = None
2214     #
2215     # Calculs effectifs
2216     if __mpEnabled:
2217         _jobs = __xserie
2218         # logging.debug("MULTF Internal multiprocessing calculations begin : evaluation of %i point(s)"%(len(_jobs),))
2219         import multiprocessing
2220         with multiprocessing.Pool(__mpWorkers) as pool:
2221             __multiHX = pool.map( _sFunction, _jobs )
2222             pool.close()
2223             pool.join()
2224         # logging.debug("MULTF Internal multiprocessing calculation end")
2225     else:
2226         # logging.debug("MULTF Internal monoprocessing calculation begin")
2227         __multiHX = []
2228         if _extraArguments is None:
2229             for __xvalue in __xserie:
2230                 __multiHX.append( _sFunction( __xvalue ) )
2231         elif _extraArguments is not None and isinstance(_extraArguments, (list, tuple, map)):
2232             for __xvalue in __xserie:
2233                 __multiHX.append( _sFunction( __xvalue, *_extraArguments ) )
2234         elif _extraArguments is not None and isinstance(_extraArguments, dict):
2235             for __xvalue in __xserie:
2236                 __multiHX.append( _sFunction( __xvalue, **_extraArguments ) )
2237         else:
2238             raise TypeError("MultiFonction extra arguments unkown input type: %s"%(type(_extraArguments),))
2239         # logging.debug("MULTF Internal monoprocessing calculation end")
2240     #
2241     # logging.debug("MULTF Internal multifonction calculations end")
2242     return __multiHX
2243
2244 # ==============================================================================
2245 def CostFunction3D(_x,
2246                    _Hm  = None,  # Pour simuler Hm(x) : HO["Direct"].appliedTo
2247                    _HmX = None,  # Simulation déjà faite de Hm(x)
2248                    _arg = None,  # Arguments supplementaires pour Hm, sous la forme d'un tuple
2249                    _BI  = None,
2250                    _RI  = None,
2251                    _Xb  = None,
2252                    _Y   = None,
2253                    _SIV = False, # A résorber pour la 8.0
2254                    _SSC = [],    # self._parameters["StoreSupplementaryCalculations"]
2255                    _nPS = 0,     # nbPreviousSteps
2256                    _QM  = "DA",  # QualityMeasure
2257                    _SSV = {},    # Entrée et/ou sortie : self.StoredVariables
2258                    _fRt = False, # Restitue ou pas la sortie étendue
2259                    _sSc = True,  # Stocke ou pas les SSC
2260                   ):
2261     """
2262     Fonction-coût générale utile pour les algorithmes statiques/3D : 3DVAR, BLUE
2263     et dérivés, Kalman et dérivés, LeastSquares, SamplingTest, PSO, SA, Tabu,
2264     DFO, QuantileRegression
2265     """
2266     if not _sSc:
2267         _SIV = False
2268         _SSC = {}
2269     else:
2270         for k in ["CostFunctionJ",
2271                   "CostFunctionJb",
2272                   "CostFunctionJo",
2273                   "CurrentOptimum",
2274                   "CurrentState",
2275                   "IndexOfOptimum",
2276                   "SimulatedObservationAtCurrentOptimum",
2277                   "SimulatedObservationAtCurrentState",
2278                  ]:
2279             if k not in _SSV:
2280                 _SSV[k] = []
2281             if hasattr(_SSV[k],"store"):
2282                 _SSV[k].append = _SSV[k].store # Pour utiliser "append" au lieu de "store"
2283     #
2284     _X  = numpy.asmatrix(numpy.ravel( _x )).T
2285     if _SIV or "CurrentState" in _SSC or "CurrentOptimum" in _SSC:
2286         _SSV["CurrentState"].append( _X )
2287     #
2288     if _HmX is not None:
2289         _HX = _HmX
2290     else:
2291         if _Hm is None:
2292             raise ValueError("COSTFUNCTION3D Operator has to be defined.")
2293         if _arg is None:
2294             _HX = _Hm( _X )
2295         else:
2296             _HX = _Hm( _X, *_arg )
2297     _HX = numpy.asmatrix(numpy.ravel( _HX )).T
2298     #
2299     if "SimulatedObservationAtCurrentState" in _SSC or \
2300        "SimulatedObservationAtCurrentOptimum" in _SSC:
2301         _SSV["SimulatedObservationAtCurrentState"].append( _HX )
2302     #
2303     if numpy.any(numpy.isnan(_HX)):
2304         Jb, Jo, J = numpy.nan, numpy.nan, numpy.nan
2305     else:
2306         _Y   = numpy.asmatrix(numpy.ravel( _Y )).T
2307         if _QM in ["AugmentedWeightedLeastSquares", "AWLS", "AugmentedPonderatedLeastSquares", "APLS", "DA"]:
2308             if _BI is None or _RI is None:
2309                 raise ValueError("Background and Observation error covariance matrix has to be properly defined!")
2310             _Xb  = numpy.asmatrix(numpy.ravel( _Xb )).T
2311             Jb  = 0.5 * (_X - _Xb).T * _BI * (_X - _Xb)
2312             Jo  = 0.5 * (_Y - _HX).T * _RI * (_Y - _HX)
2313         elif _QM in ["WeightedLeastSquares", "WLS", "PonderatedLeastSquares", "PLS"]:
2314             if _RI is None:
2315                 raise ValueError("Observation error covariance matrix has to be properly defined!")
2316             Jb  = 0.
2317             Jo  = 0.5 * (_Y - _HX).T * _RI * (_Y - _HX)
2318         elif _QM in ["LeastSquares", "LS", "L2"]:
2319             Jb  = 0.
2320             Jo  = 0.5 * (_Y - _HX).T * (_Y - _HX)
2321         elif _QM in ["AbsoluteValue", "L1"]:
2322             Jb  = 0.
2323             Jo  = numpy.sum( numpy.abs(_Y - _HX) )
2324         elif _QM in ["MaximumError", "ME"]:
2325             Jb  = 0.
2326             Jo  = numpy.max( numpy.abs(_Y - _HX) )
2327         elif _QM in ["QR", "Null"]:
2328             Jb  = 0.
2329             Jo  = 0.
2330         else:
2331             raise ValueError("Unknown asked quality measure!")
2332         #
2333         J   = float( Jb ) + float( Jo )
2334     #
2335     if _sSc:
2336         _SSV["CostFunctionJb"].append( Jb )
2337         _SSV["CostFunctionJo"].append( Jo )
2338         _SSV["CostFunctionJ" ].append( J )
2339     #
2340     if "IndexOfOptimum" in _SSC or \
2341        "CurrentOptimum" in _SSC or \
2342        "SimulatedObservationAtCurrentOptimum" in _SSC:
2343         IndexMin = numpy.argmin( _SSV["CostFunctionJ"][_nPS:] ) + _nPS
2344     if "IndexOfOptimum" in _SSC:
2345         _SSV["IndexOfOptimum"].append( IndexMin )
2346     if "CurrentOptimum" in _SSC:
2347         _SSV["CurrentOptimum"].append( _SSV["CurrentState"][IndexMin] )
2348     if "SimulatedObservationAtCurrentOptimum" in _SSC:
2349         _SSV["SimulatedObservationAtCurrentOptimum"].append( _SSV["SimulatedObservationAtCurrentState"][IndexMin] )
2350     #
2351     if _fRt:
2352         return _SSV
2353     else:
2354         if _QM in ["QR"]: # Pour le QuantileRegression
2355             return _HX
2356         else:
2357             return J
2358
2359 # ==============================================================================
2360 if __name__ == "__main__":
2361     print('\n AUTODIAGNOSTIC\n')