Move QgsVector methods to header to allow better compiler optimisation,

nyalldawson · nyalldawson · commit 6a570f33ebac · 2020-10-16T12:18:33.000+10:00
also hold Python GIL when calling them
diff --git a/python/core/auto_generated/qgsvector.sip.in b/python/core/auto_generated/qgsvector.sip.in
@@ -33,30 +33,30 @@ Constructor for QgsVector taking x and y component values.
 :param y: y-component
 %End
 
-    QgsVector operator-() const;
+    QgsVector operator-() const /HoldGIL/;
 
-    QgsVector operator*( double scalar ) const;
+    QgsVector operator*( double scalar ) const /HoldGIL/;
 
-    QgsVector operator/( double scalar ) const;
+    QgsVector operator/( double scalar ) const /HoldGIL/;
 
-    double operator*( QgsVector v ) const;
+    double operator*( QgsVector v ) const /HoldGIL/;
 
-    QgsVector operator+( QgsVector other ) const;
+    QgsVector operator+( QgsVector other ) const /HoldGIL/;
 
-    QgsVector &operator+=( QgsVector other );
+    QgsVector &operator+=( QgsVector other ) /HoldGIL/;
 
-    QgsVector operator-( QgsVector other ) const;
+    QgsVector operator-( QgsVector other ) const /HoldGIL/;
 
-    QgsVector &operator-=( QgsVector other );
+    QgsVector &operator-=( QgsVector other ) /HoldGIL/;
 
-    double length() const;
+    double length() const /HoldGIL/;
 %Docstring
 Returns the length of the vector.
 
 .. seealso:: :py:func:`lengthSquared`
 %End
 
-    double lengthSquared() const;
+    double lengthSquared() const /HoldGIL/;
 %Docstring
 Returns the length of the vector.
 
@@ -65,62 +65,62 @@ Returns the length of the vector.
 .. versionadded:: 3.2
 %End
 
-    double x() const;
+    double x() const /HoldGIL/;
 %Docstring
 Returns the vector's x-component.
 
 .. seealso:: y
 %End
 
-    double y() const;
+    double y() const /HoldGIL/;
 %Docstring
 Returns the vector's y-component.
 
 .. seealso:: x
 %End
 
-    QgsVector perpVector() const;
+    QgsVector perpVector() const /HoldGIL/;
 %Docstring
 Returns the perpendicular vector to this vector (rotated 90 degrees counter-clockwise)
 %End
 
-    double angle() const;
+    double angle() const /HoldGIL/;
 %Docstring
 Returns the angle of the vector in radians.
 %End
 
-    double angle( QgsVector v ) const;
+    double angle( QgsVector v ) const /HoldGIL/;
 %Docstring
 Returns the angle between this vector and another vector in radians.
 %End
 
-    double crossProduct( QgsVector v ) const;
+    double crossProduct( QgsVector v ) const /HoldGIL/;
 %Docstring
 Returns the 2D cross product of this vector and another vector ``v``. (This is sometimes
 referred to as a "perpendicular dot product", and equals x1 * y1 - y1 * x2).
 
 .. versionadded:: 3.2
 %End
 
-    QgsVector rotateBy( double rot ) const;
+    QgsVector rotateBy( double rot ) const /HoldGIL/;
 %Docstring
 Rotates the vector by a specified angle.
 
 :param rot: angle in radians
 %End
 
-    QgsVector normalized() const;
+    QgsVector normalized() const throw( QgsException );
 %Docstring
 Returns the vector's normalized (or "unit") vector (ie same angle but length of 1.0).
-Will throw a QgsException if called on a vector with length of 0.
+
+:raises QgsException: if called on a vector with length of 0.
 %End
 
-    bool operator==( QgsVector other ) const;
+    bool operator==( QgsVector other ) const /HoldGIL/;
 
     bool operator!=( QgsVector other ) const;
 
-
-    QString toString( int precision = 17 ) const;
+    QString toString( int precision = 17 ) const /HoldGIL/;
 %Docstring
 Returns a string representation of the vector.
 Members will be truncated to the specified ``precision``.
diff --git a/src/core/qgsvector.cpp b/src/core/qgsvector.cpp
@@ -18,92 +18,6 @@
 #include "qgis.h"
 #include "qgsexception.h"
 
