User Manual, Developers Guide and API Documentation

stateval.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_EVALUATION_STATISTICS_STATEVAL_HPP
#define WNS_EVALUATION_STATISTICS_STATEVAL_HPP

#include <WNS/PyConfigViewCreator.hpp>

namespace wns { namespace evaluation { namespace statistics {
            template <typename T>
            T getMaxError();

            template <>
            inline
            double getMaxError<double>()
            {
                return 0.000000001;
            }

            class StatEvalInterface
            {
            public:
                virtual
                ~StatEvalInterface(){}

                virtual void
                put(double) = 0;

                virtual void
                reset() = 0;

                virtual const std::string&
                getName() const = 0;

                virtual void
                print(std::ostream&) const = 0;

                virtual void
                printLog(std::ostream&) = 0;
            };

            class StatEval : public StatEvalInterface
            {
            public:
                enum functionType
                {
                    df,
                    cdf,
                    pf
                };


                enum formatType
                {
                    fixed,
                    scientific
                };


                StatEval(formatType  format,
                         std::string name,
                         std::string desc);

                StatEval(const wns::pyconfig::View& config);

                virtual ~StatEval();

                virtual
                void print(std::ostream& stream) const;

                virtual void
                printLog(std::ostream& stream);

                enum statEvalType
                {
                    all = 0,
                    lref, lreg, plref, plreg,
                    moments, pmoments,
                    batchMns, pbatchMns,
                    histogrm, phistogrm,
                    dlref, dlreg, dlrep, pdlref, pdlreg, pdlrep,
                    dlref_nonequi, dlreg_nonequi, dlrep_nonequi,
                    pdlref_nonequi, pdlreg_nonequi, pdlrep_nonequi,
                    pdf, ppdf,
                    logeval, plogeval,
                    probetext, pprobetext, unknown
                };

                virtual void
                put(double xI);

                virtual double
                mean() const;

                virtual double
                variance() const;

                virtual double
                relativeVariance() const;

                virtual double
                coeffOfVariation() const;

                virtual double
                M2() const;

                virtual double
                M3() const;

                virtual double
                Z3() const;

                virtual double
                skewness() const;

                virtual double
                deviation() const;

                virtual double
                relativeDeviation() const;

                virtual unsigned long int
                trials() const;

                virtual double
                min() const;

                virtual double
                max() const;

                virtual void
                reset();

                virtual const
                std::string& getName() const;

                virtual const std::string&
                getDesc() const;

                virtual void
                setFormat(formatType format);

                virtual formatType
                getFormat() const;

                static statEvalType
                mapToStatEvalType(std::string type);


                static std::string
                mapEvalTypeToString(statEvalType);

            protected:

                void
                printBanner(std::ostream& stream    ,
                            std::string probeTypeDesc,
                            std::string errorString) const;

                double minValue_;

                double maxValue_;

                unsigned long int numTrials_;

                double sum_;

                double squareSum_;

                double cubeSum_;

                StatEval::formatType format_;

                std::string name_;

                std::string desc_;

                std::string prefix_;

                double scalingFactor_;
            };


            typedef wns::PyConfigViewCreator<StatEvalInterface, StatEvalInterface> Creator;
            typedef wns::StaticFactory<Creator> Factory;

        } // statistics
    } //evaluation
} // wns

#endif  // WNS_EVALUATION_STATISTICS_STATEVAL_HPP

---