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

Implementation of the Mapping-interface which is able to represent arbitrary dimensional instances of Mappings by using a tree-like structure of sub-mappings, each representing the values for one of the dimensions. More...

#include <MappingUtils.h>

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

Public Member Functions
	MultiDimMapping (const DimensionSet &myDims)
	Initializes the Mapping with the passed DimensionSet as domain. More...
	MultiDimMapping (const DimensionSet &myDims, argument_value_cref_t oorv)
	Initializes the Mapping with the passed DimensionSet as domain. More...
	MultiDimMapping (const MultiDimMapping< Interpolator > &o)
	Copy-constructor which assures that the sub-mappings are deep copied instead of only their the pointers. More...
const MultiDimMapping &	operator= (const MultiDimMapping< Interpolator > &o)
	Copy operator which assures that the sub-mappings are deep copied instead of only their the pointers. More...
virtual Mapping *	clone () const override
	returns a deep copy of this mapping instance. More...
virtual	~MultiDimMapping ()
	Frees the memory for the sub mappings. More...
virtual argument_value_t	getValue (const Argument &pos) const override
	Returns the value of this Mapping at position specified by the passed Argument. More...
virtual void	setValue (const Argument &pos, argument_value_cref_t value) override
	Changes the value of the Mapping at the specified position. More...
virtual MappingIterator *	createIterator () override
	Returns a pointer of a new Iterator which is able to iterate over the Mapping and can change the value the iterator points to. More...
virtual MappingIterator *	createIterator (const Argument &pos) override
	Returns a pointer of a new Iterator which is able to iterate over the Mapping and can change the value the iterator points to. More...
Dimension	getDimension ()
	Returns the dimension this instance represents. More...
Public Member Functions inherited from inet::physicallayer::Mapping
Mapping &	operator= (const Mapping &copy)
	Mapping assignment operator. More...
void	swap (Mapping &s)
	Swaps data with another Mapping. More...
	Mapping (const DimensionSet &dims)
	Initializes the Mapping with the passed DimensionSet as domain. More...
	Mapping ()
	Initializes the Mapping with the time dimension as domain. More...
	Mapping (const Mapping &o)
virtual	~Mapping ()
virtual void	setValue (const Argument &pos, argument_value_cref_t value)=0
	Changes the value of the Mapping at the specified position. More...
virtual void	appendValue (const Argument &pos, argument_value_cref_t value)
	Appends the passed value at the passed position to the mapping. More...
virtual ConstMappingIterator *	createConstIterator () const override
	Returns an ConstMappingIterator by use of the respective implementation of the "createIterator()"-method. More...
virtual ConstMappingIterator *	createConstIterator (const Argument &pos) const override
	Returns an ConstMappingIterator by use of the respective implementation of the "createIterator()"-method. More...
virtual ConstMapping *	constClone () const override
	Returns a deep const copy of this mapping by using the according "clone()"-implementation. More...
Public Member Functions inherited from inet::physicallayer::ConstMapping
ConstMapping &	operator= (const ConstMapping &copy)
	ConstMapping assignment operator. More...
void	swap (ConstMapping &s)
	Swaps data with another ConstMapping. More...
	ConstMapping ()
	Initializes the ConstMapping with a the time dimension as domain. More...
	ConstMapping (const ConstMapping &o)
	ConstMapping (const DimensionSet &dimSet)
	Initializes the ConstMapping with the passed DimensionSet as Domain. More...
virtual	~ConstMapping ()
argument_value_t	operator[] (const Argument &pos) const
	Returns the value of this Mapping at the position specified by the passed Argument. More...
const DimensionSet &	getDimensionSet () const
	Returns this Mappings domain as DimensionSet. More...
template<class stream >
stream &	print (stream &out, argument_value_cref_t lTimeScale=argument_value_t(1), argument_value_cref_t lLeftColScale=Argument::MappedOne, const std::string &sTableHead=std::string("o\\ms"), const Dimension *const pOnlyDim=nullptr) const
	Prints the Mapping to an output stream. More...

