inet::physicallayer::FrequencyMappingIterator< Interpolator > Class Template Reference

Provides an implementation of the MappingIterator- Interface which is able to iterate over FrequencyMappings. More...

#include <MappingUtils.h>

Inheritance diagram for inet::physicallayer::FrequencyMappingIterator< Interpolator >:

Public Member Functions
	FrequencyMappingIterator (const iterator &it)
	Initializes the Iterator to use the passed InterpolateableMapIterator. More...
	FrequencyMappingIterator (const FrequencyMappingIterator< Interpolator > &o)
virtual	~FrequencyMappingIterator ()
void	jumpTo (const Argument &pos) override
	Lets the iterator point to the passed position. More...
void	iterateTo (const Argument &pos) override
	Iterates to the specified position. More...
virtual void	next () override
	Iterates to the next position of the function. More...
virtual bool	inRange () const override
	Returns true if the current position of the iterator is in range of the function. More...
virtual const Argument &	getPosition () const override
	Returns the current position of the iterator. More...
virtual const Argument &	getNextPosition () const override
	Returns the next position a call to "next()" would jump to. More...
virtual mapped_type	getValue () const override
	Returns the value of the function at the current position. More...
virtual void	jumpToBegin () override
	Lets the iterator point to the begin of the mapping. More...
virtual bool	hasNext () const override
	Returns true if the iterator has a next value inside its range a call to "next()" can jump to. More...
virtual void	setValue (argument_value_cref_t value) override
	Changes the value of the function at the current position. More...
Public Member Functions inherited from inet::physicallayer::MappingIterator
	MappingIterator ()
virtual	~MappingIterator ()
virtual void	setValue (argument_value_cref_t value)=0
	Changes the value of the Mapping at the current position. More...
Public Member Functions inherited from inet::physicallayer::ConstMappingIterator
	ConstMappingIterator ()
virtual	~ConstMappingIterator ()
	ConstMappingIterator (const ConstMappingIterator &)
	Copy constructor. More...
ConstMappingIterator &	operator= (const ConstMappingIterator &)
	ConstMappingIterator assignment operator. More...
void	swap (ConstMappingIterator &)
	Swaps data with another ConstMappingIterator. More...

Protected Types
typedef InterpolateableMap< Interpolator< std::map< argument_value_t, argument_value_t > > >	interpolator_map_type
	The templated InterpolateableMap the underlying Mapping uses std::map as storage type. More...
typedef interpolator_map_type::interpolator_type	interpolator_type
typedef interpolator_map_type::mapped_type	mapped_type
typedef interpolator_map_type::iterator_intpl	iterator
typedef interpolator_map_type::const_iterator_intpl	const_iterator

Protected Member Functions
void	updateNextPos ()

Protected Attributes
iterator	valueIt
	Stores the current position iterator inside the Mapping. More...
Argument	position
	Stores the current position of the iterator. More...
Argument	nextPosition
	Stores the next position a call of "next()" would jump to. More...
bool	isStepMapping
	Stores if this mapping represents a step function. More...
bool	atPreStep

Additional Inherited Members
Public Types inherited from inet::physicallayer::ConstMappingIterator
typedef Argument::mapped_type	argument_value_t
typedef Argument::mapped_type_cref	argument_value_cref_t

Detailed Description

template<template< typename > class Interpolator>
class inet::physicallayer::FrequencyMappingIterator< Interpolator >

Provides an implementation of the MappingIterator- Interface which is able to iterate over FrequencyMappings.

Author

Karl Wessel

Member Typedef Documentation

template<template< typename > class Interpolator>

typedef interpolator_map_type::const_iterator_intpl inet::physicallayer::FrequencyMappingIterator< Interpolator >::const_iterator

protected

template<template< typename > class Interpolator>

typedef InterpolateableMap<Interpolator<std::map<argument_value_t, argument_value_t> > > inet::physicallayer::FrequencyMappingIterator< Interpolator >::interpolator_map_type

protected

The templated InterpolateableMap the underlying Mapping uses std::map as storage type.

