include/Geant4/G4INCLRootFinder.hh

0001 //
0002 // ********************************************************************
0003 // * License and Disclaimer                                           *
0004 // *                                                                  *
0005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
0006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
0007 // * conditions of the Geant4 Software License,  included in the file *
0008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
0009 // * include a list of copyright holders.                             *
0010 // *                                                                  *
0011 // * Neither the authors of this software system, nor their employing *
0012 // * institutes,nor the agencies providing financial support for this *
0013 // * work  make  any representation or  warranty, express or implied, *
0014 // * regarding  this  software system or assume any liability for its *
0015 // * use.  Please see the license in the file  LICENSE  and URL above *
0016 // * for the full disclaimer and the limitation of liability.         *
0017 // *                                                                  *
0018 // * This  code  implementation is the result of  the  scientific and *
0019 // * technical work of the GEANT4 collaboration.                      *
0020 // * By using,  copying,  modifying or  distributing the software (or *
0021 // * any work based  on the software)  you  agree  to acknowledge its *
0022 // * use  in  resulting  scientific  publications,  and indicate your *
0023 // * acceptance of all terms of the Geant4 Software license.          *
0024 // ********************************************************************
0025 //
0026 // INCL++ intra-nuclear cascade model
0027 // Alain Boudard, CEA-Saclay, France
0028 // Joseph Cugnon, University of Liege, Belgium
0029 // Jean-Christophe David, CEA-Saclay, France
0030 // Pekka Kaitaniemi, CEA-Saclay, France, and Helsinki Institute of Physics, Finland
0031 // Sylvie Leray, CEA-Saclay, France
0032 // Davide Mancusi, CEA-Saclay, France
0033 //
0034 #define INCLXX_IN_GEANT4_MODE 1
0035
0036 #include "globals.hh"
0037
0038 /** \file G4INCLRootFinder.hh
0039  * \brief Static root-finder algorithm.
0040  *
0041  * Provides a (nearly) stateless root-finder algorithm.
0042  *
0043  * \date 2nd March 2011
0044  * \author Davide Mancusi
0045  */
0046
0047 #ifndef G4INCLROOTFINDER_HH_
0048 #define G4INCLROOTFINDER_HH_
0049
0050 #include <utility>
0051 #include "G4INCLIFunction1D.hh"
0052
0053 namespace G4INCL {
0054
0055   class RootFunctor : public IFunction1D {
0056   public:
0057     virtual void cleanUp(const G4bool success) const = 0;
0058     virtual ~RootFunctor() {};
0059   protected:
0060     RootFunctor(const G4double x0, const G4double x1) :
0061       IFunction1D(x0, x1)
0062     {};
0063   };
0064
0065   namespace RootFinder {
0066
0067     class Solution {
0068       public:
0069         Solution() :
0070           success(false),
0071           x(0.),
0072           y(0.)
0073       {}
0074         Solution( const G4double x0, const G4double y0) :
0075           success(true),
0076           x(x0),
0077           y(y0)
0078       {}
0079         ~Solution() {}
0080
0081         G4bool success;
0082         G4double x;
0083         G4double y;
0084     };
0085
0086     /** \brief Numerically solve a one-dimensional equation.
0087      *
0088      * Numerically solves the equation f(x)==0. This implementation uses the
0089      * false-position method.
0090      *
0091      * If a root is found, it can be retrieved using the getSolution() method,
0092      *
0093      * \param f pointer to a RootFunctor
0094      * \param x0 initial value of the function argument
0095      * \return a Solution object describing the root, if it was found
0096      */
0097     Solution solve(RootFunctor const * const f, const G4double x0);
0098
0099   }
0100 }
0101 #endif /* G4INCLROOTFINDER_HH_ */