[geos-commits] [SCM] GEOS branch main updated. 975fa0008472416c4690b2ff1e7d843342c5fb92

[git at osgeo.org]

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, main has been updated
       via  975fa0008472416c4690b2ff1e7d843342c5fb92 (commit)
      from  a7529ec07fd9e2a93e4b42d281bbcc8929eb6aea (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 975fa0008472416c4690b2ff1e7d843342c5fb92
Author: Martin Davis <mtnclimb at gmail.com>
Date:   Thu May 23 20:21:49 2024 -0700

    Improve Envelope doc

diff --git a/include/geos/geom/Envelope.h b/include/geos/geom/Envelope.h
index 784e79d61..823a0dc04 100644
--- a/include/geos/geom/Envelope.h
+++ b/include/geos/geom/Envelope.h
@@ -48,7 +48,8 @@ class Coordinate;
  * It is often used to represent the bounding box of a Geometry,
  * e.g. the minimum and maximum x and y values of the Coordinates.
  *
- * Note that Envelopes support infinite or half-infinite regions, by using
+ * Envelopes allow null values, which are represented with NaN values for ordinates.
+ * Envelopes support infinite or half-infinite regions, by using
  * the values of `Double_POSITIVE_INFINITY` and `Double_NEGATIVE_INFINITY`.
  *
  * When Envelope objects are created or initialized, the supplies extent
@@ -301,8 +302,8 @@ public:
     }
 
     /** \brief
-     * Returns the Envelope maximum y-value. `min y > max y` indicates
-     * that this is a null Envelope.
+     * Returns the Envelope maximum y-value. 
+     * Null envelopes do not have maximum values.
      */
     double getMaxY() const
     {
@@ -311,8 +312,8 @@ public:
     };
 
     /** \brief
-     * Returns the Envelope maximum x-value. `min x > max x` indicates
-     * that this is a null Envelope.
+     * Returns the Envelope maximum x-value. 
+     * Null envelopes do not have maximum values.
      */
     double getMaxX() const
     {
@@ -321,8 +322,8 @@ public:
     };
 
     /** \brief
-     * Returns the Envelope minimum y-value. `min y > max y` indicates
-     * that this is a null Envelope.
+     * Returns the Envelope minimum y-value. 
+     * Null envelopes do not have maximum values.
      */
     double getMinY() const
     {
@@ -331,8 +332,8 @@ public:
     };
 
     /** \brief
-     * Returns the Envelope minimum x-value. `min x > max x` indicates
-     * that this is a null Envelope.
+     * Returns the Envelope minimum x-value. 
+     * Null envelopes do not have maximum values.
      */
     double getMinX() const
     {
@@ -371,7 +372,7 @@ public:
      * @param result the envelope representing the intersection of
      *               the envelopes (this will be the null envelope
      *               if either argument is null, or they do not intersect)
-     * @return false if not intersection is found
+     * @return false if no intersection is found
      */
     bool intersection(const Envelope& env, Envelope& result) const;
 

-----------------------------------------------------------------------

Summary of changes:
 include/geos/geom/Envelope.h | 21 +++++++++++----------
 1 file changed, 11 insertions(+), 10 deletions(-)


hooks/post-receive
-- 
GEOS