Protected Types
typedef InterpolateableMap< Interpolator< std::map< argument_value_t, Mapping * > > >	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::mapped_cref_type	mapped_cref_type
typedef interpolator_map_type::iterator_intpl	iterator
typedef interpolator_map_type::const_iterator_intpl	const_iterator

Protected Member Functions
	MultiDimMapping (const DimensionSet &myDims, Dimension myDim)
	Initializes the Mapping with the passed DimensionSet as domain and the passed dimension as the dimension this instance should represent. More...
	MultiDimMapping (const DimensionSet &myDims, Dimension myDim, ConstantSimpleConstMapping *oorm, ConstMappingWrapper *wrappedoorm)
	Initializes the Mapping with the passed DimensionSet as domain and the passed dimension as the dimension this instance should represent. More...
	MultiDimMapping (const MultiDimMapping< Interpolator > &o, ConstantSimpleConstMapping *oorm, ConstMappingWrapper *wrappedoorm)
	Intern copy-constructor which assures that the sub-mappings are deep copied instead of only their pointers. More...
mapped_type	createSubSignal () const
	Internal helper method which creates a new sub-mapping for this MultiDimMapping instance. More...
void	copySubMappings ()

Protected Attributes
ConstantSimpleConstMapping *	outOfRangeMapping
	Returned by the Interpolator if the mapping is accessed outside its range (before or after the last key entry in a dimension). More...
ConstMappingWrapper *	wrappedOORMapping
	Wraps the out of range mapping which is an instance of ConstMapping inside an instance of Mapping which setValue method is asserted to never be called. More...
interpolator_map_type	entries
	Stores the sub-mappings for the dimension this instance represents. More...
Dimension	myDimension
	The dimension this instance represents. More...
bool	isMaster
Protected Attributes inherited from inet::physicallayer::ConstMapping
DimensionSet	dimensions
	The dimensions of this mappings domain. More...

Friends
class	MultiDimMappingIterator< Interpolator >

Additional Inherited Members
Public Types inherited from inet::physicallayer::Mapping
enum	InterpolationMethod { STEPS, NEAREST, LINEAR }
	Types of interpolation methods for mappings. More...
Public Types inherited from inet::physicallayer::ConstMapping
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::MultiDimMapping< Interpolator >

Implementation of the Mapping-interface which is able to represent arbitrary dimensional instances of Mappings by using a tree-like structure of sub-mappings, each representing the values for one of the dimensions.

This class internally uses a map of Mappings two represent one dimension. Where every Mapping in the map represents a sub-mapping for the values in the next dimension at that position in the this dimension. These sub-mappings can either be in turn MultiDimMappings with further sub-mappings or they can be TimedMappings if their dimension is the time. The TimedMappings therefore represent the leafs of the tree-like structure.

Author

Karl Wessel

Member Typedef Documentation

template<template< typename > class Interpolator>

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

protected

template<template< typename > class Interpolator>

typedef InterpolateableMap<Interpolator<std::map<argument_value_t, Mapping *> > > inet::physicallayer::MultiDimMapping< 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::MultiDimMapping< Interpolator >::interpolator_type

protected

template<template< typename > class Interpolator>

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

protected

template<template< typename > class Interpolator>

typedef interpolator_map_type::mapped_cref_type inet::physicallayer::MultiDimMapping< Interpolator >::mapped_cref_type

protected

template<template< typename > class Interpolator>

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

protected

Constructor & Destructor Documentation

template<template< typename > class Interpolator>

inet::physicallayer::MultiDimMapping< Interpolator >::MultiDimMapping ( const DimensionSet &  myDims, Dimension  myDim  )

inlineprotected

Initializes the Mapping with the passed DimensionSet as domain and the passed dimension as the dimension this instance should represent.

Also takes the interpolation method to use, but not yet implemented.

This constructor is only used internally to create the sub-mappings.

                                                                 :
        Mapping(myDims),
        outOfRangeMapping(0),
        wrappedOORMapping(0),
        entries(),
        myDimension(myDim),
        isMaster(false) {}

template<template< typename > class Interpolator>

