Clipper
hkl_operators.h
1
4//C Copyright (C) 2000-2006 Kevin Cowtan and University of York
5//L
6//L This library is free software and is distributed under the terms
7//L and conditions of version 2.1 of the GNU Lesser General Public
8//L Licence (LGPL) with the following additional clause:
9//L
10//L `You may also combine or link a "work that uses the Library" to
11//L produce a work containing portions of the Library, and distribute
12//L that work under terms of your choice, provided that you give
13//L prominent notice with each copy of the work that the specified
14//L version of the Library is used in it, and that you include or
15//L provide public access to the complete corresponding
16//L machine-readable source code for the Library including whatever
17//L changes were used in the work. (i.e. If you make changes to the
18//L Library you must distribute those, but you do not need to
19//L distribute source or object code to those portions of the work
20//L not covered by this licence.)'
21//L
22//L Note that this clause grants an additional right and does not impose
23//L any additional restriction, and so does not affect compatibility
24//L with the GNU General Public Licence (GPL). If you wish to negotiate
25//L other terms, please contact the maintainer.
26//L
27//L You can redistribute it and/or modify the library under the terms of
28//L the GNU Lesser General Public License as published by the Free Software
29//L Foundation; either version 2.1 of the License, or (at your option) any
30//L later version.
31//L
32//L This library is distributed in the hope that it will be useful, but
33//L WITHOUT ANY WARRANTY; without even the implied warranty of
34//L MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
35//L Lesser General Public License for more details.
36//L
37//L You should have received a copy of the CCP4 licence and/or GNU
38//L Lesser General Public License along with this library; if not, write
39//L to the CCP4 Secretary, Daresbury Laboratory, Warrington WA4 4AD, UK.
40//L The GNU Lesser General Public can also be obtained by writing to the
41//L Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
42//L MA 02111-1307 USA
43
44
45#ifndef CLIPPER_HKL_OPERATORS
46#define CLIPPER_HKL_OPERATORS
47
48#include "hkl_datatypes.h"
49
50
51namespace clipper
52{
53
54 namespace datatypes
55 {
56
57 // logical operators
58 HKL_data<Flag_bool> operator &( const HKL_data_base& d1, const HKL_data_base& d2 );
59 HKL_data<Flag_bool> operator |( const HKL_data_base& d1, const HKL_data_base& d2 );
60 HKL_data<Flag_bool> operator ^( const HKL_data_base& d1, const HKL_data_base& d2 );
61 HKL_data<Flag_bool> operator !( const HKL_data_base& d1 );
62
63 HKL_data<Flag_bool> operator ==( const HKL_data<Flag>& d1, const int& n );
64 HKL_data<Flag_bool> operator !=( const HKL_data<Flag>& d1, const int& n );
65 HKL_data<Flag_bool> operator >=( const HKL_data<Flag>& d1, const int& n );
66 HKL_data<Flag_bool> operator <=( const HKL_data<Flag>& d1, const int& n );
67 HKL_data<Flag_bool> operator >( const HKL_data<Flag>& d1, const int& n );
68 HKL_data<Flag_bool> operator <( const HKL_data<Flag>& d1, const int& n );
69
70 // individual data operators
71 template<class dtype> F_phi<dtype> operator +( const F_phi<dtype>& d1, const F_phi<dtype>& d2 );
72 template<class dtype> F_phi<dtype> operator -( const F_phi<dtype>& d1, const F_phi<dtype>& d2 );
73 template<class dtype> F_phi<dtype> operator -( const F_phi<dtype>& d1 );
74 template<class dtype> ABCD<dtype> operator +( const ABCD<dtype>& d1, const ABCD<dtype>& d2 );
75
76 // data list operators
77 template<class dtype> HKL_data<F_phi<dtype> > operator +( const HKL_data<F_phi<dtype> >& d1, const HKL_data<F_phi<dtype> >& d2 );
78 template<class dtype> HKL_data<F_phi<dtype> > operator -( const HKL_data<F_phi<dtype> >& d1, const HKL_data<F_phi<dtype> >& d2 );
79 template<class dtype> HKL_data<F_phi<dtype> > operator *( const HKL_data<F_phi<dtype> >& d1, const ftype& s );
80 template<class dtype> HKL_data<F_phi<dtype> > operator -( const HKL_data<F_phi<dtype> >& d1 );
81 template<class dtype> HKL_data<ABCD<dtype> > operator +( const HKL_data<ABCD<dtype> >& d1, const HKL_data<ABCD<dtype> >& d2 );
82 template<class dtype> HKL_data<F_phi<dtype> > operator *( const ftype& s, const HKL_data<F_phi<dtype> >& d1 ) { return d1*s; }
83
84 } // namespace datatypes
85
86
87
89
96 template<int N> class LogPhaseProb {
97 public:
99 LogPhaseProb( const HKL_class& hkl_class );
101 template<class dtype> void set_abcd( const datatypes::ABCD<dtype>& abcd );
103 template<class dtype> void get_abcd( datatypes::ABCD<dtype>& abcd ) const;
105 template<class dtype> void set_phi_fom( const datatypes::Phi_fom<dtype>& phifom );
107 template<class dtype> void get_phi_fom( datatypes::Phi_fom<dtype>& phifom ) const;
109 const ftype& operator[] ( const int& p ) const { return q[p]; }
111 ftype& operator[] ( const int& p ) { return q[p]; }
113 ftype phase( const int& p ) const
114 { return Util::twopi()*ftype(p*pinc+pmin)/ftype(N); }
115 int size() const { return q.size(); }
116 static int sampling() { return N; }
117 private:
118 int pmin, pinc;
119 std::vector<ftype> q;
120 };
121
122
123} // namespace clipper
124
125#endif
reflection class
Definition coords.h:87
Log phase probability distribution object.
Definition hkl_operators.h:96
void get_abcd(datatypes::ABCD< dtype > &abcd) const
get HL coeffs
Definition hkl_operators.cpp:264
void get_phi_fom(datatypes::Phi_fom< dtype > &phifom) const
get phi/fom
Definition hkl_operators.cpp:295
int size() const
return num. of phases
Definition hkl_operators.h:115
void set_phi_fom(const datatypes::Phi_fom< dtype > &phifom)
set phi/fom
Definition hkl_operators.cpp:282
void set_abcd(const datatypes::ABCD< dtype > &abcd)
set HL coeffs
Definition hkl_operators.cpp:249
static int sampling()
return phase sampling
Definition hkl_operators.h:116
ftype phase(const int &p) const
return phase associated with index
Definition hkl_operators.h:113
const ftype & operator[](const int &p) const
get log probability
Definition hkl_operators.h:109
static const ftype & twopi()
2 pi
Definition clipper_util.h:164
Reflection data type: Hendrickson-Lattman coeff.
Definition hkl_datatypes.h:364
Reflection data type: best phi + fom.
Definition hkl_datatypes.h:335
ftype64 ftype
ftype definition for floating point representation
Definition clipper_precision.h:58