Various mathematical functions. More...

Namespaces
	Bessel
	Real and complex Bessel functions.

	internal

Functions
double	cot (double x)
	cotangent function: $cot(x)\equiv1/tan(x)$ More...

double	erf (double arg)
	Error function of real-valued argument. More...

double	Gaussian (double x, double average, double std_dev)

double	GeneratePoissonRandom (double average)

template<size_t N, typename Indices = std::make_index_sequence<N>>
constexpr std::array< double, N >	generateReciprocalFactorialArray ()
	Returns a compile-time generated std::array of reciprocal factorials. More...

double	IntegratedGaussian (double x, double average, double std_dev)

double	Laue (const double x, size_t N)
	Real Laue function: $Laue(x,N)\equiv\sin(Nx)/sin(x)$ . More...

complex_t	sinc (const complex_t z)
	Complex sinc function: $sinc(x)\equiv\sin(x)/x$ . More...

double	sinc (double x)
	sinc function: $sinc(x)\equiv\sin(x)/x$ More...

double	StandardNormal (double x)

complex_t	tanhc (const complex_t z)
	Complex tanhc function: $tanhc(x)\equiv\tanh(x)/x$ . More...

Detailed Description

Various mathematical functions.

Function Documentation

◆ cot()

double Math::cot ( double x )

cotangent function: $cot(x)\equiv1/tan(x)$

Definition at line 48 of file Functions.cpp.

 {
     return tan(M_PI_2 - x);
 }

References M_PI_2.

Referenced by FormFactorAnisoPyramid::onChange(), FormFactorCone::onChange(), FormFactorCone6::onChange(), FormFactorCuboctahedron::onChange(), FormFactorPyramid::onChange(), FormFactorTetrahedron::onChange(), FormFactorAnisoPyramid::sliceFormFactor(), FormFactorCone6::sliceFormFactor(), FormFactorCuboctahedron::sliceFormFactor(), FormFactorPyramid::sliceFormFactor(), and FormFactorTetrahedron::sliceFormFactor().

◆ erf()

double Math::erf ( double arg )

Error function of real-valued argument.

Definition at line 87 of file Functions.cpp.

 {
     if (arg < 0.0)
         throw std::runtime_error("Error in Math::erf: negative argument is not allowed");
     if (std::isinf(arg))
         return 1.0;
     return gsl_sf_erf(arg);
 }

Referenced by FootprintGauss::calculate().

◆ Gaussian()

double Math::Gaussian	(	double	x,
		double	average,
		double	std_dev
	)

Definition at line 36 of file Functions.cpp.

 {
     return StandardNormal((x - average) / std_dev) / std_dev;
 }

References StandardNormal().

Here is the call graph for this function:

◆ GeneratePoissonRandom()

double Math::GeneratePoissonRandom ( double average )

Definition at line 123 of file Functions.cpp.

 {
     unsigned seed =
         static_cast<unsigned>(std::chrono::system_clock::now().time_since_epoch().count());
     std::default_random_engine generator(seed);
     if (average <= 0.0)
         return 0.0;
     if (average < 1000.0) { // Use std::poisson_distribution
         std::poisson_distribution<int> distribution(average);
         int sample = distribution(generator);
         return (double)sample;
     } else { // Use normal approximation
         std::normal_distribution<double> distribution(average, std::sqrt(average));
         double sample = distribution(generator);
         return std::max(0.0, sample);
     }
 }

Referenced by PoissonNoiseBackground::addBackground().

◆ generateReciprocalFactorialArray()

template<size_t N, typename Indices = std::make_index_sequence<N>>

constexpr std::array<double, N> Math::generateReciprocalFactorialArray ( )

constexpr

Returns a compile-time generated std::array of reciprocal factorials.

Definition at line 49 of file Precomputed.h.

 {
     return internal::generateArrayHelper<internal::ReciprocalFactorial>(Indices{});
 };

◆ IntegratedGaussian()

double Math::IntegratedGaussian	(	double	x,
		double	average,
		double	std_dev
	)

Definition at line 41 of file Functions.cpp.

 {
     double normalized_x = (x - average) / std_dev;
     static double root2 = std::sqrt(2.0);
     return (gsl_sf_erf(normalized_x / root2) + 1.0) / 2.0;
 }

Referenced by ResolutionFunction2DGaussian::evaluateCDF().

◆ Laue()

double Math::Laue	(	const double	x,
		size_t	N
	)

Real Laue function: $Laue(x,N)\equiv\sin(Nx)/sin(x)$ .

Definition at line 76 of file Functions.cpp.

 {
     static const double SQRT6DOUBLE_EPS = std::sqrt(6.0 * std::numeric_limits<double>::epsilon());
     auto nd = static_cast<double>(N);
     if (std::abs(nd * x) < SQRT6DOUBLE_EPS)
         return nd;
     double num = std::sin(nd * x);
     double den = std::sin(x);
     return num / den;
 }

Referenced by InterferenceFunction2DSuperLattice::iff_without_dw(), InterferenceFunctionFinite3DLattice::iff_without_dw(), and InterferenceFunctionFinite2DLattice::interferenceForXi().

◆ sinc() [1/2]

complex_t Math::sinc ( const complex_t z )

Complex sinc function: $sinc(x)\equiv\sin(x)/x$ .

Definition at line 58 of file Functions.cpp.

 {
     // This is an exception from the rule that we must not test floating-point numbers for equality.
     // For small non-zero arguments, sin(z) returns quite accurately z or z-z^3/6.
     // There is no loss of precision in computing sin(z)/z.
     // Therefore there is no need for an expensive test like abs(z)<eps.
     if (z == complex_t(0., 0.))
         return 1.0;
     return std::sin(z) / z;
 }

◆ sinc() [2/2]

double Math::sinc ( double x )

sinc function: $sinc(x)\equiv\sin(x)/x$

Definition at line 53 of file Functions.cpp.

 {
     return gsl_sf_sinc(x / M_PI);
 }

References M_PI.

Referenced by PolyhedralFace::edge_sum_ff(), FTDecayFunction1DTriangle::evaluate(), FTDistribution1DGate::evaluate(), FTDistribution1DTriangle::evaluate(), FTDistribution1DCosine::evaluate(), Prism::evaluate_for_q(), FormFactorBox::evaluate_for_q(), FormFactorCylinder::evaluate_for_q(), FormFactorEllipsoidalCylinder::evaluate_for_q(), FormFactorLongBoxGauss::evaluate_for_q(), FormFactorLongBoxLorentz::evaluate_for_q(), ripples::factor_x_box(), ripples::profile_yz_bar(), ripples::profile_yz_cosine(), and ripples::profile_yz_triangular().

◆ StandardNormal()

double Math::StandardNormal ( double x )

Definition at line 31 of file Functions.cpp.

 {
     return std::exp(-x * x / 2.0) / std::sqrt(M_TWOPI);
 }

References M_TWOPI.

Referenced by Gaussian().

◆ tanhc()

complex_t Math::tanhc ( const complex_t z )

Complex tanhc function: $tanhc(x)\equiv\tanh(x)/x$ .

Definition at line 69 of file Functions.cpp.

 {
     if (std::abs(z) < std::numeric_limits<double>::epsilon())
         return 1.0;
     return std::tanh(z) / z;
 }

Referenced by SpecularMagneticTanhStrategy::computeRoughnessMatrix(), and SpecularScalarTanhStrategy::transition().

Namespaces

Functions