inet::physicallayer::MultiDimMapping< Interpolator >::MultiDimMapping ( const DimensionSet &  myDims, Dimension  myDim, ConstantSimpleConstMapping *  oorm, ConstMappingWrapper *  wrappedoorm  )

inlineprotected

Initializes the Mapping with the passed DimensionSet as domain and the passed dimension as the dimension this instance should represent.

Also takes the interpolation method to use, but not yet implemented.

This constructor is only used internally to create the sub-mappings.

                                              :
        Mapping(myDims),
        outOfRangeMapping(oorm),
        wrappedOORMapping(wrappedoorm),
        entries(wrappedOORMapping),
        myDimension(myDim),
        isMaster(false) {}

template<template< typename > class Interpolator>

inet::physicallayer::MultiDimMapping< Interpolator >::MultiDimMapping ( const MultiDimMapping< Interpolator > &  o, ConstantSimpleConstMapping *  oorm, ConstMappingWrapper *  wrappedoorm  )

inlineprotected

Intern copy-constructor which assures that the sub-mappings are deep copied instead of only their pointers.

                                              :
        Mapping(o),
        outOfRangeMapping(oorm),
        wrappedOORMapping(wrappedoorm),
        entries(o.entries),
        myDimension(o.myDimension),
        isMaster(false)
    {
        entries.setOutOfRangeVal(wrappedOORMapping);

        copySubMappings();
    }

template<template< typename > class Interpolator>

inet::physicallayer::MultiDimMapping< Interpolator >::MultiDimMapping ( const DimensionSet &  myDims )

inline

Initializes the Mapping with the passed DimensionSet as domain.

Also takes the interpolation-method but is not used yet.

                                                :
        Mapping(myDims),
        outOfRangeMapping(0),
        wrappedOORMapping(0),
        entries(),
        myDimension(),
        isMaster(true)
    {
        myDimension = *(dimensions.rbegin());
    }

template<template< typename > class Interpolator>

inet::physicallayer::MultiDimMapping< Interpolator >::MultiDimMapping ( const DimensionSet &  myDims, argument_value_cref_t  oorv  )

inline

Initializes the Mapping with the passed DimensionSet as domain.

Also takes the interpolation-method but is not used yet.

                                                                            :
        Mapping(myDims),
        outOfRangeMapping(new ConstantSimpleConstMapping(myDims, oorv)),
        wrappedOORMapping(new ConstMappingWrapper(outOfRangeMapping)),
        entries(wrappedOORMapping),
        myDimension(),
        isMaster(true)
    {
        myDimension = *(dimensions.rbegin());
    }

template<template< typename > class Interpolator>

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

inline

Copy-constructor which assures that the sub-mappings are deep copied instead of only their the pointers.

                                                            :
        Mapping(o),
        outOfRangeMapping(o.outOfRangeMapping),
        wrappedOORMapping(o.wrappedOORMapping),
        entries(o.entries),
        myDimension(o.myDimension),
        isMaster(true)
    {
        if (outOfRangeMapping != 0) {
            outOfRangeMapping = new ConstantSimpleConstMapping(dimensions, o.outOfRangeMapping->getValue());
            wrappedOORMapping = new ConstMappingWrapper(outOfRangeMapping);
            entries.setOutOfRangeVal(wrappedOORMapping);
        }
        copySubMappings();
    }

template<template< typename > class Interpolator>

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

inlinevirtual

Frees the memory for the sub mappings.

    {
        const typename interpolator_map_type::const_iterator itEnd = entries.end();
        for (typename interpolator_map_type::const_iterator it = entries.begin(); it != itEnd; ++it) {
            if (it->second)
                delete it->second;
        }

        if (isMaster) {
            if (outOfRangeMapping)
                delete outOfRangeMapping;
            if (wrappedOORMapping)
                delete wrappedOORMapping;
        }
    }

Member Function Documentation

template<template< typename > class Interpolator>

virtual Mapping* inet::physicallayer::MultiDimMapping< Interpolator >::clone ( ) const

inlineoverridevirtual

