create a linear mapping of another functionfor example, given a c2_function f More...

#include <geant4/tree/geant4-10.6-release/examples/extended/electromagnetic/TestEm7/include/c2_function.hh>

Inheritance diagram for c2_linear_p< float_type >:

Collaboration diagram for c2_linear_p< float_type >:

Public Member Functions
	c2_linear_p (float_type x0, float_type y0, float_type slope)
	Construct the operator f=y0 + slope * (x-x0)

void	reset (float_type x0, float_type y0, float_type slope)
	Change the slope and intercepts after construction.

virtual float_type	value_with_derivatives (float_type x, float_type yprime, float_type yprime2) const
	get the value and derivatives.

Public Member Functions inherited from c2_function< float_type >
const std::string	cvs_header_vers () const
	get versioning information for the header file

const std::string	cvs_file_vers () const
	get versioning information for the source file

virtual	~c2_function ()
	destructor

float_type	operator() (float_type x) const
	evaluate the function in the classic way, ignoring derivatives.

float_type	operator() (float_type x, float_type yprime, float_type yprime2) const
	get the value and derivatives.

float_type	find_root (float_type lower_bracket, float_type upper_bracket, float_type start, float_type value, int error=0, float_type final_yprime=0, float_type *final_yprime2=0) const
	solve f(x)==value very efficiently, with explicit knowledge of derivatives of the function

float_type	partial_integrals (std::vector< float_type > xgrid, std::vector< float_type > *partials=0, float_type abs_tol=1e-12, float_type rel_tol=1e-12, int derivs=2, bool adapt=true, bool extrapolate=true) const

float_type	integral (float_type amin, float_type amax, std::vector< float_type > *partials=0, float_type abs_tol=1e-12, float_type rel_tol=1e-12, int derivs=2, bool adapt=true, bool extrapolate=true) const
	a fully-automated integrator which uses the information provided by the get_sampling_grid() function to figure out what to do.

c2_piecewise_function_p < float_type > *	adaptively_sample (float_type amin, float_type amax, float_type abs_tol=1e-12, float_type rel_tol=1e-12, int derivs=2, std::vector< float_type > xvals=0, std::vector< float_type > yvals=0) const
	create a c2_piecewise_function_p from c2_connector_function_p segments which is a representation of the parent function to the specified accuracy, but maybe much cheaper to evaluate

float_type	xmin () const

float_type	xmax () const

void	set_domain (float_type amin, float_type amax)

size_t	get_evaluations () const

void	reset_evaluations () const
	reset the counter

void	increment_evaluations () const
	count evaluations

bool	check_monotonicity (const std::vector< float_type > &data, const char message[]) const
	check that a vector is monotonic, throw an exception if not, and return a flag if it is reversed

virtual void	set_sampling_grid (const std::vector< float_type > &grid)
	establish a grid of 'interesting' points on the function.

std::vector< float_type > *	get_sampling_grid_pointer () const
	get the sampling grid, which may be a null pointer

virtual void	get_sampling_grid (float_type amin, float_type amax, std::vector< float_type > &grid) const

void	preen_sampling_grid (std::vector< float_type > *result) const
	The grid is modified in place.

void	refine_sampling_grid (std::vector< float_type > &grid, size_t refinement) const

c2_function< float_type > &	normalized_function (float_type amin, float_type amax, float_type norm=1.0) const
	create a new c2_function from this one which is normalized on the interval

c2_function< float_type > &	square_normalized_function (float_type amin, float_type amax, float_type norm=1.0) const

c2_function< float_type > &	square_normalized_function (float_type amin, float_type amax, const c2_function< float_type > &weight, float_type norm=1.0) const
	create a new c2_function from this one which is square-normalized with the provided weight on the interval

c2_sum_p< float_type > &	operator+ (const c2_function< float_type > &rhs) const
	factory function to create a c2_sum_p from a regular algebraic expression.

c2_diff_p< float_type > &	operator- (const c2_function< float_type > &rhs) const
	factory function to create a c2_diff_p from a regular algebraic expression.

c2_product_p< float_type > &	operator* (const c2_function< float_type > &rhs) const
	factory function to create a c2_product_p from a regular algebraic expression.

c2_ratio_p< float_type > &	operator/ (const c2_function< float_type > &rhs) const

c2_composed_function_p < float_type > &	operator() (const c2_function< float_type > &inner) const
	compose this function outside another.

float_type	get_trouble_point () const
	Find out where a calculation ran into trouble, if it got a nan. If the most recent computation did not return a nan, this is undefined.

void	claim_ownership () const
	increment our reference count. Destruction is only legal if the count is zero.

size_t	release_ownership_for_return () const
	decrement our reference count. Do not destroy at zero.

