[geos-commits] [SCM] GEOS branch master updated. 3133734b73aec52c70643c41fc43f19cfb5f680f
git at osgeo.org
git at osgeo.org
Sat Jul 27 00:05:06 PDT 2019
This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "GEOS".
The branch, master has been updated
via 3133734b73aec52c70643c41fc43f19cfb5f680f (commit)
from bd4e378a3e0adec55a4e36fab001039fb72f3ce2 (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
- Log -----------------------------------------------------------------
commit 3133734b73aec52c70643c41fc43f19cfb5f680f
Author: nila <n_larsson at yahoo.com>
Date: Sat Jul 27 00:46:14 2019 +0200
fix bad doxygen links
and in addition some minor stylistic changes to the comments
diff --git a/include/geos/algorithm/CGAlgorithmsDD.h b/include/geos/algorithm/CGAlgorithmsDD.h
index 7f586f9..258361b 100644
--- a/include/geos/algorithm/CGAlgorithmsDD.h
+++ b/include/geos/algorithm/CGAlgorithmsDD.h
@@ -21,8 +21,11 @@
#include <geos/export.h>
#include <geos/algorithm/ttmath/ttmath.h>
-// Close to DoubleDouble equivalent used by JTS
-// Usage: ttmath::Big<exponent, mantissa>
+/// \file CGAlgorithmsDD.h
+
+/// \brief Close to DoubleDouble equivalent used by JTS
+///
+/// Usage: `ttmath::Big<exponent, mantissa>`
typedef ttmath::Big<TTMATH_BITS(32), TTMATH_BITS(128)> DD;
//typedef ttmath::Big<TTMATH_BITS(64), TTMATH_BITS(128)> DD;
//typedef ttmath::Big<TTMATH_BITS(32), TTMATH_BITS(256)> DD;
@@ -38,10 +41,8 @@ class CoordinateSequence;
namespace geos {
namespace algorithm { // geos::algorithm
-/**
-* \brief
-* Implements basic computational geometry algorithms using extended precision float-point arithmetic.
-*/
+
+/// Implements basic computational geometry algorithms using extended precision float-point arithmetic.
class GEOS_DLL CGAlgorithmsDD {
public:
@@ -59,9 +60,9 @@ public:
FAILURE = 2
};
- /**
- * Returns the index of the direction of the point <code>q</code> relative to
- * a vector specified by <code>p1-p2</code>.
+ /** \brief
+ * Returns the index of the direction of the point `q` relative to
+ * a vector specified by `p1-p2`.
*
* @param p1 the origin point of the vector
* @param p2 the final point of the vector
@@ -74,25 +75,25 @@ public:
static int orientationIndex(const geom::Coordinate& p1,
const geom::Coordinate& p2,
const geom::Coordinate& q);
- /**
- * A filter for computing the orientation index of three coordinates.
- * <p>
- * If the orientation can be computed safely using standard DP
- * arithmetic, this routine returns the orientation index.
- * Otherwise, a value i > 1 is returned.
- * In this case the orientation index must
- * be computed using some other more robust method.
- * The filter is fast to compute, so can be used to
- * avoid the use of slower robust methods except when they are really needed,
- * thus providing better average performance.
- * <p>
- * Uses an approach due to Jonathan Shewchuk, which is in the public domain.
- *
- * @param pa a coordinate
- * @param pb a coordinate
- * @param pc a coordinate
- * @return the orientation index if it can be computed safely
- * @return i > 1 if the orientation index cannot be computed safely
+ /** \brief
+ * A filter for computing the orientation index of three coordinates.
+ *
+ * If the orientation can be computed safely using standard DP arithmetic,
+ * this routine returns the orientation index. Otherwise, a value `i > 1` is
+ * returned. In this case the orientation index must be computed using some
+ * other more robust method.
+ *
+ * The filter is fast to compute, so can be used to avoid the use of slower
+ * robust methods except when they are really needed, thus providing better
+ * average performance.
+ *
+ * Uses an approach due to Jonathan Shewchuk, which is in the public domain.
+ *
+ * @param pa a coordinate
+ * @param pb a coordinate
+ * @param pc a coordinate
+ * @return the orientation index if it can be computed safely
+ * @return `i > 1` if the orientation index cannot be computed safely
*/
static int orientationIndexFilter(const geom::Coordinate& pa,
const geom::Coordinate& pb,
@@ -119,27 +120,29 @@ public:
static DD detDD(double x1, double y1, double x2, double y2);
static DD detDD(const DD& x1, const DD& y1, const DD& x2, const DD& y2);
- /**
- * Computes the circumcentre of a triangle. The circumcentre is the centre of
- * the circumcircle, the smallest circle which encloses the triangle. It is
- * also the common intersection point of the perpendicular bisectors of the
- * sides of the triangle, and is the only point which has equal distance to
- * all three vertices of the triangle.
- * <p>
- * The circumcentre does not necessarily lie within the triangle. For example,
- * the circumcentre of an obtuse isosceles triangle lies outside the triangle.
- * <p>
- * This method uses {@link DD} extended-precision arithmetic to
- * provide more accurate results than {@link #circumcentre(Coordinate, Coordinate, Coordinate)}
- *
- * @param a
- * a vertex of the triangle
- * @param b
- * a vertex of the triangle
- * @param c
- * a vertex of the triangle
- * @return the circumcentre of the triangle
- */
+ /** \brief
+ * Computes the circumcentre of a triangle.
+ *
+ * The circumcentre is the centre of the circumcircle, the smallest circle
+ * which encloses the triangle. It is also the common intersection point of
+ * the perpendicular bisectors of the sides of the triangle, and is the only
+ * point which has equal distance to all three vertices of the triangle.
+ *
+ * The circumcentre does not necessarily lie within the triangle. For example,
+ * the circumcentre of an obtuse isosceles triangle lies outside the triangle.
+ *
+ * This method uses @ref DD extended-precision arithmetic to provide more accurate
+ * results than [circumcentre(Coordinate, Coordinate, Coordinate)]
+ * (@ref geos::geom::Triangle::circumcentre(const Coordinate& p0, const Coordinate& p1, const Coordinate& p2)).
+ *
+ * @param a
+ * a vertex of the triangle
+ * @param b
+ * a vertex of the triangle
+ * @param c
+ * a vertex of the triangle
+ * @return the circumcentre of the triangle
+ */
static geom::Coordinate circumcentreDD(const geom::Coordinate& a, const geom::Coordinate& b, const geom::Coordinate& c);
protected:
diff --git a/include/geos/geom/Triangle.h b/include/geos/geom/Triangle.h
index 77cc51d..13cec65 100644
--- a/include/geos/geom/Triangle.h
+++ b/include/geos/geom/Triangle.h
@@ -39,28 +39,30 @@ public:
p2(nP2)
{}
- /**
+ /** \brief
* The inCentre of a triangle is the point which is equidistant
- * from the sides of the triangle. This is also the point at which the bisectors
- * of the angles meet.
+ * from the sides of the triangle.
+ *
+ * This is also the point at which the bisectors of the angles meet.
*
* @param resultPoint the point into which to write the inCentre of the triangle
*/
void inCentre(Coordinate& resultPoint);
- /**
- * Computes the circumcentre of a triangle. The circumcentre is the centre of
- * the circumcircle, the smallest circle which encloses the triangle. It is
- * also the common intersection point of the perpendicular bisectors of the
- * sides of the triangle, and is the only point which has equal distance to
- * all three vertices of the triangle.
- * <p>
+ /** \brief
+ * Computes the circumcentre of a triangle.
+ *
+ * The circumcentre is the centre of the circumcircle, the smallest circle
+ * which encloses the triangle. It is also the common intersection point of
+ * the perpendicular bisectors of the sides of the triangle, and is the only
+ * point which has equal distance to all three vertices of the triangle.
+ *
* The circumcentre does not necessarily lie within the triangle. For example,
* the circumcentre of an obtuse isoceles triangle lies outside the triangle.
- * <p>
+ *
* This method uses an algorithm due to J.R.Shewchuk which uses normalization
- * to the origin to improve the accuracy of computation. (See <i>Lecture Notes
- * on Geometric Robustness</i>, Jonathan Richard Shewchuk, 1999).
+ * to the origin to improve the accuracy of computation. (See *Lecture Notes
+ * on Geometric Robustness*, Jonathan Richard Shewchuk, 1999).
*
* @param resultPoint the point into which to write the inCentre of the triangle
*/
@@ -69,6 +71,7 @@ public:
bool isIsoceles();
+ /// Computes the circumcentre of a triangle.
static const Coordinate circumcentre(const Coordinate& p0, const Coordinate& p1, const Coordinate& p2);
private:
-----------------------------------------------------------------------
Summary of changes:
include/geos/algorithm/CGAlgorithmsDD.h | 101 ++++++++++++++++----------------
include/geos/geom/Triangle.h | 29 +++++----
2 files changed, 68 insertions(+), 62 deletions(-)
hooks/post-receive
--
GEOS
More information about the geos-commits
mailing list