Geant4  10.00.p02
G4SimplexDownhill.hh
Go to the documentation of this file.
1 //
2 // ********************************************************************
3 // * License and Disclaimer *
4 // * *
5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. *
10 // * *
11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitation of liability. *
17 // * *
18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Software license. *
24 // ********************************************************************
25 //
26 //
27 // $Id: G4SimplexDownhill.hh 81649 2014-06-04 09:56:53Z gcosmo $
28 //
29 // Class description:
30 //
31 // Class implementing minimization of a function of n variables.
32 // Reference: "A Simplex method for function minimization"
33 // by J. A. Nelder and R. Mead, Computer Journal, 7, 308 (1965)
34 // and also: "Numerical Recipes in C: the art of scientific computing"
35 // by William H., Cambridge University Press ISBN 0521437202 (1992)
36 
37 // Author: Tatsumi Koi (SLAC/SCCS), 2007
38 // --------------------------------------------------------------------------
39 
40 #ifndef G4SimplexDownhill_hh
41 #define G4SimplexDownhill_hh
42 
43 #include "globals.hh"
44 
45 #include <vector>
46 #include <algorithm>
47 
48 template<class T>
50 {
51 
52  public: // with description
53 
55  : currentValue(0.), target(tp), numberOfVariable(n)
56  { init(); }
57 
59 
61 
62  std::vector< G4double > GetMinimumPoint();
63 
64 
65  private:
66 
67  G4double getValue( std::vector< G4double > x )
68  { return target->GetValueOfMinimizingFunction( x ); }
69 
70  void initialize();
71  std::vector< std::vector< G4double > > currentSimplex;
72 
73  void calHeights();
74  std::vector< G4double > currentHeights;
76 
77  std::vector< G4double > calCentroid( G4int );
78 
80 
81  std::vector< G4double > getReflectionPoint( std::vector< G4double > ,
82  std::vector< G4double > );
83  std::vector< G4double > getExpansionPoint( std::vector< G4double > ,
84  std::vector< G4double > );
85  std::vector< G4double > getContractionPoint( std::vector< G4double > ,
86  std::vector< G4double > );
87 
88  void doDownhill();
89 
90  void init();
91 
92  private:
93 
94  T* target;
95 
97 
105 
106  std::vector< G4double > minimumPoint;
107 };
108 
109 #include "G4SimplexDownhill.icc"
110 
111 #endif
G4double getValue(std::vector< G4double > x)
std::vector< G4double > getContractionPoint(std::vector< G4double >, std::vector< G4double >)
std::vector< G4double > calCentroid(G4int)
std::vector< std::vector< G4double > > currentSimplex
int G4int
Definition: G4Types.hh:78
G4SimplexDownhill(T *tp, G4int n)
std::vector< G4double > getReflectionPoint(std::vector< G4double >, std::vector< G4double >)
std::vector< G4double > GetMinimumPoint()
std::vector< G4double > getExpansionPoint(std::vector< G4double >, std::vector< G4double >)
bool G4bool
Definition: G4Types.hh:79
const G4int n
std::vector< G4double > currentHeights
G4double GetMinimum()
double G4double
Definition: G4Types.hh:76
std::vector< G4double > minimumPoint
G4bool isItGoodEnough()