include/Geant4/G4LegendrePolynomial.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 //
0027 // -------------------------------------------------------------------
0028 //      GEANT4 Class file
0029 //
0030 //
0031 //      File name:     G4LegendrePolynomial
0032 //
0033 //      Author:        Jason Detwiler (jasondet@gmail.com)
0034 //
0035 //      Creation date: February 2015
0036 //
0037 //      Modifications: 29 October 2024 Isaac Kunen
0038 //
0039 //      Legendre Polynomial
0040 //
0041 // -------------------------------------------------------------------
0042
0043 #ifndef G4LEGENDREPOLYNOMIAL_HH
0044 #define G4LEGENDREPOLYNOMIAL_HH
0045
0046 #include "globals.hh"
0047 #include <vector>
0048 #include <map>
0049
0050 class G4LegendrePolynomial
0051 {
0052   public:
0053     // Access to coefficients
0054     static std::size_t GetNCoefficients(std::size_t order) { return order+1; }
0055     G4double GetCoefficient(std::size_t i, std::size_t order);
0056
0057     // Evaluation functions
0058     G4double EvalLegendrePoly(G4int order, G4double x);
0059
0060     G4double EvalAssocLegendrePoly(G4int l, G4int m, G4double x);
0061
0062     // cache is not used; use EvalAssocLegendrePoly(l, m, x) instead.
0063     G4double EvalAssocLegendrePoly(G4int l, G4int m, G4double x,
0064       std::map<G4int, std::map<G4int, G4double> >* cache)
0065     {
0066       (void) cache; // suppress compiler warning for unused cache
0067       return EvalAssocLegendrePoly(l, m, x);
0068     }
0069
0070   protected: // Cache coefficients for speed
0071     void BuildUpToOrder(std::size_t order);
0072     std::vector< std::vector<G4double> > fCoefficients;
0073 };
0074
0075 #endif