returns a deep copy of this mapping instance.

Implements inet::physicallayer::Mapping.

{ return new MultiDimMapping<Interpolator>(*this); }

template<template< typename > class Interpolator>

void inet::physicallayer::MultiDimMapping< Interpolator >::copySubMappings ( )

inlineprotected

    {
        const auto itEnd = entries.end();
        Dimension nextDim = *(--dimensions.find(myDimension));

        if (nextDim == Dimension::time) {
            for (auto it = entries.begin(); it != itEnd; ++it) {
                it->second = new TimeMapping<Interpolator>(*(static_cast<TimeMapping<Interpolator> *>(it->second)));
            }
        }
        else {
            for (auto it = entries.begin(); it != itEnd; ++it) {
                if (outOfRangeMapping == 0) {
                    it->second = new MultiDimMapping<Interpolator>(*(static_cast<MultiDimMapping<Interpolator> *>(it->second)));
                }
                else {
                    it->second = new MultiDimMapping<Interpolator>(*(static_cast<MultiDimMapping<Interpolator> *>(it->second)), outOfRangeMapping, wrappedOORMapping);
                }
            }
        }
    }

template<template< typename > class Interpolator>

virtual MappingIterator* inet::physicallayer::MultiDimMapping< Interpolator >::createIterator ( )

inlineoverridevirtual

Returns a pointer of a new Iterator which is able to iterate over the Mapping and can change the value the iterator points to.

The caller of this method has to delete the Iterator if not needed anymore.

Implements inet::physicallayer::Mapping.

Reimplemented in inet::physicallayer::FilledUpMapping.

    {
        return new MultiDimMappingIterator<Interpolator>(*this);
    }

template<template< typename > class Interpolator>

virtual MappingIterator* inet::physicallayer::MultiDimMapping< Interpolator >::createIterator ( const Argument &  pos )

inlineoverridevirtual

Returns a pointer of a new Iterator which is able to iterate over the Mapping and can change the value the iterator points to.

The caller of this method has to delete the Iterator if not needed anymore.

Implements inet::physicallayer::Mapping.

Reimplemented in inet::physicallayer::FilledUpMapping.

    {
        return new MultiDimMappingIterator<Interpolator>(*this, pos);
    }

template<template< typename > class Interpolator>

mapped_type inet::physicallayer::MultiDimMapping< Interpolator >::createSubSignal ( ) const

inlineprotected

Internal helper method which creates a new sub-mapping for this MultiDimMapping instance.

Referenced by inet::physicallayer::FilledUpMapping::createSubSignal(), and inet::physicallayer::MultiDimMappingIterator< Linear >::setValue().

    {
        const Dimension& nextDim = *(--dimensions.find(myDimension));
        if (wrappedOORMapping == 0) {
            if (nextDim == Dimension::time)
                return new TimeMapping<Interpolator>();
            else
                return new MultiDimMapping<Interpolator>(dimensions, nextDim);
        }
        else {
            if (nextDim == Dimension::time)
                return new TimeMapping<Interpolator>(outOfRangeMapping->getValue());
            else
                return new MultiDimMapping<Interpolator>(dimensions, nextDim, outOfRangeMapping, wrappedOORMapping);
        }
    }

template<template< typename > class Interpolator>

Dimension inet::physicallayer::MultiDimMapping< Interpolator >::getDimension ( )

inline

Returns the dimension this instance represents.

{ return myDimension; }

template<template< typename > class Interpolator>

virtual argument_value_t inet::physicallayer::MultiDimMapping< Interpolator >::getValue ( const Argument &  pos ) const

inlineoverridevirtual

Returns the value of this Mapping at position specified by the passed Argument.

Has logarithmic complexity over the number of dimensions and the number of entries per dimension.

Implements inet::physicallayer::ConstMapping.

    {
        assert(pos.hasArgVal(myDimension));
        argument_value_cref_t argVal = pos.getArgValue(myDimension);
        typename interpolator_map_type::interpolated subM = entries.getIntplValue(argVal);

        if (!(*subM))
            return Argument::MappedZero;

        return (*subM)->getValue(pos);
    }

