ckstatistics.h

Go to the documentation of this file.

/* *******************************************************************
 * Illinois Open Source License                                      *
 *                                                                   *
 * University of Illinois/NCSA                                       * 
 * Open Source License                                               *
 *                                                                   *
 * Copyright@2008, University of Illinois.  All rights reserved.     *
 *                                                                   *
 *  Developed by:                                                    *
 *                                                                   *
 *     Center for Simulation of Advanced Rockets                     *
 *                                                                   *
 *     University of Illinois                                        *
 *                                                                   *
 *     www.csar.uiuc.edu                                             *
 *                                                                   *
 * Permission is hereby granted, free of charge, to any person       *
 * obtaining a copy of this software and associated documentation    *
 * files (the "Software"), to deal with the Software without         *
 * restriction, including without limitation the rights to use,      *
 * copy, modify, merge, publish, distribute, sublicense, and/or      *
 * sell copies of the Software, and to permit persons to whom the    *
 * Software is furnished to do so, subject to the following          *
 * conditions:                                                       *
 *                                                                   *
 *                                                                   *
 * @ Redistributions of source code must retain the above copyright  * 
 *   notice, this list of conditions and the following disclaimers.  *
 *                                                                   * 
 * @ Redistributions in binary form must reproduce the above         *
 *   copyright notice, this list of conditions and the following     *
 *   disclaimers in the documentation and/or other materials         *
 *   provided with the distribution.                                 *
 *                                                                   *
 * @ Neither the names of the Center for Simulation of Advanced      *
 *   Rockets, the University of Illinois, nor the names of its       *
 *   contributors may be used to endorse or promote products derived * 
 *   from this Software without specific prior written permission.   *
 *                                                                   *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,   *
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES   *
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND          *
 * NONINFRINGEMENT.  IN NO EVENT SHALL THE CONTRIBUTORS OR           *
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER       * 
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,   *
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE    *
 * USE OR OTHER DEALINGS WITH THE SOFTWARE.                          *
 *********************************************************************
 * Please acknowledge The University of Illinois Center for          *
 * Simulation of Advanced Rockets in works and publications          *
 * resulting from this software or its derivatives.                  *
 *********************************************************************/
/*
(Copied out of) Orion's Standard Library
written by 
Orion Sky Lawlor, olawlor@acm.org, 11/25/2002
*/
#ifndef __UIUC_OSL_STATISTICS_H
#define __UIUC_OSL_STATISTICS_H

#include "math.h" //for sqrt
#include "stdio.h" //for fprintf

template<class real,class ret>
class CkSampleT {
        real lo,hi; //smallest and largest values
        ret sum; //sum of values
        ret sq; //sum of squares of values
        int n; //number of values
public:
        CkSampleT(void) {
                lo=(real)1.0e20; hi=(real)-1.0e20;
                sum=sq=(ret)0;
                n=0;
        }
        inline void add(real r) {
                if (r<lo) lo=r;
                if (r>hi) hi=r;
                sum+=(ret)r;
                sq+=(ret)(r*r);
                n++;
        }
        inline void operator+=(real r) { add(r); }
        
        ret getMean(void) const {
                return sum/n;
        }
        ret getVariance(void) const {
                return (sq-sum*sum/n)/(n-1);
        }
        ret getStddev(void) const {
                return (ret)sqrt(getVariance());
        }
        real getMin(void) const {return lo;}
        real getMax(void) const {return hi;}
        int getCount(void) const {return n;}
        
        void print(FILE *dest) {
                fprintf(dest,"ave= %g  stddev= %g  min= %g  max= %g  n= %d\n",
                        (double)getMean(), (double)getStddev(), (double)getMin(), (double)getMax(), (int)getCount());
        }

        void printMinAveMax(FILE *dest) {
                fprintf(dest,"min= %g  ave= %g  max= %g \n",
                        (double)getMin(), (double)getMean(), (double)getMax());
        }

        void print(void) {print(stdout);}
        
};
typedef CkSampleT<double,double> CkSample;

#endif