Correlations.hpp

Go to the documentation of this file.

/*

Copyright (C) 2003-2009 Kevin Thornton, krthornt[]@[]uci.edu

Remove the brackets to email me.

This file is part of libsequence.

libsequence 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.

libsequence 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
long with libsequence.  If not, see <http://www.gnu.org/licenses/>.

*/

#ifndef __CORRELATIONS_H__
#define __CORRELATIONS_H__

#include <iterator>
#include <functional>
#include <Sequence/ensureFloating.hpp>
#include <Sequence/Portability/random_shuffle.hpp>
namespace Sequence
{
  struct ProductMoment
  {
    template<typename iter1, typename iter2>
    typename ensureFloating<typename std::iterator_traits<iter1>::value_type,
                            typename std::iterator_traits<iter2>::value_type>::type
                            operator()(iter1 beg_x,iter1 end_x, iter2 beg_y) const;
  };

  struct SpearmansRank
  {
    template<typename iter1,typename iter2>
    typename ensureFloating<typename std::iterator_traits<iter1>::value_type,
                            typename std::iterator_traits<iter2>::value_type>::type
                            operator()(iter1 beg_x,iter1 end_x, iter2 beg_y) const;
  };

  template<typename iter1, typename iter2,  
           typename correlation_type,
           typename comparison_function,
           typename UniformIntGenerator>
  typename ensureFloating<typename std::iterator_traits<iter1>::value_type,
                          typename std::iterator_traits<iter2>::value_type>::type
  PermuteCorrelation(iter1 beg_x, iter1 end_x, iter2 beg_y,
                     const correlation_type &  c,
                     const comparison_function & comp,
                     UniformIntGenerator & rand,
                     const unsigned & NPERM=10000);

  template<typename iter1, typename iter2,  
           typename correlation_type,
           typename comparison_function,
           typename UniformIntGenerator>
  typename ensureFloating<typename std::iterator_traits<iter1>::value_type,
                          typename std::iterator_traits<iter2>::value_type>::type
  PermuteCorrelation(iter1 beg_x, iter1 end_x, iter2 beg_y,
                     const correlation_type &  c,
                     const comparison_function & comp,
                     const UniformIntGenerator & rand,
                     const unsigned & NPERM=10000);

}//namespace Sequence
#include <Sequence/bits/Correlations.tcc>
#endif

---