bpp-core3  3.0.0
Static Public Member Functions | List of all members
bpp::NumConstants Class Reference

this static class contains several useful constant values. More...

#include <Bpp/Numeric/NumConstants.h>

Static Public Member Functions

static double MEGA ()
 
static double KILO ()
 
static double DECI ()
 
static double CENTI ()
 
static double MILLI ()
 
static double MICRO ()
 
static double NANO ()
 
static double PICO ()
 
static double SMALL ()
 
static double TINY ()
 
static double VERY_TINY ()
 
static double VERY_BIG ()
 
static double PI ()
 
Golden ratio.

The golden ratio, $\phi$ is equal to $\frac{1+\sqrt{5}}{2} = 1.6180339887498948482\ldots$. We also define $R=\phi-1$ and $C = 1 - R$.

static double GOLDEN_RATIO_PHI ()
 
static double GOLDEN_RATIO_R ()
 
static double GOLDEN_RATIO_C ()
 
Define those constants in case they would not be available in stl/limits.
static double INF ()
 
static double PINF ()
 
static double MINF ()
 
static double NaN ()
 

Detailed Description

this static class contains several useful constant values.

This classe uses function in order to avoid the infamous "static initialization order fiasco". C++0x solves this...

Definition at line 20 of file NumConstants.h.

Member Function Documentation

◆ CENTI()

static double bpp::NumConstants::CENTI ( )
inlinestatic

Definition at line 39 of file NumConstants.h.

◆ DECI()

static double bpp::NumConstants::DECI ( )
inlinestatic

Definition at line 38 of file NumConstants.h.

◆ GOLDEN_RATIO_C()

static double bpp::NumConstants::GOLDEN_RATIO_C ( )
inlinestatic

Definition at line 32 of file NumConstants.h.

References GOLDEN_RATIO_R().

Referenced by bpp::GoldenSectionSearch::doInit(), bpp::GoldenSectionSearch::doStep(), and bpp::BrentOneDimension::doStep().

◆ GOLDEN_RATIO_PHI()

static double bpp::NumConstants::GOLDEN_RATIO_PHI ( )
inlinestatic

Definition at line 30 of file NumConstants.h.

Referenced by bpp::OneDimensionOptimizationTools::bracketMinimum(), and GOLDEN_RATIO_R().

◆ GOLDEN_RATIO_R()

static double bpp::NumConstants::GOLDEN_RATIO_R ( )
inlinestatic

Definition at line 31 of file NumConstants.h.

References GOLDEN_RATIO_PHI().

Referenced by bpp::GoldenSectionSearch::doStep(), and GOLDEN_RATIO_C().

◆ INF()

static double bpp::NumConstants::INF ( )
inlinestatic

Definition at line 55 of file NumConstants.h.

◆ KILO()

static double bpp::NumConstants::KILO ( )
inlinestatic

Definition at line 37 of file NumConstants.h.

◆ MEGA()

static double bpp::NumConstants::MEGA ( )
inlinestatic

Definition at line 36 of file NumConstants.h.

◆ MICRO()

static double bpp::NumConstants::MICRO ( )
inlinestatic

Definition at line 41 of file NumConstants.h.

◆ MILLI()

static double bpp::NumConstants::MILLI ( )
inlinestatic

Definition at line 40 of file NumConstants.h.

◆ MINF()

static double bpp::NumConstants::MINF ( )
inlinestatic

Definition at line 57 of file NumConstants.h.

Referenced by bpp::IntervalConstraint::finiteLowerBound(), and bpp::IntervalConstraint::readDescription().

◆ NaN()

static double bpp::NumConstants::NaN ( )
inlinestatic

Definition at line 58 of file NumConstants.h.

◆ NANO()

static double bpp::NumConstants::NANO ( )
inlinestatic

Definition at line 42 of file NumConstants.h.

◆ PI()

static double bpp::NumConstants::PI ( )
inlinestatic

Definition at line 61 of file NumConstants.h.

Referenced by bpp::IntervalTransformedParameter::getFirstOrderDerivative(), bpp::IntervalTransformedParameter::getOriginalValue(), bpp::IntervalTransformedParameter::getSecondOrderDerivative(), bpp::AdaptiveKernelDensityEstimation::kernel_(), and bpp::IntervalTransformedParameter::setOriginalValue().

◆ PICO()

static double bpp::NumConstants::PICO ( )
inlinestatic

Definition at line 43 of file NumConstants.h.

◆ PINF()

static double bpp::NumConstants::PINF ( )
inlinestatic

Definition at line 56 of file NumConstants.h.

Referenced by bpp::IntervalConstraint::finiteUpperBound(), and bpp::IntervalConstraint::readDescription().

◆ SMALL()

static double bpp::NumConstants::SMALL ( )
inlinestatic

Definition at line 45 of file NumConstants.h.

Referenced by bpp::Simplex::setFrequencies(), bpp::Simplex::Simplex(), and bpp::LUDecomposition< Real >::solve().

◆ TINY()

static double bpp::NumConstants::TINY ( )
inlinestatic

Definition at line 46 of file NumConstants.h.

Referenced by bpp::AbstractDiscreteDistribution::discretizeEqualProportions(), bpp::BfgsMultiDimensions::doInit(), bpp::Simplex::fireParameterChanged(), bpp::NumCalcApplicationTools::getVector(), bpp::ReparametrizationFunctionWrapper::init_(), bpp::BfgsMultiDimensions::setDirection(), and bpp::AutoParameter::setValue().

◆ VERY_BIG()

static double bpp::NumConstants::VERY_BIG ( )
inlinestatic

Definition at line 48 of file NumConstants.h.

Referenced by bpp::BfgsMultiDimensions::doInit(), bpp::DiscreteDistributionInterface::getLowerBound(), bpp::DiscreteDistributionInterface::getUpperBound(), bpp::RandomTools::incompleteBeta(), bpp::RandomTools::incompletebetaps(), bpp::ConstantDistribution::qProb(), bpp::SimpleDiscreteDistribution::qProb(), bpp::TwoPointsNumericalDerivative::updateDerivatives(), bpp::ThreePointsNumericalDerivative::updateDerivatives(), and bpp::MixtureOfDiscreteDistributions::updateDistribution().

◆ VERY_TINY()

static double bpp::NumConstants::VERY_TINY ( )
inlinestatic

Definition at line 47 of file NumConstants.h.

Referenced by bpp::OneDimensionOptimizationTools::bracketMinimum(), bpp::DirichletDiscreteDistribution::getValueCategory(), bpp::RandomTools::incompleteBeta(), bpp::RandomTools::incompletebetafe(), bpp::RandomTools::incompletebetafe2(), and bpp::RandomTools::incompletebetaps().

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