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

#ifndef _theplu_yat_statistics_vector_function_
#define _theplu_yat_statistics_vector_function_

// $Id: VectorFunction.h 2986 2013-02-18 08:07:44Z peter $

/*
  Copyright (C) 2007, 2008 Jari Häkkinen, Peter Johansson
  Copyright (C) 2013 Jari Häkkinen

  This file is part of the yat library, http://dev.thep.lu.se/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 3 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 yat. If not, see <http://www.gnu.org/licenses/>.
*/

#include <cstddef>
#include <vector>

namespace theplu {
namespace yat {
namespace statistics {

  ///
  /// \brief Interface Class for vector functors.
  ///
  struct VectorFunction 
  {
    /**
       \brief Destructor
     */
    virtual ~VectorFunction();

    /**
       \brief abstract interface
     */
    virtual double operator()(const std::vector<double>&) const=0;
  };


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


  ///
  /// @brief Median element
  ///
  struct Median : public VectorFunction 
  {
    ///
    /// \see statistics::median(std::vector<double>, bool)
    ///
    /// \return Median
    ///
    double operator()(const std::vector<double>&) const;
  };

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


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

  /**
     Functor that picks Nth smalles element in a vector.
   */
  class Nth_Element : public VectorFunction
  {
  public:
    ///
    /// \param N equal to 1 gives identical object as Min (but less
    /// efficient)
    ///
    Nth_Element(size_t N);

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

  private:
    size_t N_;
  };

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

#endif