template<template< typename > class Interpolator>

const MultiDimMapping& inet::physicallayer::MultiDimMapping< Interpolator >::operator= ( const MultiDimMapping< Interpolator > &  o )

inline

Copy operator which assures that the sub-mappings are deep copied instead of only their the pointers.

    {
        const typename interpolator_map_type::const_iterator itEnd = entries.end();
        for (typename interpolator_map_type::const_iterator it = entries.begin(); it != itEnd; ++it) {
            if (it->second)
                delete it->second;
        }

        dimensions = o.dimensions;
        entries = o.entries;
        myDimension = o.myDimension;
        outOfRangeMapping = o.outOfRangeMapping;
        wrappedOORMapping = o.wrappedOORMapping;
        isMaster = true;

        if (outOfRangeMapping != 0) {
            outOfRangeMapping = new ConstantSimpleConstMapping(dimensions, o.outOfRangeMapping->getValue());
            wrappedOORMapping = new ConstMappingWrapper(outOfRangeMapping);
            entries.setOutOfRangeVal(wrappedOORMapping);
        }

        copySubMappings();

        return *this;
    }

template<template< typename > class Interpolator>

virtual void inet::physicallayer::MultiDimMapping< Interpolator >::setValue ( const Argument &  pos, argument_value_cref_t  value  )

inlineoverridevirtual

Changes the value of the Mapping at the specified position.

Has logarithmic complexity over the number of dimensions and the number of entries per dimension.

    {
        argument_value_cref_t argVal = pos.getArgValue(myDimension);
        auto posIt = entries.lower_bound(argVal);

        if (posIt == entries.end() || (entries.key_comp()(argVal, posIt->first))) {
            posIt = entries.insert(posIt, std::make_pair(argVal, createSubSignal()));
        }
        posIt->second->setValue(pos, value);
    }

Friends And Related Function Documentation

template<template< typename > class Interpolator>

friend class MultiDimMappingIterator< Interpolator >

friend

Member Data Documentation

template<template< typename > class Interpolator>

interpolator_map_type inet::physicallayer::MultiDimMapping< Interpolator >::entries

protected

Stores the sub-mappings for the dimension this instance represents.

Referenced by inet::physicallayer::MultiDimMapping< Linear >::operator=().

template<template< typename > class Interpolator>

bool inet::physicallayer::MultiDimMapping< Interpolator >::isMaster

protected

template<template< typename > class Interpolator>

Dimension inet::physicallayer::MultiDimMapping< Interpolator >::myDimension

protected

The dimension this instance represents.

Referenced by inet::physicallayer::MultiDimMappingIterator< Linear >::iterateTo(), inet::physicallayer::MultiDimMappingIterator< Linear >::jumpTo(), inet::physicallayer::MultiDimMappingIterator< Linear >::jumpToBegin(), inet::physicallayer::MultiDimMappingIterator< Linear >::MultiDimMappingIterator(), inet::physicallayer::MultiDimMappingIterator< Linear >::next(), inet::physicallayer::MultiDimMapping< Linear >::operator=(), and inet::physicallayer::MultiDimMappingIterator< Linear >::updateNextPosition().

template<template< typename > class Interpolator>

ConstantSimpleConstMapping* inet::physicallayer::MultiDimMapping< Interpolator >::outOfRangeMapping

protected

Returned by the Interpolator if the mapping is accessed outside its range (before or after the last key entry in a dimension).

Referenced by inet::physicallayer::MultiDimMapping< Linear >::MultiDimMapping(), and inet::physicallayer::MultiDimMapping< Linear >::operator=().

template<template< typename > class Interpolator>

ConstMappingWrapper* inet::physicallayer::MultiDimMapping< Interpolator >::wrappedOORMapping

protected

Wraps the out of range mapping which is an instance of ConstMapping inside an instance of Mapping which setValue method is asserted to never be called.

Referenced by inet::physicallayer::MultiDimMapping< Linear >::operator=().

---

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

• MappingUtils.h