void	release_ownership () const

size_t	count_owners () const
	get the reference count, mostly for debugging

void	fill_fblock (c2_fblock< float_type > &fb) const
	fill in a c2_fblock<float_type>... a shortcut for the integrator & sampler

Protected Member Functions
	c2_linear_p ()

Protected Member Functions inherited from c2_function< float_type >
	c2_function (const c2_function< float_type > &src)

	c2_function ()

virtual void	set_sampling_grid_pointer (std::vector< float_type > &grid)

Private Attributes
float_type	xint

float_type	intercept

float_type	m

Additional Inherited Members
Protected Attributes inherited from c2_function< float_type >
std::vector< float_type > *	sampling_grid

bool	no_overwrite_grid

float_type	fXMin

float_type	fXMax

size_t	evaluations

float_type	bad_x_point
	this point may be used to record where a calculation ran into trouble

Detailed Description

template<typename float_type = double>
class c2_linear_p< float_type >

create a linear mapping of another function

for example, given a c2_function f

c2_function<double> &F=c2_linear<double>(1.2, 2.0, 3.0)(f);

produces a new c2_function F=2.0+3.0*(f - 1.2)

The factory function c2_factory::linear() creates *new c2_linear_p

Definition at line 1971 of file c2_function.hh.

View newest version in sPHENIX GitHub at line 1971 of file c2_function.hh

Constructor & Destructor Documentation

template<typename float_type = double>

c2_linear_p< float_type >::c2_linear_p	(	float_type	x0,
		float_type	y0,
		float_type	slope
	)

inline

Construct the operator f=y0 + slope * (x-x0)

Parameters

x0	the x offset
y0	the y-intercept i.e. f(x0)
slope	the slope of the mapping

Definition at line 1978 of file c2_function.hh.

View newest version in sPHENIX GitHub at line 1978 of file c2_function.hh

template<typename float_type = double>

c2_linear_p< float_type >::c2_linear_p ( )

inlineprotected

Definition at line 1996 of file c2_function.hh.

View newest version in sPHENIX GitHub at line 1996 of file c2_function.hh

Member Function Documentation

template<typename float_type = double>

void c2_linear_p< float_type >::reset	(	float_type	x0,
		float_type	y0,
		float_type	slope
	)

inline

Change the slope and intercepts after construction.

Parameters

x0	the x offset
y0	the y-intercept
slope	the slope of the mapping

Definition at line 1984 of file c2_function.hh.

View newest version in sPHENIX GitHub at line 1984 of file c2_function.hh

Referenced by G4ScreenedCoulombClassicalKinematics::DoScreeningComputation(), and G4NativeScreenedCoulombCrossSection::LoadData().

Here is the caller graph for this function:

template<typename float_type = double>

virtual float_type c2_linear_p< float_type >::value_with_derivatives	(	float_type	x,
		float_type *	yprime,
		float_type *	yprime2
	)		const

inlinevirtual

get the value and derivatives.

There is required checking for null pointers on the derivatives, and most implementations should operate faster if derivatives are not

Parameters

[in]	x	the point at which to evaluate the function
[out]	yprime	the first derivative (if pointer is non-null)
[out]	yprime2	the second derivative (if pointer is non-null)

Returns: the value of the function

Implements c2_function< float_type >.

Definition at line 1986 of file c2_function.hh.

View newest version in sPHENIX GitHub at line 1986 of file c2_function.hh

Member Data Documentation

template<typename float_type = double>

float_type c2_linear_p< float_type >::intercept

private

Definition at line 1994 of file c2_function.hh.

View newest version in sPHENIX GitHub at line 1994 of file c2_function.hh

Referenced by c2_linear_p< G4double >::reset(), and c2_linear_p< G4double >::value_with_derivatives().

template<typename float_type = double>

float_type c2_linear_p< float_type >::m

private

Definition at line 1994 of file c2_function.hh.

View newest version in sPHENIX GitHub at line 1994 of file c2_function.hh

Referenced by c2_linear_p< G4double >::reset(), and c2_linear_p< G4double >::value_with_derivatives().

template<typename float_type = double>

float_type c2_linear_p< float_type >::xint

private

Definition at line 1994 of file c2_function.hh.

View newest version in sPHENIX GitHub at line 1994 of file c2_function.hh

Referenced by c2_linear_p< G4double >::reset(), and c2_linear_p< G4double >::value_with_derivatives().

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

geant4/tree/geant4-10.6-release/examples/extended/electromagnetic/TestEm7/include/c2_function.hh

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

template<typename float_type = double> class c2_linear_p< float_type >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename float_type = double>
class c2_linear_p< float_type >