Issue 4961/7: Remove complex{conjugate,divide,exp}, Offset::arg

[lilypond.git] / flower / include / offset.hh

diff --git a/flower/include/offset.hh b/flower/include/offset.hh
index 428a8fa6b3ca0a9169068b81019f8bed12800c27..a8c5987801069b01790b545b4a12db4c70923bfc 100644 (file)
--- a/flower/include/offset.hh
+++ b/flower/include/offset.hh
@@ -1,120 +1,179 @@
 /*
-  offset.hh -- part of GNU LilyPond
+  This file is part of LilyPond, the GNU music typesetter.
 
-  (c) 1996,97 Han-Wen Nienhuys
+  Copyright (C) 1996--2015 Han-Wen Nienhuys
+
+  LilyPond 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.
+
+  LilyPond 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
+  along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 #ifndef OFFSET_HH
 #define OFFSET_HH
 
+#include "axis.hh"
+#include "std-string.hh"
 #include "real.hh"
-#include "axes.hh"
 
-/** 2d vector
-    should change to Complex
+/*
+  This is a mixture a 2D vector. Sometimes it can
+  also be convenient to think of 2D vectors as complex numbers
+  (ie. x + i y). The naming of some methods reflects that.
 */
-struct Offset {
+class Offset
+{
 public:
-
   Real coordinate_a_[NO_AXES];
-    
-  Real &y() { return coordinate_a_[Y_AXIS]; }
-  Real &x() { return coordinate_a_[X_AXIS]; }
-  Real y() const { return coordinate_a_[Y_AXIS]; }
-  Real x() const { return coordinate_a_[X_AXIS]; }
-    
-  Real &operator[](Axis i) {
+
+  Real &operator [] (Axis i)
+  {
     return coordinate_a_[i];
   }
-  Real operator[](Axis i) const{
+
+  Real operator [] (Axis i) const
+  {
     return coordinate_a_[i];
   }
-    
-  Offset& operator+=(Offset o) {
-    x()+=o.x ();
-    y()+=o.y ();
+
+  Offset &operator += (Offset o)
+  {
+    (*this)[X_AXIS] += o[X_AXIS];
+    (*this)[Y_AXIS] += o[Y_AXIS];
     return *this;
   }
-  Offset operator - () const {
+
+  Offset operator - () const
+  {
     Offset o = *this;
-    o.x () = - o.x ();
-    o.y () = - o.y ();
+
+    o[X_AXIS] = -o[X_AXIS];
+    o[Y_AXIS] = -o[Y_AXIS];
     return o;
   }
-  Offset& operator-=(Offset o) {
-    x()-=o.x ();
-    y()-=o.y ();
+
+  Offset &operator -= (Offset o)
+  {
+    (*this)[X_AXIS] -= o[X_AXIS];
+    (*this)[Y_AXIS] -= o[Y_AXIS];
+
     return *this;
   }
-  
-  Offset &scale (Offset o) {
-    x()*=o.x ();
-    y()*=o.y ();
+
+  Offset &scale (Offset o)
+  {
+    (*this)[X_AXIS] *= o[X_AXIS];
+    (*this)[Y_AXIS] *= o[Y_AXIS];
+
     return *this;
   }
-  Offset &operator *=(Real a) {
-    y() *= a;
-    x() *= a;
+
+  Offset &operator /= (Real a)
+  {
+    (*this) *= 1 / a;
     return *this;
   }
-      
-  Offset (Real ix , Real iy) {
-    x()=ix;
-    y()=iy;
+
+  Offset &operator *= (Real a)
+  {
+    (*this)[X_AXIS] *= a;
+    (*this)[Y_AXIS] *= a;
+
+    return *this;
   }
-  Offset() {
-    x()=0.0;
-    y()=0.0;
+
+  Offset (Real ix, Real iy)
+  {
+    coordinate_a_[X_AXIS] = ix;
+    coordinate_a_[Y_AXIS] = iy;
   }
-#ifndef STANDALONE
-  String str () const;
-#endif
 
-  void mirror (Axis);
-  Real  arg () const;
+  Offset ()
+  {
+    coordinate_a_[X_AXIS] = coordinate_a_[Y_AXIS] = 0.0;
+  }
+
+  string to_string () const;
+
+  Offset &mirror (Axis a)
+  {
+    coordinate_a_[a] = -coordinate_a_[a];
+    return *this;
+  }
+  Offset direction () const;
+  Offset swapped () const;
+
+  Real angle_degrees () const;
   Real length () const;
+  bool is_sane () const;
+  Offset operator *= (Offset z2);
 };
 
+#include "arithmetic-operator.hh"
+IMPLEMENT_ARITHMETIC_OPERATOR (Offset, +);
+IMPLEMENT_ARITHMETIC_OPERATOR (Offset, -);
+IMPLEMENT_ARITHMETIC_OPERATOR (Offset, *);
+
 Offset complex_multiply (Offset, Offset);
-Offset complex_exp (Offset);
+Offset offset_directed (Real);
 
+inline Offset
+Offset::operator *= (Offset z2)
+{
+  *this = complex_multiply (*this, z2);
+  return *this;
+}
 
 inline Offset
-operator* (Offset z1, Offset z2)
+operator * (Real o1, Offset o2)
 {
-  return complex_multiply (z1,z2);
+  o2 *= o1;
+  return o2;
 }
 
 inline Offset
-operator+ (Offset o1, Offset const& o2)
+operator / (Offset o1, Real a)
 {
-  o1 += o2;
+  o1 /= a;
   return o1;
 }
 
 inline Offset
-operator- (Offset o1, Offset const& o2)
+operator * (Offset o1, Real o2)
 {
-  o1 -= o2;
+  o1 *= o2;
   return o1;
 }
 
-
 inline Offset
-operator* (Real o1, Offset o2)
+mirror (Offset o, Axis a)
 {
-  o2 *= o1;
-  return o2;
+  o.mirror (a);
+  return o;
 }
 
-inline Offset
-operator* (Offset o1, Real o2)
+inline
+Real
+dot_product (Offset o1, Offset o2)
 {
-  o1 *= o2;
-  return o1;
+  return o1[X_AXIS] * o2[X_AXIS] + o1[Y_AXIS] * o2[Y_AXIS];
 }
 
+inline
+Real
+cross_product (Offset o1, Offset o2)
+{
+  return o1[X_AXIS] * o2[Y_AXIS] - o1[Y_AXIS] * o2[X_AXIS];
+}
 
-#endif // OFFSET_HH
 
+#endif /* OFFSET_HH */