source: trunk/yat/statistics/VectorFunction.h @ 827

#ifndef _theplu_yat_statistics_vector_function_
#define _theplu_yat_statistics_vector_function_

// $Id: VectorFunction.h 827 2007-03-19 18:52:36Z peter $

/*
  Copyright (C) The authors contributing to this file.

  This file is part of the yat library, http://lev.thep.lu.se/trac/yat

  The yat library 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 yat 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
  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.
*/

#include <vector>

namespace theplu {
namespace yat {
namespace statistics {

  ///
  /// \brief Interface Class for vector functors.
  ///
  struct VectorFunction 
  {
    virtual ~VectorFunction();
    virtual double operator()(const std::vector<double>&) const=0;
  };


  struct Max : public VectorFunction
  {
    ///
    /// \return Largest element
    ///
    double operator()(const std::vector<double>&) const;
  };


  struct Median : public VectorFunction 
  {
    ///
    /// \return Median
    ///
    double operator()(const std::vector<double>&) const;
  };


  struct Mean : public VectorFunction
  {
    ///
    /// \return Mean
    ///
    double operator()(const std::vector<double>&) const;
  };


  struct Min : public VectorFunction 
  {
    ///
    /// \return Smallest element
    ///
    double operator()(const std::vector<double>&) const;
  };


  class Nth_Element : public VectorFunction
  {
  public:
    ///
    /// \param N equal to 1 gives identical object as Min (but less
    /// efficient)
    ///
    Nth_Element(u_int N);

    ///
    /// \return Nth smallest element
    ///
    double operator()(const std::vector<double>&) const;

  private:
    u_int N_;
  };

}}} // of namespace statistics, yat, and theplu

#endif