Salome HOME
Minor message and documentation corrections
[modules/adao.git] / src / daComposant / daCore / NumericObjects.py
1 # -*- coding: utf-8 -*-
2 #
3 # Copyright (C) 2008-2019 EDF R&D
4 #
5 # This library is free software; you can redistribute it and/or
6 # modify it under the terms of the GNU Lesser General Public
7 # License as published by the Free Software Foundation; either
8 # version 2.1 of the License.
9 #
10 # This library is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13 # Lesser General Public License for more details.
14 #
15 # You should have received a copy of the GNU Lesser General Public
16 # License along with this library; if not, write to the Free Software
17 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
18 #
19 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
20 #
21 # Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D
22
23 __doc__ = """
24     Définit les versions approximées des opérateurs tangents et adjoints.
25 """
26 __author__ = "Jean-Philippe ARGAUD"
27
28 import os, time, copy, types, sys, logging
29 import math, numpy, scipy
30 from daCore.BasicObjects import Operator
31 from daCore.PlatformInfo import PlatformInfo
32 mpr = PlatformInfo().MachinePrecision()
33 mfp = PlatformInfo().MaximumPrecision()
34 # logging.getLogger().setLevel(logging.DEBUG)
35
36 # ==============================================================================
37 def ExecuteFunction( paire ):
38     assert len(paire) == 2, "Incorrect number of arguments"
39     X, funcrepr = paire
40     __X = numpy.asmatrix(numpy.ravel( X )).T
41     __sys_path_tmp = sys.path ; sys.path.insert(0,funcrepr["__userFunction__path"])
42     __module = __import__(funcrepr["__userFunction__modl"], globals(), locals(), [])
43     __fonction = getattr(__module,funcrepr["__userFunction__name"])
44     sys.path = __sys_path_tmp ; del __sys_path_tmp
45     __HX  = __fonction( __X )
46     return numpy.ravel( __HX )
47
48 # ==============================================================================
49 class FDApproximation(object):
50     """
51     Cette classe sert d'interface pour définir les opérateurs approximés. A la
52     création d'un objet, en fournissant une fonction "Function", on obtient un
53     objet qui dispose de 3 méthodes "DirectOperator", "TangentOperator" et
54     "AdjointOperator". On contrôle l'approximation DF avec l'incrément
55     multiplicatif "increment" valant par défaut 1%, ou avec l'incrément fixe
56     "dX" qui sera multiplié par "increment" (donc en %), et on effectue de DF
57     centrées si le booléen "centeredDF" est vrai.
58     """
59     def __init__(self,
60             Function              = None,
61             centeredDF            = False,
62             increment             = 0.01,
63             dX                    = None,
64             avoidingRedundancy    = True,
65             toleranceInRedundancy = 1.e-18,
66             lenghtOfRedundancy    = -1,
67             mpEnabled             = False,
68             mpWorkers             = None,
69             mfEnabled             = False,
70             ):
71         if mpEnabled:
72             try:
73                 import multiprocessing
74                 self.__mpEnabled = True
75             except ImportError:
76                 self.__mpEnabled = False
77         else:
78             self.__mpEnabled = False
79         self.__mpWorkers = mpWorkers
80         if self.__mpWorkers is not None and self.__mpWorkers < 1:
81             self.__mpWorkers = None
82         logging.debug("FDA Calculs en multiprocessing : %s (nombre de processus : %s)"%(self.__mpEnabled,self.__mpWorkers))
83         #
84         if mfEnabled:
85             self.__mfEnabled = True
86         else:
87             self.__mfEnabled = False
88         logging.debug("FDA Calculs en multifonctions : %s"%(self.__mfEnabled,))
89         #
90         if avoidingRedundancy:
91             self.__avoidRC = True
92             self.__tolerBP = float(toleranceInRedundancy)
93             self.__lenghtRJ = int(lenghtOfRedundancy)
94             self.__listJPCP = [] # Jacobian Previous Calculated Points
95             self.__listJPCI = [] # Jacobian Previous Calculated Increment
96             self.__listJPCR = [] # Jacobian Previous Calculated Results
97             self.__listJPPN = [] # Jacobian Previous Calculated Point Norms
98             self.__listJPIN = [] # Jacobian Previous Calculated Increment Norms
99         else:
100             self.__avoidRC = False
101         #
102         if self.__mpEnabled:
103             if isinstance(Function,types.FunctionType):
104                 logging.debug("FDA Calculs en multiprocessing : FunctionType")
105                 self.__userFunction__name = Function.__name__
106                 try:
107                     mod = os.path.join(Function.__globals__['filepath'],Function.__globals__['filename'])
108                 except:
109                     mod = os.path.abspath(Function.__globals__['__file__'])
110                 if not os.path.isfile(mod):
111                     raise ImportError("No user defined function or method found with the name %s"%(mod,))
112                 self.__userFunction__modl = os.path.basename(mod).replace('.pyc','').replace('.pyo','').replace('.py','')
113                 self.__userFunction__path = os.path.dirname(mod)
114                 del mod
115                 self.__userOperator = Operator( fromMethod = Function, avoidingRedundancy = self.__avoidRC, inputAsMultiFunction = self.__mfEnabled )
116                 self.__userFunction = self.__userOperator.appliedTo # Pour le calcul Direct
117             elif isinstance(Function,types.MethodType):
118                 logging.debug("FDA Calculs en multiprocessing : MethodType")
119                 self.__userFunction__name = Function.__name__
120                 try:
121                     mod = os.path.join(Function.__globals__['filepath'],Function.__globals__['filename'])
122                 except:
123                     mod = os.path.abspath(Function.__func__.__globals__['__file__'])
124                 if not os.path.isfile(mod):
125                     raise ImportError("No user defined function or method found with the name %s"%(mod,))
126                 self.__userFunction__modl = os.path.basename(mod).replace('.pyc','').replace('.pyo','').replace('.py','')
127                 self.__userFunction__path = os.path.dirname(mod)
128                 del mod
129                 self.__userOperator = Operator( fromMethod = Function, avoidingRedundancy = self.__avoidRC, inputAsMultiFunction = self.__mfEnabled )
130                 self.__userFunction = self.__userOperator.appliedTo # Pour le calcul Direct
131             else:
132                 raise TypeError("User defined function or method has to be provided for finite differences approximation.")
133         else:
134             self.__userOperator = Operator( fromMethod = Function, avoidingRedundancy = self.__avoidRC, inputAsMultiFunction = self.__mfEnabled )
135             self.__userFunction = self.__userOperator.appliedTo
136         #
137         self.__centeredDF = bool(centeredDF)
138         if abs(float(increment)) > 1.e-15:
139             self.__increment  = float(increment)
140         else:
141             self.__increment  = 0.01
142         if dX is None:
143             self.__dX     = None
144         else:
145             self.__dX     = numpy.asmatrix(numpy.ravel( dX )).T
146         logging.debug("FDA Reduction des doublons de calcul : %s"%self.__avoidRC)
147         if self.__avoidRC:
148             logging.debug("FDA Tolerance de determination des doublons : %.2e"%self.__tolerBP)
149
150     # ---------------------------------------------------------
151     def __doublon__(self, e, l, n, v=None):
152         __ac, __iac = False, -1
153         for i in range(len(l)-1,-1,-1):
154             if numpy.linalg.norm(e - l[i]) < self.__tolerBP * n[i]:
155                 __ac, __iac = True, i
156                 if v is not None: logging.debug("FDA Cas%s déja calculé, récupération du doublon %i"%(v,__iac))
157                 break
158         return __ac, __iac
159
160     # ---------------------------------------------------------
161     def DirectOperator(self, X ):
162         """
163         Calcul du direct à l'aide de la fonction fournie.
164         """
165         logging.debug("FDA Calcul DirectOperator (explicite)")
166         if self.__mfEnabled:
167             _HX = self.__userFunction( X, argsAsSerie = True )
168         else:
169             _X = numpy.asmatrix(numpy.ravel( X )).T
170             _HX = numpy.ravel(self.__userFunction( _X ))
171         #
172         return _HX
173
174     # ---------------------------------------------------------
175     def TangentMatrix(self, X ):
176         """
177         Calcul de l'opérateur tangent comme la Jacobienne par différences finies,
178         c'est-à-dire le gradient de H en X. On utilise des différences finies
179         directionnelles autour du point X. X est un numpy.matrix.
180
181         Différences finies centrées (approximation d'ordre 2):
182         1/ Pour chaque composante i de X, on ajoute et on enlève la perturbation
183            dX[i] à la  composante X[i], pour composer X_plus_dXi et X_moins_dXi, et
184            on calcule les réponses HX_plus_dXi = H( X_plus_dXi ) et HX_moins_dXi =
185            H( X_moins_dXi )
186         2/ On effectue les différences (HX_plus_dXi-HX_moins_dXi) et on divise par
187            le pas 2*dXi
188         3/ Chaque résultat, par composante, devient une colonne de la Jacobienne
189
190         Différences finies non centrées (approximation d'ordre 1):
191         1/ Pour chaque composante i de X, on ajoute la perturbation dX[i] à la
192            composante X[i] pour composer X_plus_dXi, et on calcule la réponse
193            HX_plus_dXi = H( X_plus_dXi )
194         2/ On calcule la valeur centrale HX = H(X)
195         3/ On effectue les différences (HX_plus_dXi-HX) et on divise par
196            le pas dXi
197         4/ Chaque résultat, par composante, devient une colonne de la Jacobienne
198
199         """
200         logging.debug("FDA Début du calcul de la Jacobienne")
201         logging.debug("FDA   Incrément de............: %s*X"%float(self.__increment))
202         logging.debug("FDA   Approximation centrée...: %s"%(self.__centeredDF))
203         #
204         if X is None or len(X)==0:
205             raise ValueError("Nominal point X for approximate derivatives can not be None or void (X=%s)."%(str(X),))
206         #
207         _X = numpy.asmatrix(numpy.ravel( X )).T
208         #
209         if self.__dX is None:
210             _dX  = self.__increment * _X
211         else:
212             _dX = numpy.asmatrix(numpy.ravel( self.__dX )).T
213         #
214         if (_dX == 0.).any():
215             moyenne = _dX.mean()
216             if moyenne == 0.:
217                 _dX = numpy.where( _dX == 0., float(self.__increment), _dX )
218             else:
219                 _dX = numpy.where( _dX == 0., moyenne, _dX )
220         #
221         __alreadyCalculated  = False
222         if self.__avoidRC:
223             __bidon, __alreadyCalculatedP = self.__doublon__(_X,  self.__listJPCP, self.__listJPPN, None)
224             __bidon, __alreadyCalculatedI = self.__doublon__(_dX, self.__listJPCI, self.__listJPIN, None)
225             if __alreadyCalculatedP == __alreadyCalculatedI > -1:
226                 __alreadyCalculated, __i = True, __alreadyCalculatedP
227                 logging.debug("FDA Cas J déja calculé, récupération du doublon %i"%__i)
228         #
229         if __alreadyCalculated:
230             logging.debug("FDA   Calcul Jacobienne (par récupération du doublon %i)"%__i)
231             _Jacobienne = self.__listJPCR[__i]
232         else:
233             logging.debug("FDA   Calcul Jacobienne (explicite)")
234             if self.__centeredDF:
235                 #
236                 if self.__mpEnabled and not self.__mfEnabled:
237                     funcrepr = {
238                         "__userFunction__path" : self.__userFunction__path,
239                         "__userFunction__modl" : self.__userFunction__modl,
240                         "__userFunction__name" : self.__userFunction__name,
241                     }
242                     _jobs = []
243                     for i in range( len(_dX) ):
244                         _dXi            = _dX[i]
245                         _X_plus_dXi     = numpy.array( _X.A1, dtype=float )
246                         _X_plus_dXi[i]  = _X[i] + _dXi
247                         _X_moins_dXi    = numpy.array( _X.A1, dtype=float )
248                         _X_moins_dXi[i] = _X[i] - _dXi
249                         #
250                         _jobs.append( (_X_plus_dXi,  funcrepr) )
251                         _jobs.append( (_X_moins_dXi, funcrepr) )
252                     #
253                     import multiprocessing
254                     self.__pool = multiprocessing.Pool(self.__mpWorkers)
255                     _HX_plusmoins_dX = self.__pool.map( ExecuteFunction, _jobs )
256                     self.__pool.close()
257                     self.__pool.join()
258                     #
259                     _Jacobienne  = []
260                     for i in range( len(_dX) ):
261                         _Jacobienne.append( numpy.ravel( _HX_plusmoins_dX[2*i] - _HX_plusmoins_dX[2*i+1] ) / (2.*_dX[i]) )
262                     #
263                 elif self.__mfEnabled:
264                     _xserie = []
265                     for i in range( len(_dX) ):
266                         _dXi            = _dX[i]
267                         _X_plus_dXi     = numpy.array( _X.A1, dtype=float )
268                         _X_plus_dXi[i]  = _X[i] + _dXi
269                         _X_moins_dXi    = numpy.array( _X.A1, dtype=float )
270                         _X_moins_dXi[i] = _X[i] - _dXi
271                         #
272                         _xserie.append( _X_plus_dXi )
273                         _xserie.append( _X_moins_dXi )
274                     #
275                     _HX_plusmoins_dX = self.DirectOperator( _xserie )
276                      #
277                     _Jacobienne  = []
278                     for i in range( len(_dX) ):
279                         _Jacobienne.append( numpy.ravel( _HX_plusmoins_dX[2*i] - _HX_plusmoins_dX[2*i+1] ) / (2.*_dX[i]) )
280                     #
281                 else:
282                     _Jacobienne  = []
283                     for i in range( _dX.size ):
284                         _dXi            = _dX[i]
285                         _X_plus_dXi     = numpy.array( _X.A1, dtype=float )
286                         _X_plus_dXi[i]  = _X[i] + _dXi
287                         _X_moins_dXi    = numpy.array( _X.A1, dtype=float )
288                         _X_moins_dXi[i] = _X[i] - _dXi
289                         #
290                         _HX_plus_dXi    = self.DirectOperator( _X_plus_dXi )
291                         _HX_moins_dXi   = self.DirectOperator( _X_moins_dXi )
292                         #
293                         _Jacobienne.append( numpy.ravel( _HX_plus_dXi - _HX_moins_dXi ) / (2.*_dXi) )
294                 #
295             else:
296                 #
297                 if self.__mpEnabled and not self.__mfEnabled:
298                     funcrepr = {
299                         "__userFunction__path" : self.__userFunction__path,
300                         "__userFunction__modl" : self.__userFunction__modl,
301                         "__userFunction__name" : self.__userFunction__name,
302                     }
303                     _jobs = []
304                     _jobs.append( (_X.A1, funcrepr) )
305                     for i in range( len(_dX) ):
306                         _X_plus_dXi    = numpy.array( _X.A1, dtype=float )
307                         _X_plus_dXi[i] = _X[i] + _dX[i]
308                         #
309                         _jobs.append( (_X_plus_dXi, funcrepr) )
310                     #
311                     import multiprocessing
312                     self.__pool = multiprocessing.Pool(self.__mpWorkers)
313                     _HX_plus_dX = self.__pool.map( ExecuteFunction, _jobs )
314                     self.__pool.close()
315                     self.__pool.join()
316                     #
317                     _HX = _HX_plus_dX.pop(0)
318                     #
319                     _Jacobienne = []
320                     for i in range( len(_dX) ):
321                         _Jacobienne.append( numpy.ravel(( _HX_plus_dX[i] - _HX ) / _dX[i]) )
322                     #
323                 elif self.__mfEnabled:
324                     _xserie = []
325                     _xserie.append( _X.A1 )
326                     for i in range( len(_dX) ):
327                         _X_plus_dXi    = numpy.array( _X.A1, dtype=float )
328                         _X_plus_dXi[i] = _X[i] + _dX[i]
329                         #
330                         _xserie.append( _X_plus_dXi )
331                     #
332                     _HX_plus_dX = self.DirectOperator( _xserie )
333                     #
334                     _HX = _HX_plus_dX.pop(0)
335                     #
336                     _Jacobienne = []
337                     for i in range( len(_dX) ):
338                         _Jacobienne.append( numpy.ravel(( _HX_plus_dX[i] - _HX ) / _dX[i]) )
339                    #
340                 else:
341                     _Jacobienne  = []
342                     _HX = self.DirectOperator( _X )
343                     for i in range( _dX.size ):
344                         _dXi            = _dX[i]
345                         _X_plus_dXi     = numpy.array( _X.A1, dtype=float )
346                         _X_plus_dXi[i]  = _X[i] + _dXi
347                         #
348                         _HX_plus_dXi = self.DirectOperator( _X_plus_dXi )
349                         #
350                         _Jacobienne.append( numpy.ravel(( _HX_plus_dXi - _HX ) / _dXi) )
351                 #
352             #
353             _Jacobienne = numpy.asmatrix( numpy.vstack( _Jacobienne ) ).T
354             if self.__avoidRC:
355                 if self.__lenghtRJ < 0: self.__lenghtRJ = 2 * _X.size
356                 while len(self.__listJPCP) > self.__lenghtRJ:
357                     self.__listJPCP.pop(0)
358                     self.__listJPCI.pop(0)
359                     self.__listJPCR.pop(0)
360                     self.__listJPPN.pop(0)
361                     self.__listJPIN.pop(0)
362                 self.__listJPCP.append( copy.copy(_X) )
363                 self.__listJPCI.append( copy.copy(_dX) )
364                 self.__listJPCR.append( copy.copy(_Jacobienne) )
365                 self.__listJPPN.append( numpy.linalg.norm(_X) )
366                 self.__listJPIN.append( numpy.linalg.norm(_Jacobienne) )
367         #
368         logging.debug("FDA Fin du calcul de la Jacobienne")
369         #
370         return _Jacobienne
371
372     # ---------------------------------------------------------
373     def TangentOperator(self, paire ):
374         """
375         Calcul du tangent à l'aide de la Jacobienne.
376         """
377         if self.__mfEnabled:
378             assert len(paire) == 1, "Incorrect lenght of arguments"
379             _paire = paire[0]
380             assert len(_paire) == 2, "Incorrect number of arguments"
381         else:
382             assert len(paire) == 2, "Incorrect number of arguments"
383             _paire = paire
384         X, dX = _paire
385         _Jacobienne = self.TangentMatrix( X )
386         if dX is None or len(dX) == 0:
387             #
388             # Calcul de la forme matricielle si le second argument est None
389             # -------------------------------------------------------------
390             if self.__mfEnabled: return [_Jacobienne,]
391             else:                return _Jacobienne
392         else:
393             #
394             # Calcul de la valeur linéarisée de H en X appliqué à dX
395             # ------------------------------------------------------
396             _dX = numpy.asmatrix(numpy.ravel( dX )).T
397             _HtX = numpy.dot(_Jacobienne, _dX)
398             if self.__mfEnabled: return [_HtX.A1,]
399             else:                return _HtX.A1
400
401     # ---------------------------------------------------------
402     def AdjointOperator(self, paire ):
403         """
404         Calcul de l'adjoint à l'aide de la Jacobienne.
405         """
406         if self.__mfEnabled:
407             assert len(paire) == 1, "Incorrect lenght of arguments"
408             _paire = paire[0]
409             assert len(_paire) == 2, "Incorrect number of arguments"
410         else:
411             assert len(paire) == 2, "Incorrect number of arguments"
412             _paire = paire
413         X, Y = _paire
414         _JacobienneT = self.TangentMatrix( X ).T
415         if Y is None or len(Y) == 0:
416             #
417             # Calcul de la forme matricielle si le second argument est None
418             # -------------------------------------------------------------
419             if self.__mfEnabled: return [_JacobienneT,]
420             else:                return _JacobienneT
421         else:
422             #
423             # Calcul de la valeur de l'adjoint en X appliqué à Y
424             # --------------------------------------------------
425             _Y = numpy.asmatrix(numpy.ravel( Y )).T
426             _HaY = numpy.dot(_JacobienneT, _Y)
427             if self.__mfEnabled: return [_HaY.A1,]
428             else:                return _HaY.A1
429
430 # ==============================================================================
431 def mmqr(
432         func     = None,
433         x0       = None,
434         fprime   = None,
435         bounds   = None,
436         quantile = 0.5,
437         maxfun   = 15000,
438         toler    = 1.e-06,
439         y        = None,
440         ):
441     """
442     Implémentation informatique de l'algorithme MMQR, basée sur la publication :
443     David R. Hunter, Kenneth Lange, "Quantile Regression via an MM Algorithm",
444     Journal of Computational and Graphical Statistics, 9, 1, pp.60-77, 2000.
445     """
446     #
447     # Recuperation des donnees et informations initiales
448     # --------------------------------------------------
449     variables = numpy.ravel( x0 )
450     mesures   = numpy.ravel( y )
451     increment = sys.float_info[0]
452     p         = variables.size
453     n         = mesures.size
454     quantile  = float(quantile)
455     #
456     # Calcul des parametres du MM
457     # ---------------------------
458     tn      = float(toler) / n
459     e0      = -tn / math.log(tn)
460     epsilon = (e0-tn)/(1+math.log(e0))
461     #
462     # Calculs d'initialisation
463     # ------------------------
464     residus  = mesures - numpy.ravel( func( variables ) )
465     poids    = 1./(epsilon+numpy.abs(residus))
466     veps     = 1. - 2. * quantile - residus * poids
467     lastsurrogate = -numpy.sum(residus*veps) - (1.-2.*quantile)*numpy.sum(residus)
468     iteration = 0
469     #
470     # Recherche iterative
471     # -------------------
472     while (increment > toler) and (iteration < maxfun) :
473         iteration += 1
474         #
475         Derivees  = numpy.array(fprime(variables))
476         Derivees  = Derivees.reshape(n,p) # Necessaire pour remettre en place la matrice si elle passe par des tuyaux YACS
477         DeriveesT = Derivees.transpose()
478         M         =   numpy.dot( DeriveesT , (numpy.array(numpy.matrix(p*[poids,]).T)*Derivees) )
479         SM        =   numpy.transpose(numpy.dot( DeriveesT , veps ))
480         step      = - numpy.linalg.lstsq( M, SM, rcond=-1 )[0]
481         #
482         variables = variables + step
483         if bounds is not None:
484             while( (variables < numpy.ravel(numpy.asmatrix(bounds)[:,0])).any() or (variables > numpy.ravel(numpy.asmatrix(bounds)[:,1])).any() ):
485                 step      = step/2.
486                 variables = variables - step
487         residus   = mesures - numpy.ravel( func(variables) )
488         surrogate = numpy.sum(residus**2 * poids) + (4.*quantile-2.) * numpy.sum(residus)
489         #
490         while ( (surrogate > lastsurrogate) and ( max(list(numpy.abs(step))) > 1.e-16 ) ) :
491             step      = step/2.
492             variables = variables - step
493             residus   = mesures - numpy.ravel( func(variables) )
494             surrogate = numpy.sum(residus**2 * poids) + (4.*quantile-2.) * numpy.sum(residus)
495         #
496         increment     = lastsurrogate-surrogate
497         poids         = 1./(epsilon+numpy.abs(residus))
498         veps          = 1. - 2. * quantile - residus * poids
499         lastsurrogate = -numpy.sum(residus * veps) - (1.-2.*quantile)*numpy.sum(residus)
500     #
501     # Mesure d'écart
502     # --------------
503     Ecart = quantile * numpy.sum(residus) - numpy.sum( residus[residus<0] )
504     #
505     return variables, Ecart, [n,p,iteration,increment,0]
506
507 # ==============================================================================
508 if __name__ == "__main__":
509     print('\n AUTODIAGNOSTIC\n')