X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=senf%2FUtils%2FStatisticAccumulator.hh;h=ae35600d2f641fd2915eccc87641facb048487e3;hb=HEAD;hp=08ba3447f0d6c21cbda70a32e85a22809270d621;hpb=92d091c2e5b387ca0c9930c7bc88d9b45630a845;p=senf.git diff --git a/senf/Utils/StatisticAccumulator.hh b/senf/Utils/StatisticAccumulator.hh index 08ba344..ae35600 100644 --- a/senf/Utils/StatisticAccumulator.hh +++ b/senf/Utils/StatisticAccumulator.hh @@ -2,23 +2,29 @@ // // Copyright (C) 2010 // Fraunhofer Institute for Open Communication Systems (FOKUS) -// Competence Center NETwork research (NET), St. Augustin, GERMANY -// Thorsten Horstmann // -// This program is free software; you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation; either version 2 of the License, or -// (at your option) any later version. +// The contents of this file are subject to the Fraunhofer FOKUS Public License +// Version 1.0 (the "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// http://senf.berlios.de/license.html // -// This program 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 General Public License for more details. +// The Fraunhofer FOKUS Public License Version 1.0 is based on, +// but modifies the Mozilla Public License Version 1.1. +// See the full license text for the amendments. // -// You should have received a copy of the GNU General Public License -// along with this program; if not, write to the -// Free Software Foundation, Inc., -// 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. +// Software distributed under the License is distributed on an "AS IS" basis, +// WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License +// for the specific language governing rights and limitations under the License. +// +// The Original Code is Fraunhofer FOKUS code. +// +// The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V. +// (registered association), Hansastraße 27 c, 80686 Munich, Germany. +// All Rights Reserved. +// +// Contributor(s): +// Mathias Kretschmer +// Jens Moedeker /** \file \brief StatisticAccumulator public header */ @@ -29,18 +35,28 @@ // Custom includes #include #include +#include ///////////////////////////////hh.p//////////////////////////////////////// namespace senf { struct StatisticsData { + StatisticsData(float min_, float avg_, float max_, float stddev_, boost::uint32_t count_) + : min(min_), avg(avg_), max(max_), stddev(stddev_), count(count_) {}; + StatisticsData(StatisticsData const & other) + : min(other.min), avg(other.avg), max(other.max), stddev(other.stddev), count(other.count) {}; + StatisticsData() + : min(0.0), avg(0.0), max(0.0), stddev(0.0), count(0) {}; + float min; - float max; float avg; + float max; float stddev; boost::uint32_t count; }; + std::ostream & operator<<(std::ostream & os, StatisticsData const & _data); + /** \brief Accumulate measurement values The accumulator mainly do the prelimenary work for the senf::Statistic class. @@ -60,39 +76,39 @@ namespace senf { { public: StatisticAccumulator(); -// virtual ~StatisticAccumulator(); - - void clear(); - ///< Reset accumulated values. - /**< This member reset all values. */ - void accumulate(T value); - ///< Gather value to be accumulated. - /**< This method accumulate a value. - \param[in] value to be accumulated value*/ - - public: - T min() const; - ///< Returns current minimal value. - /**< This method returns the minimal value of the current accumulation.*/ - T max() const; - ///< Returns current maximal value. - /**< This method returns the maximal value of the current accumulation.*/ - float avg() const; - ///< Returns average value. - /**< This method returns the average value of the current accumulation.*/ - float last_avg() const; - ///< Returns former average value. - /**< This method returns the average value of the former accumulation period.*/ - float stddev() const; - ///< Returns standard deviation value. - /**< This method returns the standard deviation value of the current accumulation.*/ - boost::uint32_t count() const; - ///< Returns count of accumulated values. - /**< This method returns count of accumulated values of the current accumulation.*/ - void data( StatisticsData & data_) const; - ///< Returns the accumulated data as a tuple - /**< This method returns the accumulated information as a tuple.*/ + void clear(); ///< Reset accumulated values. + /**< This member reset all values. */ + void accumulate(T value); ///< Gather value to be accumulated. + /**< This method accumulates a value. + \param[in] value to be accumulated value */ + void setLastAvg(T value); ///< If no real data was collected, this method specifies the min/avg/max value to be returned. + /**< This method specifies the the min/avg/max value to + be returned if no real data was collected + \param[in] value to be returned */ + + T min() const; ///< Returns current minimal value. + /**< This method returns the minimal value of the + current accumulation. */ + T max() const; ///< Returns current maximal value. + /**< This method returns the maximal value of the + current accumulation.*/ + float avg() const; ///< Returns average value. + /**< This method returns the average value of the + current accumulation.*/ + float last_avg() const; ///< Returns former average value. + /**< This method returns the average value of the + former accumulation period.*/ + float stddev() const; ///< Returns standard deviation value. + /**< This method returns the standard deviation + value of the current accumulation.*/ + boost::uint32_t count() const; ///< Returns count of accumulated values. + /**< This method returns count of accumulated + values of the current accumulation.*/ + void data(StatisticsData & data_) const; + ///< Returns the accumulated data as a tuple + /**< This method returns the accumulated information + as a tuple.*/ private: T sum_squared_; T sum_; @@ -100,14 +116,8 @@ namespace senf { T max_; float last_avg_; boost::uint32_t count_; - - }; - - typedef StatisticAccumulator StatisticAccumulatorInt; - typedef StatisticAccumulator StatisticAccumulatorFloat; - } ///////////////////////////////hh.e//////////////////////////////////////// //#include "StatisticAccumulator.cci"