template<template< typename > class Interpolator>

typedef interpolator_map_type::interpolator_type inet::physicallayer::FrequencyMappingIterator< Interpolator >::interpolator_type

protected

template<template< typename > class Interpolator>

typedef interpolator_map_type::iterator_intpl inet::physicallayer::FrequencyMappingIterator< Interpolator >::iterator

protected

template<template< typename > class Interpolator>

typedef interpolator_map_type::mapped_type inet::physicallayer::FrequencyMappingIterator< Interpolator >::mapped_type

protected

Constructor & Destructor Documentation

template<template< typename > class Interpolator>

inet::physicallayer::FrequencyMappingIterator< Interpolator >::FrequencyMappingIterator ( const iterator &  it )

inline

Initializes the Iterator to use the passed InterpolateableMapIterator.

        : MappingIterator()
        , valueIt(it)
        , position()
        , nextPosition()
        , isStepMapping(it.getInterpolator().isStepping())
        , atPreStep(false)
    {
        interpolator_type UsedInterpolator;

        isStepMapping = UsedInterpolator.isStepping();
        position.setArgValue(Dimension::frequency, valueIt.getPosition());
        updateNextPos();
    }

template<template< typename > class Interpolator>

inet::physicallayer::FrequencyMappingIterator< Interpolator >::FrequencyMappingIterator ( const FrequencyMappingIterator< Interpolator > &  o )

inline

        : MappingIterator(o)
        , valueIt(o.valueIt)
        , position(o.position)
        , nextPosition(o.nextPosition)
        , isStepMapping(o.isStepMapping)
        , atPreStep(o.atPreStep)
    {}

template<template< typename > class Interpolator>

virtual inet::physicallayer::FrequencyMappingIterator< Interpolator >::~FrequencyMappingIterator ( )

inlinevirtual

{}

Member Function Documentation

template<template< typename > class Interpolator>

virtual const Argument& inet::physicallayer::FrequencyMappingIterator< Interpolator >::getNextPosition ( ) const

inlineoverridevirtual

Returns the next position a call to "next()" would jump to.

This method has constant complexity.

Implements inet::physicallayer::ConstMappingIterator.

    {
        return nextPosition;
    }

template<template< typename > class Interpolator>

virtual const Argument& inet::physicallayer::FrequencyMappingIterator< Interpolator >::getPosition ( ) const

inlineoverridevirtual

Returns the current position of the iterator.

This method has constant complexity.

Implements inet::physicallayer::ConstMappingIterator.

    {
        return position;
    }

template<template< typename > class Interpolator>

virtual mapped_type inet::physicallayer::FrequencyMappingIterator< Interpolator >::getValue ( ) const

inlineoverridevirtual

Returns the value of the function at the current position.

This method has constant complexity.

Implements inet::physicallayer::ConstMappingIterator.

    {
        return *valueIt.getValue();
    }

template<template< typename > class Interpolator>

virtual bool inet::physicallayer::FrequencyMappingIterator< Interpolator >::hasNext ( ) const

inlineoverridevirtual

Returns true if the iterator has a next value inside its range a call to "next()" can jump to.

Constant complexity.

Implements inet::physicallayer::ConstMappingIterator.

    {
        return valueIt.hasNext();
    }

template<template< typename > class Interpolator>

virtual bool inet::physicallayer::FrequencyMappingIterator< Interpolator >::inRange ( ) const

inlineoverridevirtual

Returns true if the current position of the iterator is in range of the function.

This method should be used as end-condition when iterating over the function with the "next()" method.

THis method has constant complexity.

Implements inet::physicallayer::ConstMappingIterator.

    {
        return valueIt.inRange();
    }

template<template< typename > class Interpolator>

void inet::physicallayer::FrequencyMappingIterator< Interpolator >::iterateTo ( const Argument &  pos )

inlineoverridevirtual

Iterates to the specified position.

This method should be used if the new position is near the current position.

The passed position should compared bigger than the current position.

This method has linear complexity over the number of key-entries between the current position and the passed position. So if the passed position is near the current position the complexity is nearly constant.

Implements inet::physicallayer::ConstMappingIterator.

    {
        atPreStep = false;
        valueIt.iterateTo(pos.getArgValue(Dimension::frequency));
        position.setArgValue(Dimension::frequency, pos.getArgValue(Dimension::frequency));
        nextPosition.setArgValue(Dimension::frequency, valueIt.getNextPosition());
        updateNextPos();
    }

template<template< typename > class Interpolator>

void inet::physicallayer::FrequencyMappingIterator< Interpolator >::jumpTo ( const Argument &  pos )

inlineoverridevirtual

Lets the iterator point to the passed position.

The passed new position can be at arbitrary places.

This method has logarithmic complexity.

Implements inet::physicallayer::ConstMappingIterator.

    {
        atPreStep = false;
        valueIt.jumpTo(pos.getArgValue(Dimension::frequency));
        position.setArgValue(Dimension::frequency, pos.getArgValue(Dimension::frequency));
        nextPosition.setArgValue(Dimension::frequency, valueIt.getNextPosition());
        updateNextPos();
    }

template<template< typename > class Interpolator>

virtual void inet::physicallayer::FrequencyMappingIterator< Interpolator >::jumpToBegin ( )

inlineoverridevirtual

Lets the iterator point to the begin of the mapping.

The beginning of the mapping is the smallest key entry in the InterpolateableMap.

Constant complexity.

Implements inet::physicallayer::ConstMappingIterator.

    {
        valueIt.jumpToBegin();
        position.setArgValue(Dimension::frequency, valueIt.getPosition());
    }

template<template< typename > class Interpolator>

virtual void inet::physicallayer::FrequencyMappingIterator< Interpolator >::next ( )

inlineoverridevirtual

Iterates to the next position of the function.

The next position is the next bigger key entry of the InterpoalteableMap.

This method has constant complexity.

Implements inet::physicallayer::ConstMappingIterator.

    {
        if (isStepMapping && !atPreStep) {
            valueIt.iterateTo(nextPosition.getArgValue(Dimension::frequency));
            atPreStep = true;
        }
        else {
            valueIt.next();
            atPreStep = false;
        }
        position.setArgValue(Dimension::frequency, valueIt.getPosition());
        updateNextPos();
    }

template<template< typename > class Interpolator>

virtual void inet::physicallayer::FrequencyMappingIterator< Interpolator >::setValue ( argument_value_cref_t  value )

inlineoverridevirtual

Changes the value of the function at the current position.

This method has constant complexity.

    {
        valueIt.setValue(value);
    }

template<template< typename > class Interpolator>

void inet::physicallayer::FrequencyMappingIterator< Interpolator >::updateNextPos ( )

inlineprotected

    {
        argument_value_t value = valueIt.getNextPosition();
        if (isStepMapping && !atPreStep) {
            value = nexttoward(value, 0);
        }
        nextPosition.setArgValue(Dimension::frequency, value);
    }

Member Data Documentation

template<template< typename > class Interpolator>

bool inet::physicallayer::FrequencyMappingIterator< Interpolator >::atPreStep

protected

template<template< typename > class Interpolator>

bool inet::physicallayer::FrequencyMappingIterator< Interpolator >::isStepMapping

protected

Stores if this mapping represents a step function.

Assures that the steps are considered when iterating the mapping by adding a second key-entry as short as possible before every key entry set by the user. The additional key-entry defines the value the mapping has just before the key entry the user added.

template<template< typename > class Interpolator>

Argument inet::physicallayer::FrequencyMappingIterator< Interpolator >::nextPosition

protected

Stores the next position a call of "next()" would jump to.

template<template< typename > class Interpolator>

Argument inet::physicallayer::FrequencyMappingIterator< Interpolator >::position

protected

Stores the current position of the iterator.

template<template< typename > class Interpolator>

iterator inet::physicallayer::FrequencyMappingIterator< Interpolator >::valueIt

protected

Stores the current position iterator inside the Mapping.

---

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

• MappingUtils.h