statistics.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2018 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner

// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.

// This library 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 library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA



#ifndef LIBMESH_STATISTICS_H
#define LIBMESH_STATISTICS_H

// Local includes
#include "libmesh/libmesh_common.h"
#include "libmesh/id_types.h"

// C++ includes
#include <vector>
#include <cstdlib> // *must* precede <cmath> for proper std:abs() on PGI, Sun Studio CC
#include <cmath>

namespace libMesh
{

template <typename T>
class StatisticsVector : public std::vector<T>
{
public:

  explicit
  StatisticsVector(dof_id_type i=0) : std::vector<T> (i) {}

  StatisticsVector(dof_id_type i, T val) : std::vector<T> (i,val) {}

  virtual ~StatisticsVector () {}


  virtual Real l2_norm() const;

  virtual T minimum() const;

  virtual T maximum() const;

  virtual Real mean() const;

  virtual Real median();

  virtual Real median() const;

  virtual Real variance() const
  { return this->variance(this->mean()); }

  virtual Real variance(const Real known_mean) const;

  virtual Real stddev() const
  { return std::sqrt(this->variance()); }

  virtual Real stddev(const Real known_mean) const
  { return std::sqrt(this->variance(known_mean)); }

  void normalize();

  virtual void histogram (std::vector<dof_id_type> & bin_members,
                          unsigned int n_bins=10);

  void plot_histogram(const processor_id_type my_procid,
                      const std::string & filename,
                      unsigned int n_bins);

  virtual void histogram (std::vector<dof_id_type> & bin_members,
                          unsigned int n_bins=10) const;

  virtual std::vector<dof_id_type> cut_below(Real cut) const;

  virtual std::vector<dof_id_type> cut_above(Real cut) const;
};

} // namespace libMesh

#endif // LIBMESH_STATISTICS_H