-QgsVector::QgsVector( double x, double y )
-  : mX( x )
-  , mY( y )
-{
-}
-
-QgsVector QgsVector::operator-() const
-{
-  return QgsVector( -mX, -mY );
-}
-
-QgsVector QgsVector::operator*( double scalar ) const
-{
-  return QgsVector( mX * scalar, mY * scalar );
-}
-
-QgsVector QgsVector::operator/( double scalar ) const
-{
-  return *this * ( 1.0 / scalar );
-}
-
-double QgsVector::operator*( QgsVector v ) const
-{
-  return mX * v.mX + mY * v.mY;
-}
-
-QgsVector QgsVector::operator+( QgsVector other ) const
-{
-  return QgsVector( mX + other.mX, mY + other.mY );
-}
-
-QgsVector &QgsVector::operator+=( QgsVector other )
-{
-  mX += other.mX;
-  mY += other.mY;
-  return *this;
-}
-
-QgsVector QgsVector::operator-( QgsVector other ) const
-{
-  return QgsVector( mX - other.mX, mY - other.mY );
-}
-
-QgsVector &QgsVector::operator-=( QgsVector other )
-{
-  mX -= other.mX;
-  mY -= other.mY;
-  return *this;
-}
-
-double QgsVector::length() const
-{
-  return std::sqrt( mX * mX + mY * mY );
-}
-
-double QgsVector::x() const
-{
-  return mX;
-}
-
-double QgsVector::y() const
-{
-  return mY;
-}
-
-QgsVector QgsVector::perpVector() const
-{
-  return QgsVector( -mY, mX );
-}
-
-double QgsVector::angle() const
-{
-  double angle = std::atan2( mY, mX );
-  return angle < 0.0 ? angle + 2.0 * M_PI : angle;
-}
-
-double QgsVector::angle( QgsVector v ) const
-{
-  return v.angle() - angle();
-}
-
-double QgsVector::crossProduct( QgsVector v ) const
-{
-  return mX * v.y() - mY * v.x();
-}
-
 QgsVector QgsVector::rotateBy( double rot ) const
 {
   double angle = std::atan2( mY, mX ) + rot;
@@ -122,13 +36,3 @@ QgsVector QgsVector::normalized() const
 
   return *this / len;
 }
-
-bool QgsVector::operator==( QgsVector other ) const
-{
-  return qgsDoubleNear( mX, other.mX ) && qgsDoubleNear( mY, other.mY );
-}
-
-bool QgsVector::operator!=( QgsVector other ) const
-{
-  return !qgsDoubleNear( mX, other.mX ) || !qgsDoubleNear( mY, other.mY );
-}
diff --git a/src/core/qgsvector.h b/src/core/qgsvector.h

-Original file line number
+Diff line change
      * \param x x-component
      * \param y y-component
      */
 -    QgsVector( double x, double y );
 +    QgsVector( double x, double y )
 +      : mX( x )
 +      , mY( y )
 +    {
 +    }
     //! Swaps the sign of the x and y components of the vector.
 -    QgsVector operator-() const;
 +    QgsVector operator-() const SIP_HOLDGIL
 +    {
 +      return QgsVector( -mX, -mY );
 +    }
     /**
      * Returns a vector where the components have been multiplied by a scalar value.
      * \param scalar factor to multiply by
      */
 -    QgsVector operator*( double scalar ) const;
 +    QgsVector operator*( double scalar ) const SIP_HOLDGIL
 +    {
 +      return QgsVector( mX * scalar, mY * scalar );
 +    }
     /**
      * Returns a vector where the components have been divided by a scalar value.
      * \param scalar factor to divide by
      */
 -    QgsVector operator/( double scalar ) const;
 +    QgsVector operator/( double scalar ) const SIP_HOLDGIL
 +    {
 +      return *this * ( 1.0 / scalar );
 +    }
     /**
      * Returns the dot product of two vectors, which is the sum of the x component
      *  of this vector multiplied by the x component of another
      *  vector plus the y component of this vector multiplied by the y component of another vector.
      */
 -    double operator*( QgsVector v ) const;
 +    double operator*( QgsVector v ) const SIP_HOLDGIL
 +    {
 +      return mX * v.mX + mY * v.mY;
 +    }
     /**
      * Adds another vector to this vector.
      * \since QGIS 3.0
      */
 -    QgsVector operator+( QgsVector other ) const;
 +    QgsVector operator+( QgsVector other ) const SIP_HOLDGIL
 +    {
 +      return QgsVector( mX + other.mX, mY + other.mY );
 +    }
     /**
      * Adds another vector to this vector in place.
      * \since QGIS 3.0
      */
 -    QgsVector &operator+=( QgsVector other );
 +    QgsVector &operator+=( QgsVector other ) SIP_HOLDGIL
 +    {
 +      mX += other.mX;
 +      mY += other.mY;
 +      return *this;
 +    }
     /**
      * Subtracts another vector to this vector.
      * \since QGIS 3.0
      */
 -    QgsVector operator-( QgsVector other ) const;
 +    QgsVector operator-( QgsVector other ) const SIP_HOLDGIL
 +    {
 +      return QgsVector( mX - other.mX, mY - other.mY );
 +    }
     /**
      * Subtracts another vector to this vector in place.
      * \since QGIS 3.0
      */
 -    QgsVector &operator-=( QgsVector other );
 +    QgsVector &operator-=( QgsVector other ) SIP_HOLDGIL
 +    {
 +      mX -= other.mX;
 +      mY -= other.mY;
 +      return *this;
 +    }
     /**
      * Returns the length of the vector.
      * \see lengthSquared()
      */
 -    double length() const;
 +    double length() const SIP_HOLDGIL
 +    {
 +      return std::sqrt( mX * mX + mY * mY );
 +    }
     /**
      * Returns the length of the vector.
      * \see length()
      * \since QGIS 3.2
      */
 -    double lengthSquared() const
 +    double lengthSquared() const SIP_HOLDGIL
