Spearman.h

#ifndef _theplu_yat_statistics_spearman_
#define _theplu_yat_statistics_spearman_

// $Id: Spearman.h 2654 2011-11-15 19:36:37Z peter $

/*
  Copyright (C) 2011 Peter Johansson

  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>

namespace theplu {
namespace yat {
namespace statistics {

  class Spearman
  {
  public:
    Spearman(void);

    virtual ~Spearman(void);

    void add(double x, double y);

    size_t n(void) const;

    double p_left(bool exact=false) const;

    double p_right(bool exact=false) const;

    double p_value(bool exact=false) const;

    void reset(void);

    double score(void) const;

  private:
    class Pimpl;
    Pimpl* pimpl_;

    // Copy not allowed
    Spearman(const Spearman& other);
    Spearman& operator=(const Spearman&);
  };

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