MARLEY (Model of Argon Reaction Low Energy Yields) v2.0.0
A Monte Carlo event generator for tens-of-MeV neutrino interactions
Loading...
Searching...
No Matches
marley::InterpolatingFunction Class Referenceabstract

Abstract base class for an approximate representation of a 1D continuous function. More...

#include <InterpolatingFunction.hh>

Inheritance diagram for marley::InterpolatingFunction:
marley::ChebyshevInterpolatingFunction marley::LinearInterpolatingFunction

Public Member Functions

 InterpolatingFunction (double x_min, double x_max)
 
virtual double evaluate (double x) const =0
 Returns an approximate value of the represented function.
 

Protected Member Functions

 InterpolatingFunction ()
 Allows construction by derived classes without immediately defining the bounds of the interpolation range.
 

Protected Attributes

double x_max_
 Upper bound of the interpolation range.
 
double x_min_
 Lower bound of the interpolation range.
 

Detailed Description

Abstract base class for an approximate representation of a 1D continuous function.

Definition at line 27 of file InterpolatingFunction.hh.

Constructor & Destructor Documentation

◆ InterpolatingFunction() [1/2]

marley::InterpolatingFunction::InterpolatingFunction ( double x_min,
double x_max )
inline

Definition at line 31 of file InterpolatingFunction.hh.

31 : x_min_( x_min ),
32 x_max_( x_max ) {}
double x_max_
Upper bound of the interpolation range.
double x_min_
Lower bound of the interpolation range.

◆ InterpolatingFunction() [2/2]

marley::InterpolatingFunction::InterpolatingFunction ( )
inlineprotected

Allows construction by derived classes without immediately defining the bounds of the interpolation range.

Definition at line 43 of file InterpolatingFunction.hh.

43{}

Member Function Documentation

◆ evaluate()

virtual double marley::InterpolatingFunction::evaluate ( double x) const
pure virtual

Returns an approximate value of the represented function.

Implemented in marley::ChebyshevInterpolatingFunction, and marley::LinearInterpolatingFunction.

Referenced by marley::Generator::inverse_transform_sample().

Member Data Documentation

◆ x_max_

double marley::InterpolatingFunction::x_max_
protected

Upper bound of the interpolation range.

Definition at line 49 of file InterpolatingFunction.hh.

Referenced by marley::ChebyshevInterpolatingFunction::chebyshev_point().

◆ x_min_

double marley::InterpolatingFunction::x_min_
protected

Lower bound of the interpolation range.

Definition at line 46 of file InterpolatingFunction.hh.

Referenced by marley::ChebyshevInterpolatingFunction::chebyshev_point().


The documentation for this class was generated from the following file: