Linear in one dimension and constant in the others. More...

#include <PrimitiveFunctions.h>

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

Public Member Functions
	UnilinearFunction (typename D::P lower, typename D::P upper, R rLower, R rUpper, int dimension)

virtual const D::P &	getLower () const

virtual const D::P &	getUpper () const

virtual R	getRLower () const

virtual R	getRUpper () const

virtual int	getDimension () const

virtual double	getA () const

virtual double	getB () const

virtual Interval< R >	getRange () const override
	Returns the valid range of the function as an interval. More...

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 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 typename D::I &i) const override
	Returns true if the function value is non-zero in the given domain. 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 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...

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::FunctionBase< R, D >
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	isNonZero () const override
	Returns true if the function value is non-zero in the whole 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 R	getIntegral (const typename D::I &i) const override
	Returns the integral value for the given 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...

Public Member Functions inherited from inet::math::IFunction< R, D >
virtual	~IFunction ()

Protected Attributes
const D::P	lower

const D::P	upper

const R	rLower

const R	rUpper

const int	dimension

Detailed Description

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

Linear in one dimension and constant in the others.

Constructor & Destructor Documentation

◆ UnilinearFunction()

template<typename R , typename D >

inet::math::UnilinearFunction< R, D >::UnilinearFunction	(	typename D::P	lower,
		typename D::P	upper,
		R	rLower,
		R	rUpper,
		int	dimension
	)

inline

67 :

68 lower(lower), upper(upper), rLower(rLower), rUpper(rUpper), dimension(dimension) {}

Member Function Documentation

◆ getA()

template<typename R , typename D >

virtual double inet::math::UnilinearFunction< R, D >::getA ( ) const

inlinevirtual

76 { return toDouble(rUpper - rLower) / toDouble(upper.get(dimension) - lower.get(dimension)); }

◆ getB()

template<typename R , typename D >

virtual double inet::math::UnilinearFunction< R, D >::getB ( ) const

inlinevirtual

77 { return (toDouble(rLower) * upper.get(dimension) - toDouble(rUpper) * lower.get(dimension)) / (upper.get(dimension) - lower.get(dimension)); }

◆ getDimension()

template<typename R , typename D >

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

inlinevirtual

74 { return dimension; }

◆ getLower()

template<typename R , typename D >

virtual const D::P& inet::math::UnilinearFunction< R, D >::getLower ( ) const

inlinevirtual

70 { return lower; }

◆ getMax()

template<typename R , typename D >

virtual R inet::math::UnilinearFunction< 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 >.

                                                           {
         return math::maxnan(getValue(i.getLower()), getValue(i.getUpper()));
     }

◆ getMean()

template<typename R , typename D >

virtual R inet::math::UnilinearFunction< 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 getValue((i.getLower() + i.getUpper()) / 2);
     }

◆ getMin()

template<typename R , typename D >

virtual R inet::math::UnilinearFunction< 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 >.

                                                           {
         return math::minnan(getValue(i.getLower()), getValue(i.getUpper()));
     }

◆ getRange()

template<typename R , typename D >

virtual Interval<R> inet::math::UnilinearFunction< R, D >::getRange ( ) const

inlineoverridevirtual

Returns the valid range of the function as an interval.

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

79 { return Interval<R>(math::minnan(rLower, rUpper), math::maxnan(rLower, rUpper), 0b1, 0b1, 0b0); }

◆ getRLower()

template<typename R , typename D >

virtual R inet::math::UnilinearFunction< R, D >::getRLower ( ) const

inlinevirtual

72 { return rLower; }

Referenced by inet::math::simplifyAndCall().

◆ getRUpper()

template<typename R , typename D >

virtual R inet::math::UnilinearFunction< R, D >::getRUpper ( ) const

inlinevirtual

73 { return rUpper; }

Referenced by inet::math::simplifyAndCall().

◆ getUpper()

template<typename R , typename D >

virtual const D::P& inet::math::UnilinearFunction< R, D >::getUpper ( ) const

inlinevirtual

71 { return upper; }

◆ getValue()

template<typename R , typename D >

virtual R inet::math::UnilinearFunction< 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 alpha = (p - lower).get(dimension) / (upper - lower).get(dimension);
         return rLower * (1 - alpha) + rUpper * alpha;
     }

◆ isFinite()

template<typename R , typename D >

virtual bool inet::math::UnilinearFunction< R, D >::isFinite ( const typename D::I & i ) const

inlineoverridevirtual

Returns true if the function value is finite in the given domain.

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

                                                                {
         return std::isfinite(toDouble(rLower)) && std::isfinite(toDouble(rUpper));
     }

◆ isNonZero()

template<typename R , typename D >

virtual bool inet::math::UnilinearFunction< R, D >::isNonZero ( const typename D::I & i ) const

inlineoverridevirtual

Returns true if the function value is non-zero in the given domain.

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

                                                                 {
         return rLower != R(0) || rUpper != R(0);
     }

◆ partition()

template<typename R , typename D >

virtual void inet::math::UnilinearFunction< 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::UnilinearFunction< 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 << "linear in dim. " << dimension << " over " << i << "\n"
            << std::string(level + 2, ' ') << "→ " << getValue(i.getLower()) << " … " << getValue(i.getUpper()) << std::endl;
     }

◆ printStructure()

template<typename R , typename D >

virtual void inet::math::UnilinearFunction< R, D >::printStructure	(	std::ostream &	os,
		int	level = `0`
	)		const

inlineoverridevirtual

Prints the internal data structure of this function in a human readable form to the provided stream.

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

                                                                               {
         os << "Linear, " << lower << " … " << upper << " → " << rLower << " … " << rUpper;
     }

Member Data Documentation

◆ dimension

template<typename R , typename D >

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

protected

◆ lower

template<typename R , typename D >

const D::P inet::math::UnilinearFunction< R, D >::lower

protected

◆ rLower

template<typename R , typename D >

const R inet::math::UnilinearFunction< R, D >::rLower

protected

◆ rUpper

template<typename R , typename D >

const R inet::math::UnilinearFunction< R, D >::rUpper

protected

◆ upper

template<typename R , typename D >

const D::P inet::math::UnilinearFunction< R, D >::upper

protected

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

PrimitiveFunctions.h

Public Member Functions

Protected Attributes

Detailed Description

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

Constructor & Destructor Documentation

◆ UnilinearFunction()

Member Function Documentation

◆ getA()

◆ getB()

◆ getDimension()

◆ getLower()

◆ getMax()

◆ getMean()

◆ getMin()

◆ getRange()

◆ getRLower()

◆ getRUpper()

◆ getUpper()

◆ getValue()

◆ isFinite()

◆ isNonZero()

◆ partition()

◆ printPartition()

◆ printStructure()

Member Data Documentation

◆ dimension

◆ lower

◆ rLower

◆ rUpper

◆ upper

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