G4JTPolynomialSolver.hh

Go to the documentation of this file.

//
// ********************************************************************
// * License and Disclaimer                                           *
// *                                                                  *
// * The  Geant4 software  is  copyright of the Copyright Holders  of *
// * the Geant4 Collaboration.  It is provided  under  the terms  and *
// * conditions of the Geant4 Software License,  included in the file *
// * LICENSE and available at  http://cern.ch/geant4/license .  These *
// * include a list of copyright holders.                             *
// *                                                                  *
// * Neither the authors of this software system, nor their employing *
// * institutes,nor the agencies providing financial support for this *
// * work  make  any representation or  warranty, express or implied, *
// * regarding  this  software system or assume any liability for its *
// * use.  Please see the license in the file  LICENSE  and URL above *
// * for the full disclaimer and the limitation of liability.         *
// *                                                                  *
// * This  code  implementation is the result of  the  scientific and *
// * technical work of the GEANT4 collaboration.                      *
// * By using,  copying,  modifying or  distributing the software (or *
// * any work based  on the software)  you  agree  to acknowledge its *
// * use  in  resulting  scientific  publications,  and indicate your *
// * acceptance of all terms of the Geant4 Software license.          *
// ********************************************************************
//
// G4JTPolynomialSolver
//
// Class description:
//
// G4JTPolynomialSolver implements the Jenkins-Traub algorithm
// for real polynomial root finding.
// The solver returns -1, if the leading coefficient is zero,
// the number of roots found, otherwise.
//
// ----------------------------- INPUT --------------------------------
//
//    op     - double precision vector of coefficients in order of
//             decreasing powers
//    degree - integer degree of polynomial
//
// ----------------------------- OUTPUT -------------------------------
//
//    zeror,zeroi - double precision vectors of the
//                  real and imaginary parts of the zeros
//
// ---------------------------- EXAMPLE -------------------------------
//
//    G4JTPolynomialSolver trapEq ;
//    G4double coef[8] ;
//    G4double zr[7] , zi[7] ;
//    G4int num = trapEq.FindRoots(coef,7,zr,zi);
//
// Translated from original TOMS493 Fortran77 routine (ANSI C, by C.Bond).
 
// Author: Oliver Link, 15.02.2005
//         Translated to C++ and adapted to use STL vectors.
// --------------------------------------------------------------------
#ifndef G4JTPOLYNOMIALSOLVER_HH
#define G4JTPOLYNOMIALSOLVER_HH 1
 
#include <cmath>
#include <vector>
 
#include "globals.hh"
 
class G4JTPolynomialSolver
{
 public:
  G4JTPolynomialSolver() = default;
  ~G4JTPolynomialSolver() = default;
 
  G4int FindRoots(G4double* op, G4int degree, G4double* zeror, G4double* zeroi);
 
 private:
  void Quadratic(G4double a, G4double b1, G4double c, G4double* sr,
                 G4double* si, G4double* lr, G4double* li);
  void ComputeFixedShiftPolynomial(G4int l2, G4int* nz);
  void QuadraticPolynomialIteration(G4double* uu, G4double* vv, G4int* nz);
  void RealPolynomialIteration(G4double* sss, G4int* nz, G4int* iflag);
  void ComputeScalarFactors(G4int* type);
  void ComputeNextPolynomial(G4int* type);
  void ComputeNewEstimate(G4int type, G4double* uu, G4double* vv);
  void QuadraticSyntheticDivision(G4int n, G4double* u, G4double* v,
                                  std::vector<G4double>& p,
                                  std::vector<G4double>& q, G4double* a,
                                  G4double* b);
 
 private:
  std::vector<G4double> p;
  std::vector<G4double> qp;
  std::vector<G4double> k;
  std::vector<G4double> qk;
  std::vector<G4double> svk;
 
  G4double sr = 0.0;
  G4double si = 0.0;
  G4double u = 0.0, v = 0.0;
  G4double a = 0.0, b = 0.0, c = 0.0, d = 0.0;
  G4double a1 = 0.0, a3 = 0.0, a7 = 0.0;
  G4double e = 0.0, f = 0.0, g = 0.0, h = 0.0;
  G4double szr = 0.0, szi = 0.0;
  G4double lzr = 0.0, lzi = 0.0;
  G4int n = 0;
 
  /*  The following statements set machine constants */
 
  static const G4double base;
  static const G4double eta;
  static const G4double infin;
  static const G4double smalno;
  static const G4double are;
  static const G4double mre;
  static const G4double lo;
};
 
#endif