G4INCL::InterpolationTable Class Reference

Class for interpolating the of a 1-dimensional function. More...

#include <G4INCLInterpolationTable.hh>

Inheritance diagram for G4INCL::InterpolationTable:

Collaboration diagram for G4INCL::InterpolationTable:

Public Member Functions
	InterpolationTable (std::vector< G4double > const &x, std::vector< G4double > const &y)
virtual	~InterpolationTable ()
unsigned int	getNumberOfNodes () const
std::vector< G4double >	getNodeAbscissae () const
std::vector< G4double >	getNodeValues () const
G4double	operator() (const G4double x) const
std::string	print () const
Public Member Functions inherited from G4INCL::IFunction1D
	IFunction1D ()
	IFunction1D (const G4double x0, const G4double x1)
virtual	~IFunction1D ()
virtual G4double	getXMinimum () const
	Return the minimum allowed value of the independent variable. More...
virtual G4double	getXMaximum () const
	Return the maximum allowed value of the independent variable. More...
virtual G4double	integrate (const G4double x0, const G4double x1, const G4double step=-1.) const
	Integrate the function between two values. More...
IFunction1D *	primitive () const
	Return a pointer to the (numerical) primitive to this function. More...
InterpolationTable *	inverseCDFTable (ManipulatorFunc fWrap=0, const G4int nNodes=60) const
	Return a pointer to the inverse of the CDF of this function. More...

Protected Member Functions
	InterpolationTable ()
void	initDerivatives ()
	Initialise the values of the node derivatives. More...

Protected Attributes
std::vector< InterpolationNode >	nodes
	Interpolating nodes. More...
Protected Attributes inherited from G4INCL::IFunction1D
G4double	xMin
	Minimum value of the independent variable. More...
G4double	xMax
	Maximum value of the independent variable. More...

Additional Inherited Members
Public Types inherited from G4INCL::IFunction1D
typedef G4double(*const	ManipulatorFunc) (const G4double)
	Typedef to simplify the syntax of inverseCDFTable. More...

Detailed Description

Class for interpolating the of a 1-dimensional function.

Definition at line 106 of file G4INCLInterpolationTable.hh.

Constructor & Destructor Documentation

InterpolationTable() [1/2]

G4INCL::InterpolationTable::InterpolationTable	(	std::vector< G4double > const &	x,
		std::vector< G4double > const &	y
	)

Definition at line 54 of file G4INCLInterpolationTable.cc.

    : IFunction1D(x.front(), x.back())
  {
// assert(x.size()==y.size());
    // Assert that the x vector is sorted
// assert(std::adjacent_find(nodes.begin(), nodes.end(), std::greater<InterpolationNode>()) == nodes.end());

    for(unsigned i = 0; i < x.size(); ++i)
      nodes.push_back(InterpolationNode(x.at(i), y.at(i), 0.));

    initDerivatives();
  }

Here is the call graph for this function:

~InterpolationTable()

virtual G4INCL::InterpolationTable::~InterpolationTable ( )

inlinevirtual

Definition at line 109 of file G4INCLInterpolationTable.hh.

{}

InterpolationTable() [2/2]

G4INCL::InterpolationTable::InterpolationTable ( )

protected

Definition at line 52 of file G4INCLInterpolationTable.cc.

: IFunction1D() {}

Member Function Documentation

getNodeAbscissae()

std::vector< G4double > G4INCL::InterpolationTable::getNodeAbscissae

(

)

const

Definition at line 67 of file G4INCLInterpolationTable.cc.

                                                                 {
    std::vector<G4double> x(nodes.size());
    std::transform(nodes.begin(), nodes.end(), x.begin(),
                   std::mem_fun_ref(&InterpolationNode::getX));
    return x;
  }

Here is the call graph for this function:

getNodeValues()

std::vector< G4double > G4INCL::InterpolationTable::getNodeValues

(

)

const

Definition at line 74 of file G4INCLInterpolationTable.cc.

                                                              {
    std::vector<G4double> y(nodes.size());
    std::transform(nodes.begin(), nodes.end(), y.begin(),
                   std::mem_fun_ref(&InterpolationNode::getY));
    return y;
  }

Here is the call graph for this function:

getNumberOfNodes()

unsigned int G4INCL::InterpolationTable::getNumberOfNodes ( ) const

inline

Definition at line 111 of file G4INCLInterpolationTable.hh.

{ return nodes.size(); }

Here is the call graph for this function:

initDerivatives()

void G4INCL::InterpolationTable::initDerivatives ( )

protected

Initialise the values of the node derivatives.

Definition at line 81 of file G4INCLInterpolationTable.cc.

                                           {
    for(unsigned i = 0; i < nodes.size()-1; i++) {
      if((nodes.at(i+1).getX() - nodes.at(i).getX()) == 0.0) // Safeguard against division by zero
        nodes[i].setYPrime(0.0);
      else
        nodes[i].setYPrime((nodes.at(i+1).getY() - nodes.at(i).getY())/(nodes.at(i+1).getX() - nodes.at(i).getX()));
    }
    nodes.back().setYPrime(nodes.at(nodes.size()-2).getYPrime()); // Duplicate the last value
  }

Here is the caller graph for this function:

operator()()

G4double G4INCL::InterpolationTable::operator() ( const G4double  x ) const

virtual

Implements G4INCL::IFunction1D.

Definition at line 91 of file G4INCLInterpolationTable.cc.

                                                                {
    // Find the relevant interpolation bin
    InterpolationNode xNode(x,0.,0.);
    std::vector<InterpolationNode>::const_iterator iter =
      std::lower_bound(nodes.begin(), nodes.end(), xNode);

    if(iter==nodes.begin())
      return nodes.front().getY();

    if(iter==nodes.end())
      return nodes.back().getY();

    std::vector<InterpolationNode>::const_iterator previousIter = iter - 1;
    const G4double dx = x - previousIter->getX();
    return previousIter->getY() + previousIter->getYPrime()*dx;
  }

print()

std::string G4INCL::InterpolationTable::print

(

)

const

Definition at line 108 of file G4INCLInterpolationTable.cc.

                                            {
    std::string message;
    for(std::vector<InterpolationNode>::const_iterator n=nodes.begin(), e=nodes.end(); n!=e; ++n)
      message += n->print();
    return message;
  }

Here is the caller graph for this function:

Member Data Documentation

nodes

std::vector<InterpolationNode> G4INCL::InterpolationTable::nodes

protected

Interpolating nodes.

Definition at line 128 of file G4INCLInterpolationTable.hh.

---

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

• G4INCLInterpolationTable.hh
• G4INCLInterpolationTable.cc