MOAB: Mesh Oriented datABase  (version 5.3.0)
SimpleStats.hpp
Go to the documentation of this file.
00001 /* *****************************************************************
00002     MESQUITE -- The Mesh Quality Improvement Toolkit
00003 
00004     Copyright 2010 Sandia National Laboratories.  Developed at the
00005     University of Wisconsin--Madison under SNL contract number
00006     624796.  The U.S. Government and the University of Wisconsin
00007     retain certain rights to this software.
00008 
00009     This library is free software; you can redistribute it and/or
00010     modify it under the terms of the GNU Lesser General Public
00011     License as published by the Free Software Foundation; either
00012     version 2.1 of the License, or (at your option) any later version.
00013 
00014     This library is distributed in the hope that it will be useful,
00015     but WITHOUT ANY WARRANTY; without even the implied warranty of
00016     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00017     Lesser General Public License for more details.
00018 
00019     You should have received a copy of the GNU Lesser General Public License
00020     (lgpl.txt) along with this library; if not, write to the Free Software
00021     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00022 
00023     (2010) kraftche@cae.wisc.edu
00024 
00025   ***************************************************************** */
00026 
00027 /** \file SimpleStats.hpp
00028  *  \brief
00029  *  \author Jason Kraftcheck
00030  */
00031 
00032 #ifndef MSQ_SIMPLE_STATS_HPP
00033 #define MSQ_SIMPLE_STATS_HPP
00034 
00035 #include "Mesquite.hpp"
00036 
00037 namespace MBMesquite
00038 {
00039 
00040 /**\brief Accumulate various statistics for a list of discrete values */
00041 class SimpleStats
00042 {
00043   private:
00044     double valueSum, valueSqrSum, valueMin, valueMax;
00045     unsigned long valueCount;
00046 
00047   public:
00048     SimpleStats();
00049 
00050     /**\brief minimum value */
00051     double minimum() const
00052     {
00053         return valueMin;
00054     }
00055     /**\brief maximum value */
00056     double maximum() const
00057     {
00058         return valueMax;
00059     }
00060     /**\brief algebraic mean of values */
00061     double average() const
00062     {
00063         return valueSum / valueCount;
00064     }
00065     /**\brief root mean squared of values */
00066     double rms() const
00067     {
00068         return sqrt( valueSqrSum / valueCount );
00069     }
00070     /**\brief variance of values */
00071     double variance() const
00072     {
00073         return valueSqrSum / valueCount - average() * average();
00074     }
00075     /**\brief standard deviation of values */
00076     double standard_deviation() const
00077     {
00078         return sqrt( fabs( variance() ) );
00079     }
00080 
00081     /**\brief incorporate another value into statistics */
00082     void add_value( double value )
00083     {
00084         valueSum += value;
00085         valueSqrSum += value * value;
00086         if( value < valueMin ) valueMin = value;
00087         if( value > valueMax ) valueMax = value;
00088         ++valueCount;
00089     }
00090 
00091     /**\brief incorporate another value into statistics */
00092     void add_squared( double value_squared )
00093     {
00094         double value = sqrt( value_squared );
00095         valueSum += value;
00096         valueSqrSum += value_squared;
00097         if( value < valueMin ) valueMin = value;
00098         if( value > valueMax ) valueMax = value;
00099         ++valueCount;
00100     }
00101 
00102     void clear();
00103 
00104     bool empty()
00105     {
00106         return 0ul == valueCount;
00107     }
00108 };
00109 
00110 }  // namespace MBMesquite
00111 
00112 #endif
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines