inet::math::UnireciprocalFunction< R, D > Class Template Reference

Reciprocal in a given dimension and constant in the others. More...

#include <PrimitiveFunctions.h>

Inheritance diagram for inet::math::UnireciprocalFunction< R, D >:

Public Member Functions
	UnireciprocalFunction (double a, double b, double c, double d, int dimension)
virtual int	getDimension () const
virtual R	getValue (const typename D::P &p) const override
	Returns the value of the function at the given point. More...
virtual void	partition (const typename D::I &i, const std::function< void(const typename D::I &, const IFunction< R, D > *)> callback) const override
	Subdivides the provided domain and calls back f with the subdomains and the corresponding potentially simpler domain limited functions. More...
virtual R	getMin (const typename D::I &i) const override
	Returns the minimum value for the given domain. More...
virtual R	getMax (const typename D::I &i) const override
	Returns the maximum value for the given domain. More...
virtual R	getMean (const typename D::I &i) const override
	Returns the mean value for the given domain. More...
virtual R	getIntegral (const typename D::I &i) const override
	Returns the integral value for the given domain. More...
virtual void	printPartition (std::ostream &os, const typename D::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...
Public Member Functions inherited from inet::math::FunctionBase< R, D >
virtual Interval< R >	getRange () const override
	Returns the valid range of the function as an interval. More...
virtual Interval< R >	getRange (const typename D::I &i) const override
	Returns the valid range of the function as an interval for the given domain. More...
virtual D::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 D::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 D::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	getMax () const override
	Returns the maximum value for the whole domain. More...
virtual R	getMean () const override
	Returns the mean value for the whole domain. More...
virtual R	getIntegral () const override
	Returns the integral value for the whole domain. More...
virtual const Ptr< const IFunction< R, D > >	add (const Ptr< const IFunction< R, D >> &o) const override
	Adds the provided function to this function. More...
virtual const Ptr< const IFunction< R, D > >	subtract (const Ptr< const IFunction< R, D >> &o) const override
	Substracts the provided function from this function. More...
virtual const Ptr< const IFunction< R, D > >	multiply (const Ptr< const IFunction< double, D >> &o) const override
	Multiplies the provided function with this function. More...
virtual const Ptr< const IFunction< double, D > >	divide (const Ptr< const IFunction< R, D >> &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 D::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 D::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	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, D >
virtual	~IFunction ()

Protected Member Functions
virtual double	getIntegralFunctionValue (const typename D::P &p) const

Protected Attributes
const double	a
const double	b
const double	c
const double	d
const int	dimension

Detailed Description

template<typename R, typename D>
class inet::math::UnireciprocalFunction< R, D >

Reciprocal in a given dimension and constant in the others.

Constructor & Destructor Documentation

UnireciprocalFunction()

template<typename R , typename D >

inet::math::UnireciprocalFunction< R, D >::UnireciprocalFunction ( double  a, double  b, double  c, double  d, int  dimension  )

inline

: a(a), b(b), c(c), d(d), dimension(dimension) {}

Member Function Documentation

getDimension()

template<typename R , typename D >

virtual int inet::math::UnireciprocalFunction< R, D >::getDimension ( ) const

inlinevirtual

{ return dimension; }

getIntegral()

template<typename R , typename D >

virtual R inet::math::UnireciprocalFunction< R, D >::getIntegral ( const typename D::I &  i ) const

inlineoverridevirtual

Returns the integral value for the given domain.

Reimplemented from inet::math::FunctionBase< R, D >.

                                                               {
        return R(getIntegralFunctionValue(i.getUpper()) - getIntegralFunctionValue(i.getLower()));
    }

getIntegralFunctionValue()

template<typename R , typename D >

virtual double inet::math::UnireciprocalFunction< R, D >::getIntegralFunctionValue ( const typename D::P &  p ) const

inlineprotectedvirtual

                                                                        {
        // https://www.wolframalpha.com/input/?i=integrate+(a+*+x+%2B+b)+%2F+(c+*+x+%2B+d)
        double x = p.get(dimension);
        return (a * c * x + (b * c - a * d) * std::log(d + c * x)) / (c * c);
    }

getMax()

template<typename R , typename D >

virtual R inet::math::UnireciprocalFunction< R, D >::getMax ( const typename D::I &  i ) const

inlineoverridevirtual

Returns the maximum value for the given domain.

Reimplemented from inet::math::FunctionBase< R, D >.

                                                          {
        double x = -d / c;
        if (i.getLower().get(dimension) < x && x < i.getUpper().get(dimension))
            return getUpperBound<R>();
        else
            return math::maxnan(getValue(i.getLower()), getValue(i.getUpper()));
    }

getMean()

template<typename R , typename D >

virtual R inet::math::UnireciprocalFunction< R, D >::getMean ( const typename D::I &  i ) const

inlineoverridevirtual

Returns the mean value for the given domain.

Reimplemented from inet::math::FunctionBase< R, D >.

                                                           {
        return getIntegral(i) / (i.getUpper().get(dimension) - i.getLower().get(dimension));
    }

getMin()

template<typename R , typename D >

virtual R inet::math::UnireciprocalFunction< R, D >::getMin ( const typename D::I &  i ) const

inlineoverridevirtual

Returns the minimum value for the given domain.

Reimplemented from inet::math::FunctionBase< R, D >.

                                                          {
        double x = -d / c;
        if (i.getLower().get(dimension) < x && x < i.getUpper().get(dimension))
            return getLowerBound<R>();
        else
            return math::minnan(getValue(i.getLower()), getValue(i.getUpper()));
    }

getValue()

template<typename R , typename D >

virtual R inet::math::UnireciprocalFunction< R, D >::getValue ( const typename D::P &  p ) const

inlineoverridevirtual

Returns the value of the function at the given point.

The returned value falls into the range of the function. The provided point must fall into the domain of the function.

Implements inet::math::IFunction< R, D >.

                                                            {
        double x = p.get(dimension);
        return R(a * x + b) / (c * x + d);
    }

partition()

template<typename R , typename D >

virtual void inet::math::UnireciprocalFunction< R, D >::partition ( const typename D::I &  i, const std::function< void(const typename D::I &, const IFunction< R, D > *)>  f  ) const

inlineoverridevirtual

Subdivides the provided domain and calls back f with the subdomains and the corresponding potentially simpler domain limited functions.

Reimplemented from inet::math::FunctionBase< R, D >.

                                                                                                                                               {
        callback(i, this);
    }

printPartition()

template<typename R , typename D >

virtual void inet::math::UnireciprocalFunction< R, D >::printPartition ( std::ostream &  os, const typename D::I &  i, int  level = 0  ) const

inlineoverridevirtual

Prints a single partition of this function in a human readable form to the provided stream for the given domain.

Reimplemented from inet::math::FunctionBase< R, D >.

                                                                                                    {
        os << "reciprocal in dim. " << dimension << " over " << i << "\n"
           << std::string(level + 2, ' ') << "→ " << getValue(i.getLower()) << " … " << getValue(i.getUpper()) << std::endl;
    }

Member Data Documentation

a

template<typename R , typename D >

const double inet::math::UnireciprocalFunction< R, D >::a

protected

b

template<typename R , typename D >

const double inet::math::UnireciprocalFunction< R, D >::b

protected

c

template<typename R , typename D >

const double inet::math::UnireciprocalFunction< R, D >::c

protected

d

template<typename R , typename D >

const double inet::math::UnireciprocalFunction< R, D >::d

protected

dimension

template<typename R , typename D >

const int inet::math::UnireciprocalFunction< R, D >::dimension

protected

---

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

• PrimitiveFunctions.h