User Manual, Developers Guide and API Documentation

Average.hpp

Go to the documentation of this file.

/*******************************************************************************
 * This file is part of openWNS (open Wireless Network Simulator)
 * _____________________________________________________________________________
 *
 * Copyright (C) 2004-2007
 * Chair of Communication Networks (ComNets)
 * Kopernikusstr. 16, D-52074 Aachen, Germany
 * phone: ++49-241-80-27910,
 * fax: ++49-241-80-22242
 * email: info@openwns.org
 * www: http://www.openwns.org
 * _____________________________________________________________________________
 *
 * openWNS is free software; you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License version 2 as published by the
 * Free Software Foundation;
 *
 * openWNS is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 * A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 ******************************************************************************/

#ifndef WNS_AVERAGE_HPP
#define WNS_AVERAGE_HPP

#include <stdint.h>

namespace wns {
    class AverageBase
    {
    public:
        AverageBase() :
            mean(0.0),
            samples(0)
        {
            
        }

        virtual
        ~AverageBase()
        {
            
        }

        virtual void
        reset()
        {
            mean = 0.0;
            samples = 0;
            
        }

    protected:
        double mean;

        unsigned long int samples;
    }; // AverageBase

    template <typename C>
    class Average :
        public AverageBase
    {
    public:
        Average() :
            AverageBase()
        {
            
        }

        virtual
        ~Average()
        {
            
        }

        virtual void
        put(const C& c)
        {
            mean *= 1-1.0/++samples;
            mean += convertForAveraging(c)/samples;
            
        }

        virtual C
        get() const
        {
            
            return convertForAveraged(mean);
        }

    protected:
        C
        convertForAveraged(double result) const
        {
            
            return C::convertForAveraged(result);
        }

        double
        convertForAveraging(const C& c) const
        {
            
            return c.convertForAveraging();
        }
    }; // Average<C>

    template <>
    class Average<double> :
        public AverageBase
    {
    public:
        virtual void
        put(const double& c)
        {
            mean *= 1-1.0/++samples;
            mean += convertForAveraging(c)/samples;
            
        }

        virtual double
        get() const
        {
            
            return mean;
        }

    protected:
        double
        convertForAveraged(double result)
        {
            
            return result;
        }

        double
        convertForAveraging(const double& c)
        {
            
            return c;
        }
    }; // Average<double>

} // wns

#endif // NOT defined WNS_AVERAGE_HPP


/*
  Local Variables:
  mode: c++
  fill-column: 80
  c-basic-offset: 8
  c-tab-always-indent: t
  indent-tabs-mode: t
  tab-width: 8
  End:
*/

---