G4INCL::InverseInterpolationTable Class Reference

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

#include <G4INCLInverseInterpolationTable.hh>

Inheritance diagram for G4INCL::InverseInterpolationTable:

Public Member Functions
	InverseInterpolationTable (IFunction1D const &f, const unsigned int nNodes=30)
	InverseInterpolationTable (std::vector< G4double > const &x, std::vector< G4double > const &y)
virtual	~InverseInterpolationTable ()
unsigned int	getNumberOfNodes () const
std::vector< G4double >	getNodeAbscissae () const
std::vector< G4double >	getNodeValues () const
G4double	operator() (const G4double x) const
	Compute the value of the function. More...
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...
InverseInterpolationTable *	inverseCDFTable (const G4int nNodes=60) const
	Return a pointer to the inverse of the CDF of this function. More...

Additional Inherited Members
Protected Attributes inherited from G4INCL::IFunction1D
G4double	xMin
	Minimum value of the independent variable. More...
G4double	xMax
	Maximum value of the independent variable. More...

Detailed Description

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

Definition at line 108 of file G4INCLInverseInterpolationTable.hh.

Constructor & Destructor Documentation

G4INCL::InverseInterpolationTable::InverseInterpolationTable	(	IFunction1D const &	f,
		const unsigned int	nNodes = 30
	)

Definition at line 51 of file G4INCLInverseInterpolationTable.cc.

References G4INCL::IFunction1D::getXMaximum(), and G4INCL::IFunction1D::getXMinimum().

                                                                                                      {
// assert(nNodes>2);

    const G4double x0 = f.getXMinimum();
    const G4double x1 = f.getXMaximum();

    // Build the nodes
    G4double last = f(x0);
    InterpolationNode firstNode(last, x0, 0.);
    nodes.push_back(firstNode);
    G4int skippedNodes = 0;
    for(unsigned i = 1; i < nNodes; i++) {
      const G4double xi = x0 + i*(x1-x0)/((G4double)(nNodes-1));
      // Make sure that the x vector is sorted (corresponding to a monotonous
      // function)
      const G4double value = f(xi);
      if(value <= last) {
        ++skippedNodes;
        continue;
      }
      InterpolationNode node(value, xi, 0.);
      nodes.push_back(node);
      last = value;
    }

// assert(nNodes==nodes.size()+skippedNodes);

    // Initialise the "derivative" values
    initDerivatives();
    setFunctionDomain();
  }

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

Definition at line 83 of file G4INCLInverseInterpolationTable.cc.

                                                                                                                 {
// assert(x.size()==y.size());
    // Assert that the x vector is sorted (corresponding to a monotonous
    // function
// 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();
    setFunctionDomain();
  }

virtual G4INCL::InverseInterpolationTable::~InverseInterpolationTable ( )

inlinevirtual

Definition at line 112 of file G4INCLInverseInterpolationTable.hh.

{}

Member Function Documentation

std::vector<G4double> G4INCL::InverseInterpolationTable::getNodeAbscissae ( ) const

inline

Definition at line 116 of file G4INCLInverseInterpolationTable.hh.

References G4INCL::InterpolationNode::getX(), and test::x.

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

std::vector<G4double> G4INCL::InverseInterpolationTable::getNodeValues ( ) const

inline

Definition at line 123 of file G4INCLInverseInterpolationTable.hh.

References G4INCL::InterpolationNode::getY().

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

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

inline

Definition at line 114 of file G4INCLInverseInterpolationTable.hh.

{ return nodes.size(); }

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

virtual

Compute the value of the function.

Implements G4INCL::IFunction1D.

Definition at line 117 of file G4INCLInverseInterpolationTable.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;
  }

std::string G4INCL::InverseInterpolationTable::print

(

)

const

Definition at line 134 of file G4INCLInverseInterpolationTable.cc.

References n.

Referenced by G4INCL::NuclearDensityFactory::createPCDFTable(), G4INCL::NuclearDensityFactory::createRCDFTable(), and G4INCL::NuclearDensityFactory::createRPCorrelationTable().

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

---

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

• G4INCLInverseInterpolationTable.hh
• G4INCLInverseInterpolationTable.cc