inet::math::GaussFunction< R, X > Class Template Reference

The one-dimensional Gauss function. More...

#include <PrimitiveFunctions.h>

Inheritance diagram for inet::math::GaussFunction< R, X >:

Public Member Functions
	GaussFunction (X mean, X stddev)
virtual R	getValue (const Point< X > &p) const override
Public Member Functions inherited from inet::math::FunctionBase< R, Domain< X > >
virtual void	partition (const typename Domain< X > ::I &i, const std::function< void(const typename Domain< X > ::I &, const IFunction< R, Domain< X > > *)> callback) const override
	Subdivides the provided domain and calls back f with the subdomains and the corresponding potentially simpler domain limited functions. More...
virtual Interval< R >	getRange () const override
	Returns the valid range of the function as an interval. More...
virtual Interval< R >	getRange (const typename Domain< X > ::I &i) const override
	Returns the valid range of the function as an interval for the given domain. More...
virtual Domain< X > ::I	getDomain () const override
	Returns the valid domain of the function as an interval. More...
virtual bool	isFinite () const override
	Returns true if the function value is finite in the whole domain. More...
virtual bool	isFinite (const typename Domain< X > ::I &i) const override
	Returns true if the function value is finite in the given domain. More...
virtual bool	isNonZero () const override
	Returns true if the function value is non-zero in the whole domain. More...
virtual bool	isNonZero (const typename Domain< X > ::I &i) const override
	Returns true if the function value is non-zero in the given domain. More...
virtual R	getMin () const override
	Returns the minimum value for the whole domain. More...
virtual R	getMin (const typename Domain< X > ::I &i) const override
	Returns the minimum value for the given domain. More...
virtual R	getMax () const override
	Returns the maximum value for the whole domain. More...
virtual R	getMax (const typename Domain< X > ::I &i) const override
	Returns the maximum value for the given domain. More...
virtual R	getMean () const override
	Returns the mean value for the whole domain. More...
virtual R	getMean (const typename Domain< X > ::I &i) const override
	Returns the mean value for the given domain. More...
virtual R	getIntegral () const override
	Returns the integral value for the whole domain. More...
virtual R	getIntegral (const typename Domain< X > ::I &i) const override
	Returns the integral value for the given domain. More...
virtual const Ptr< const IFunction< R, Domain< X > > >	add (const Ptr< const IFunction< R, Domain< X > >> &o) const override
	Adds the provided function to this function. More...
virtual const Ptr< const IFunction< R, Domain< X > > >	subtract (const Ptr< const IFunction< R, Domain< X > >> &o) const override
	Substracts the provided function from this function. More...
virtual const Ptr< const IFunction< R, Domain< X > > >	multiply (const Ptr< const IFunction< double, Domain< X > >> &o) const override
	Multiplies the provided function with this function. More...
virtual const Ptr< const IFunction< double, Domain< X > > >	divide (const Ptr< const IFunction< R, Domain< X > >> &o) const override
	Divides this function with the provided function. More...
virtual std::ostream &	printOn (std::ostream &os) const override
virtual void	print (std::ostream &os, int level=0) const override
	Prints this function in human readable form to the provided stream for the whole domain. More...
virtual void	print (std::ostream &os, const typename Domain< X > ::I &i, int level=0) const override
	Prints this function in a human readable form to the provided stream for the given domain. More...
virtual void	printPartitioning (std::ostream &os, const typename Domain< X > ::I &i, int level) const override
	Prints the partitioning of this function in a human readable form to the provided stream for the given domain. More...
virtual void	printPartition (std::ostream &os, const typename Domain< X > ::I &i, int level=0) const override
	Prints a single partition of this function in a human readable form to the provided stream for the given domain. More...
virtual void	printStructure (std::ostream &os, int level=0) const override
	Prints the internal data structure of this function in a human readable form to the provided stream. More...
Public Member Functions inherited from inet::math::IFunction< R, Domain< X > >
virtual	~IFunction ()
virtual R	getValue (const typename Domain< X > ::P &p) const=0
	Returns the value of the function at the given point. More...

Protected Attributes
const X	mean
const X	stddev

Detailed Description

template<typename R, typename X>
class inet::math::GaussFunction< R, X >

The one-dimensional Gauss function.

Constructor & Destructor Documentation

GaussFunction()

template<typename R , typename X >

inet::math::GaussFunction< R, X >::GaussFunction ( X  mean, X  stddev  )

inline

: mean(mean), stddev(stddev) {}

Member Function Documentation

getValue()

template<typename R , typename X >

virtual R inet::math::GaussFunction< R, X >::getValue ( const Point< X > &  p ) const

inlineoverridevirtual

                                                         {
        static const double c = 1 / sqrt(2 * M_PI);
        X x = std::get<0>(p);
        double a = toDouble((x - mean) / stddev);
        return R(c / toDouble(stddev) * std::exp(-0.5 * a * a));
    }

Member Data Documentation

mean

template<typename R , typename X >

const X inet::math::GaussFunction< R, X >::mean

protected

stddev

template<typename R , typename X >

const X inet::math::GaussFunction< R, X >::stddev

protected

---

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

• PrimitiveFunctions.h