marley::LinearInterpolatingFunction Class Reference

Approximates a 1D function using linear interpolation on a grid of regularly-spaced points. More...

#include <LinearInterpolatingFunction.hh>

Inheritance diagram for marley::LinearInterpolatingFunction:

Public Member Functions
	LinearInterpolatingFunction (const std::function< double(double) > &func, double x_min, double x_max, size_t N=DEFAULT_N_LINEAR)
double	evaluate (double x) const override
	Returns an approximate value of the represented function.
int	N () const
Public Member Functions inherited from marley::InterpolatingFunction
	InterpolatingFunction (double x_min, double x_max)

Protected Attributes
std::shared_ptr< InterpolationGrid< double, double > >	interp_grid_
Protected Attributes inherited from marley::InterpolatingFunction
double	x_max_
	Upper bound of the interpolation range.
double	x_min_
	Lower bound of the interpolation range.

Additional Inherited Members
Protected Member Functions inherited from marley::InterpolatingFunction
	InterpolatingFunction ()
	Allows construction by derived classes without immediately defining the bounds of the interpolation range.

Detailed Description

Approximates a 1D function using linear interpolation on a grid of regularly-spaced points.

Definition at line 31 of file LinearInterpolatingFunction.hh.

Constructor & Destructor Documentation

LinearInterpolatingFunction()

marley::LinearInterpolatingFunction::LinearInterpolatingFunction	(	const std::function< double(double) > &	func,
		double	x_min,
		double	x_max,
		size_t	N = DEFAULT_N_LINEAR )

Definition at line 26 of file LinearInterpolatingFunction.cc.

  : marley::InterpolatingFunction( x_min, x_max )
{
  // Force at least two points to be used
  // TODO: add error handling here
  if ( N < 2u ) N = 2u;
 
  std::vector< double > x_vec;
  std::vector< double > y_vec;
 
  double dx = ( x_max - x_min ) / ( N - 1 );
  for ( size_t s = 0u; s < N; ++s ) {
    double x = x_min + s*dx;
    double y = func( x );
 
    x_vec.push_back( x );
    y_vec.push_back( y );
  }
 
  interp_grid_ = std::make_shared<
    marley::InterpolationGrid< double, double > >( x_vec, y_vec );
}

Member Function Documentation

evaluate()

double marley::LinearInterpolatingFunction::evaluate ( double x ) const

inlineoverridevirtual

Returns an approximate value of the represented function.

Implements marley::InterpolatingFunction.

Definition at line 38 of file LinearInterpolatingFunction.hh.

                                                        {
        return interp_grid_->interpolate( x );
      }

Referenced by marley::CachedOpticalModel::transmission_coefficient().

N()

int marley::LinearInterpolatingFunction::N ( ) const

inline

Definition at line 42 of file LinearInterpolatingFunction.hh.

{ return interp_grid_->size(); }

Member Data Documentation

interp_grid_

std::shared_ptr< InterpolationGrid<double, double> > marley::LinearInterpolatingFunction::interp_grid_

protected

Definition at line 46 of file LinearInterpolatingFunction.hh.

---

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

• /home/sjg/Desktop/marley/include/marley/LinearInterpolatingFunction.hh
• /home/sjg/Desktop/marley/src/LinearInterpolatingFunction.cc