/usr/include/ns3.27/ns3/average.h is in libns3-dev 3.27+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2009 IITP RAS
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation;
*
* 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.
*
* 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
*
* Authors: Pavel Boyko <boyko@iitp.ru>
* Corrections and extensions: Timo Bingmann <tbns@idlebox.net>
*/
#ifndef AVERAGE_H
#define AVERAGE_H
#include <cmath>
#include <ostream>
#include <limits>
#include <stdint.h>
#include "ns3/basic-data-calculators.h"
namespace ns3 {
/**
* \ingroup stats
*
* Simple average, min, max and std. deviation calculator
*
*/
template <typename T = double>
class Average
{
public:
Average ()
: m_size (0), m_min (std::numeric_limits<T>::max ()), m_max (0)
{
}
/// Add new sample
void Update (T const & x)
{
// Give the variance calculator the next value.
m_varianceCalculator.Update (x);
m_min = std::min (x, m_min);
m_max = std::max (x, m_max);
m_size++;
}
/// Reset statistics
void Reset ()
{
m_varianceCalculator.Reset ();
m_size = 0;
m_min = std::numeric_limits<T>::max ();
m_max = 0;
}
// Sample statistics
/// Sample size
uint32_t Count () const { return m_size; }
/// Minimum
T Min () const { return m_min; }
/// Maximum
T Max () const { return m_max; }
/// Sample average
double Avg () const { return m_varianceCalculator.getMean ();}
/// Estimate of mean, alias to Avg
double Mean () const { return Avg (); }
/// Unbiased estimate of variance
double Var () const { return m_varianceCalculator.getVariance ();}
/// Standard deviation
double Stddev () const { return std::sqrt (Var ()); }
/**
* \name Error of the mean estimates
*
* @{
*/
/**
* \brief Margin of error of the mean for 90% confidence level
*
* Note that estimates are valid for
* - uncorrelated measurements,
* - normal distribution and
* - large enough sample size.
*
* \returns Margin of error of the mean for 90% confidence level
*/
double Error90 () const { return 1.645 * std::sqrt (Var () / Count ()); }
/**
* \brief Margin of error of the mean for 95% confidence level
*
* Note that estimates are valid for
* - uncorrelated measurements,
* - normal distribution and
* - large enough sample size.
*
* \returns Margin of error of the mean for 95% confidence level
*/
double Error95 () const { return 1.960 * std::sqrt (Var () / Count ()); }
/**
* \brief Margin of error of the mean for 99% confidence level
*
* Note that estimates are valid for
* - uncorrelated measurements,
* - normal distribution and
* - large enough sample size.
*
* \returns Margin of error of the mean for 99% confidence level
*
*/
double Error99 () const { return 2.576 * std::sqrt (Var () / Count ()); }
/**@}*/
private:
uint32_t m_size; //!< Number of sampled data.
T m_min; //!< Minimum value observed.
T m_max; //!< Maximum value observed.
MinMaxAvgTotalCalculator<double> m_varianceCalculator; //!< Variance calculator.
};
/// Print avg (err) [min, max]
template <typename T>
std::ostream & operator<< (std::ostream & os, Average<T> const & x)
{
if (x.Count () != 0)
os << x.Avg () << " (" << x.Stddev () << ") [" << x.Min () << ", " << x.Max () << "]";
else
os << "NA"; // not available
return os;
}
}
#endif /* AVERAGE_H */
|