clipper_stats.h

//C Copyright (C) 2000-2006 Kevin Cowtan and University of York
//L
//L  This library is free software and is distributed under the terms
//L  and conditions of version 2.1 of the GNU Lesser General Public
//L  Licence (LGPL) with the following additional clause:
//L
//L     `You may also combine or link a "work that uses the Library" to
//L     produce a work containing portions of the Library, and distribute
//L     that work under terms of your choice, provided that you give
//L     prominent notice with each copy of the work that the specified
//L     version of the Library is used in it, and that you include or
//L     provide public access to the complete corresponding
//L     machine-readable source code for the Library including whatever
//L     changes were used in the work. (i.e. If you make changes to the
//L     Library you must distribute those, but you do not need to
//L     distribute source or object code to those portions of the work
//L     not covered by this licence.)'
//L
//L  Note that this clause grants an additional right and does not impose
//L  any additional restriction, and so does not affect compatibility
//L  with the GNU General Public Licence (GPL). If you wish to negotiate
//L  other terms, please contact the maintainer.
//L
//L  You can redistribute it and/or modify the library under the terms of
//L  the GNU Lesser General Public License as published by the Free Software
//L  Foundation; either version 2.1 of the License, or (at your option) any
//L  later version.
//L
//L  This library is distributed in the hope that it will be useful, but
//L  WITHOUT ANY WARRANTY; without even the implied warranty of
//L  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
//L  Lesser General Public License for more details.
//L
//L  You should have received a copy of the CCP4 licence and/or GNU
//L  Lesser General Public License along with this library; if not, write
//L  to the CCP4 Secretary, Daresbury Laboratory, Warrington WA4 4AD, UK.
//L  The GNU Lesser General Public can also be obtained by writing to the
//L  Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
//L  MA 02111-1307 USA


#ifndef CLIPPER_STATS
#define CLIPPER_STATS


#include "clipper_types.h"


namespace clipper
{

  template<class T = ftype> class Range
  {
  public:
    inline Range() { lmin = 999999999; lmax = -999999999; }
    inline Range( const T& min, const T& max ) { lmin = min; lmax = max; }
    inline const T& min() const { return lmin; } 
    inline const T& max() const { return lmax; } 
    inline T range() const { return lmax-lmin; } 

    inline void include( const T& datum )
      { lmin = (datum<lmin)?datum:lmin; lmax = (datum>lmax)?datum:lmax; }
    inline bool contains( const T& datum ) const
      { return ( datum >= lmin && datum <= lmax ); }
    inline T truncate( const T& datum ) const
      { return Util::bound( lmin, datum, lmax ); }
  private:
    T lmin, lmax;
  };

  class Range_sampling : public Range<ftype>
  {
  public:
    inline Range_sampling() : n_(0) {}
    inline Range_sampling( const int& n ) : n_(n) {}
    inline Range_sampling( const Range<ftype>& range, const int& n ) :
      Range<ftype>( range ), n_(n) {}
    inline ftype indexf( const ftype& x ) const
      { return ftype(size())*(x-min())/range(); }
    inline ftype x( const ftype& i ) const
      { return range()*i/ftype(size())+min(); }
    inline int index( const ftype& x ) const { return Util::intf( indexf(x) ); }
    inline int index_bounded( const ftype& x ) const
      { return Util::bound( 0, Util::intf( indexf(x) ), size()-1 ); }
    inline ftype x( const int& i ) const     { return x( ftype(i)+0.5 ); }
    inline ftype x_min( const int& i ) const { return x( ftype(i)     ); }
    inline ftype x_max( const int& i ) const { return x( ftype(i)+1.0 ); }
    inline int size() const { return n_; }
  private:
    int n_;
  };


  class Histogram : public Range_sampling
  {
  public:
    Histogram() {}
    Histogram( const Range<ftype>& range, const int& n ) :
      Range_sampling( range, n ), data( n, 0.0 ) {}
    void accumulate( const ftype& x )
      { if ( contains(x) ) data[ index_bounded(x) ] += 1.0; }
    void accumulate( const ftype& x, const ftype& w )
      { if ( contains(x) ) data[ index_bounded(x) ] += w; }
    ftype sum() const;
    inline const ftype& y( const int& i ) const { return data[i]; }
    ftype y( const ftype& x ) const;
    const Histogram& operator += ( const Histogram& h );
    // inherited functions listed for documentation purposes
    //-- inline ftype x( const int& i ) const;
    //-- inline ftype x_min( const int& i ) const;
    //-- inline ftype x_max( const int& i ) const;
    //-- inline int size() const;
  private:
    std::vector<ftype> data;
  };



  class Generic_ordinal
  {
  public:
    Generic_ordinal() {}
    Generic_ordinal( const Range<ftype>& range, const int& n )
      { init( range, n ); }
    void init( const Range<ftype>& range, const int num_ranges = 1000 );
    void init( const std::vector<ftype>& values, const int num_ranges = 1000 );
    ftype ordinal( const ftype& value ) const;

    void accumulate( const ftype& value );
    void accumulate( const ftype& value, const ftype& weight );
    void prep_ordinal();
    void invert();

    void init( const int num_ranges = 1000 );
    void add_pass_1( const ftype& value );
    void add_pass_2( const ftype& value );
  protected:
    ftype nranges;            
    Range<ftype> range_;      
    std::vector<ftype> hist;  
  };



} // namespace clipper

#endif