stage/include/ost/img/phase.hh
Go to the documentation of this file.00001 //------------------------------------------------------------------------------ 00002 // This file is part of the OpenStructure project <www.openstructure.org> 00003 // 00004 // Copyright (C) 2008-2011 by the OpenStructure authors 00005 // Copyright (C) 2003-2010 by the IPLT authors 00006 // 00007 // This library is free software; you can redistribute it and/or modify it under 00008 // the terms of the GNU Lesser General Public License as published by the Free 00009 // Software Foundation; either version 3.0 of the License, or (at your option) 00010 // any later version. 00011 // This library is distributed in the hope that it will be useful, but WITHOUT 00012 // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 00013 // FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more 00014 // details. 00015 // 00016 // You should have received a copy of the GNU Lesser General Public License 00017 // along with this library; if not, write to the Free Software Foundation, Inc., 00018 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 00019 //------------------------------------------------------------------------------ 00020 00021 /* 00022 author: Andreas Schenk 00023 */ 00024 00025 00026 #ifndef PHASE_HH_ 00027 #define PHASE_HH_ 00028 00029 #include <boost/operators.hpp> 00030 #include <iostream> 00031 #include <ost/img/module_config.hh> 00032 #include <ost/img/data_types.hh> 00033 00034 namespace ost { namespace img { 00041 class DLLEXPORT_OST_IMG_BASE Phase: 00042 private boost::equality_comparable<Phase>, 00043 private boost::additive<Phase>, 00044 private boost::multiplicative<Phase, Real> 00045 { 00046 public: 00047 Phase():angle_(0){}; 00048 Phase(Real angle); 00049 Phase(Complex comp); 00050 operator Real() const; 00052 const Phase operator+=(const Phase& rhs); 00054 const Phase operator-=(const Phase& rhs); 00056 Phase operator-() const; 00058 const Phase operator*=(Real d); 00060 const Phase operator/=(Real d); 00061 protected: 00062 Real reduce(Real in); 00063 Real angle_; 00064 }; 00065 00066 DLLEXPORT_OST_IMG_BASE std::ostream& operator<<(std::ostream&,const Phase a); 00067 00068 }}//ns 00069 00070 #endif /*PHASE_HH_*/ 00071 00085 00086
