function_object_bases.h

Go to the documentation of this file.

//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_FUNCTION_OBJECT_BASES
#define CLIPPER_FUNCTION_OBJECT_BASES


#include "../core/hkl_datatypes.h"
#include "../core/xmap.h"
#include "../core/nxmap_operator.h"


namespace clipper {


  template<class T> class SFcalc_base {
  public:

    virtual bool operator() ( HKL_data<datatypes::F_phi<T> >& fphidata, const Atom_list& atoms ) const = 0;
    virtual ~SFcalc_base() {}  
  };



  template<class T> class EDcalc_base {
  public:

    virtual bool operator() ( Xmap<T>& xmap, const Atom_list& atoms ) const = 0;
    virtual bool operator() ( NXmap<T>& nxmap, const Atom_list& atoms ) const = 0;
    virtual ~EDcalc_base() {}  
  };



  template<class T> class SFcalc_obs_base {
  public:

    virtual bool operator() ( HKL_data<datatypes::F_phi<T> >& fphi, const HKL_data<datatypes::F_sigF<T> >& fsig, const Atom_list& atoms ) = 0;
    virtual ~SFcalc_obs_base() {}  
  };



  template<class T> class SFweight_base {
  public:
    enum TYPE { NONE, SIGMAA, SCALE, BOTH };

    virtual bool operator() ( HKL_data<datatypes::F_phi<T> >& fb, HKL_data<datatypes::F_phi<T> >& fd, HKL_data<datatypes::Phi_fom<T> >& phiw, const HKL_data<datatypes::F_sigF<T> >& fo, const HKL_data<datatypes::F_phi<T> >& fc, const HKL_data<datatypes::Flag>& usage ) = 0;
    virtual ~SFweight_base() {}  
  };



  template<class T> class SFscale_base {
  public:

    virtual bool operator() ( HKL_data<datatypes::F_sigF<T> >& fo, const HKL_data<datatypes::F_phi<T> >& fc ) = 0;

    virtual bool operator() ( HKL_data<datatypes::F_phi<T> >& fc, const HKL_data<datatypes::F_sigF<T> >& fo ) = 0;

    virtual bool operator() ( HKL_data<datatypes::F_sigF<T> >& fo ) = 0;
    virtual ~SFscale_base() {}  
  };



  template<class T> class MapFilter_base {
  public:

    virtual bool operator() ( Xmap<T>& result, const Xmap<T>& xmap ) const = 0;
    virtual ~MapFilter_base() {}  
  };



  template<class T> class Convolution_search_base {
  public:
    virtual bool operator() ( Xmap<T>& result, const NXmap<T>& srchval, const NX_operator& nxop ) const = 0;
    virtual ~Convolution_search_base() {}  
  };


  template<class T> class FFFear_base {
  public:
    virtual bool operator() ( Xmap<T>& result, const NXmap<T>& srchval, const NXmap<T>& srchwgt, const NX_operator& nxop ) const = 0;
    virtual ~FFFear_base() {}  
  };


  template<class T1, class T2> class Skeleton_base {
  public:

    virtual bool operator() ( Xmap<T1>& xskl, const Xmap<T2>& xmap ) const = 0;
    virtual ~Skeleton_base() {}  
  };


  template<class T> class OriginMatch_base {
  public:

    virtual bool operator() ( bool& invert, Coord_frac& shift, const HKL_data<datatypes::F_phi<T> >& fphi1, const HKL_data<datatypes::F_phi<T> >& fphi2 ) const = 0;
    virtual ~OriginMatch_base() {}  
  };

} // namespace clipper

#endif