+    {
       return mX * mX + mY * mY;
+    }
      * Returns the vector's x-component.
      * \see y()
      */
 -    double x() const;
 +    double x() const SIP_HOLDGIL
 +    {
 +      return mX;
 +    }
     /**
      * Returns the vector's y-component.
      * \see x()
      */
 -    double y() const;
 +    double y() const SIP_HOLDGIL
 +    {
 +      return mY;
 +    }
     /**
      * Returns the perpendicular vector to this vector (rotated 90 degrees counter-clockwise)
      */
 -    QgsVector perpVector() const;
 +    QgsVector perpVector() const SIP_HOLDGIL
 +    {
 +      return QgsVector( -mY, mX );
 +    }
     /**
      * Returns the angle of the vector in radians.
      */
 -    double angle() const;
 +    double angle() const SIP_HOLDGIL
 +    {
 +      double angle = std::atan2( mY, mX );
 +      return angle < 0.0 ? angle + 2.0 * M_PI : angle;
 +    }
     /**
      * Returns the angle between this vector and another vector in radians.
      */
 -    double angle( QgsVector v ) const;
 +    double angle( QgsVector v ) const SIP_HOLDGIL
 +    {
 +      return v.angle() - angle();
 +    }
     /**
      * Returns the 2D cross product of this vector and another vector \a v. (This is sometimes
      * referred to as a "perpendicular dot product", and equals x1 * y1 - y1 * x2).
+     *
      * \since QGIS 3.2
      */
 -    double crossProduct( QgsVector v ) const;
 +    double crossProduct( QgsVector v ) const SIP_HOLDGIL
 +    {
 +      return mX * v.y() - mY * v.x();
 +    }
     /**
      * Rotates the vector by a specified angle.
      * \param rot angle in radians
      */
 -    QgsVector rotateBy( double rot ) const;
 +    QgsVector rotateBy( double rot ) const SIP_HOLDGIL;
     /**
      * Returns the vector's normalized (or "unit") vector (ie same angle but length of 1.0).
 -     * Will throw a QgsException if called on a vector with length of 0.
 +     *
 +     * \throws QgsException if called on a vector with length of 0.
      */
 -    QgsVector normalized() const;
 +    QgsVector normalized() const SIP_THROW( QgsException );
     //! Equality operator
 -    bool operator==( QgsVector other ) const;
 +    bool operator==( QgsVector other ) const SIP_HOLDGIL
 +    {
 +      return qgsDoubleNear( mX, other.mX ) && qgsDoubleNear( mY, other.mY );
 +    }
     //! Inequality operator
 -    bool operator!=( QgsVector other ) const;
+-
 +    bool operator!=( QgsVector other ) const
 +    {
 +      return !qgsDoubleNear( mX, other.mX ) || !qgsDoubleNear( mY, other.mY );
 +    }
     /**
     * Returns a string representation of the vector.
     * Members will be truncated to the specified \a precision.
     */
 -    QString toString( int precision = 17 ) const
 +    QString toString( int precision = 17 ) const SIP_HOLDGIL
+    {
       QString str = "Vector (";
       str += qgsDoubleToString( mX, precision );
 #endif
   private:
 -    double mX = 0.0, mY = 0.0;
 +    double mX = 0.0;
 +    double mY = 0.0;
 };