feat(geobase): equalsCoords in PositionArray, geometries and features #146

Author: navispatial

dart/geobase/lib/src/vector_data/array/position_array.dart

@@ -107,6 +107,10 @@ abstract class PositionArray with _CoordinatesMixin {
         projection.projectCoords(_data, type: _type),
         type: _type,
       );
+
+  /// Returns true if this and [other] contain exactly same coordinate values
+  /// (or both are empty) in the same order and with the same coordinate type.
+  bool equalsCoords(PositionArray other);
 }
 
 @immutable
@@ -139,6 +143,33 @@ class _PositionArrayImpl extends PositionArray {
   //
   // Anyway, a position array might be really large, so calculating equality and
   // hash might then have performance issues too.
+
+  @override
+  bool equalsCoords(PositionArray other) {
+    if (_type != other.type) return false;
+
+    final coords1 = _data;
+    final coords2 = other is _PositionArrayImpl ? other._data : other;
+    final len = coords1.length;
+    if (len != coords2.length) return false;
+
+    if (identical(coords1, coords2)) return true;
+
+    if (coords1 is List<double> && coords2 is List<double>) {
+      for (var i = 0; i < len; i++) {
+        if (coords1[i] != coords2[i]) return false;
+      }
+    } else {
+      final iter1 = coords1.iterator;
+      final iter2 = coords2.iterator;
+      while (iter1.moveNext()) {
+        if (!iter2.moveNext()) return false;
+        if (iter1.current != iter2.current) return false;
+      }
+    }
+
+    return true;
+  }
 }
 
 class _PositionArrayData<E extends Position> with PositionData<E> {

dart/geobase/lib/src/vector_data/model/feature/feature.dart

@@ -296,6 +296,51 @@ class Feature<T extends Geometry> extends FeatureObject {
     );
   }
 
+  /// Returns true if this and [other] contain exactly same coordinate values
+  /// (or both are empty) in the same order and with the same coordinate type.
+  ///
+  /// If [ignoreCustomGeometries] is true, then [customGeometries] are ignored
+  /// in testing.
+  bool equalsCoords(
+    Feature other, {
+    bool ignoreCustomGeometries = false,
+  }) {
+    if (identical(this, other)) return true;
+
+    if (bounds != null && other.bounds != null && !(bounds! == other.bounds!)) {
+      // both feature collections has bound boxes and boxes do not equal
+      return false;
+    }
+
+    // test main geometry
+    final mg1 = geometry;
+    final mg2 = other.geometry;
+    if (mg1 != null) {
+      if (mg2 == null) return false;
+      if (!mg1.equalsCoords(mg2)) return false;
+    } else {
+      if (mg2 != null) return false;
+    }
+
+    // test custom geometries unless they should be ignored
+    if (!ignoreCustomGeometries) {
+      final cg1 = customGeometries;
+      final cg2 = other.customGeometries;
+      if (cg1 != null) {
+        if (cg2 == null || cg1.length != cg2.length) return false;
+        for (final cg1entry in cg1.entries) {
+          final cg2value = cg2[cg1entry.key];
+          if (cg2value == null) return false;
+          if (!cg1entry.value.equalsCoords(cg2value)) return false;
+        }
+      } else {
+        if (cg2 != null) return false;
+      }
+    }
+
+    return true;
+  }
+
   /// True if this feature equals with [other] by testing 2D coordinates of the
   /// [geometry] object (and any [customGeometries] possibly contained).
   ///
@@ -323,7 +368,7 @@ class Feature<T extends Geometry> extends FeatureObject {
           other.bounds!,
           toleranceHoriz: toleranceHoriz,
         )) {
-      // both geometries has bound boxes and boxes do not equal in 2D
+      // both features has bound boxes and boxes do not equal in 2D
       return false;
     }
 
@@ -396,7 +441,7 @@ class Feature<T extends Geometry> extends FeatureObject {
           toleranceHoriz: toleranceHoriz,
           toleranceVert: toleranceVert,
         )) {
-      // both geometries has bound boxes and boxes do not equal in 3D
+      // both features has bound boxes and boxes do not equal in 3D
       return false;
     }
 

dart/geobase/lib/src/vector_data/model/feature/feature_collection.dart

@@ -237,6 +237,36 @@ class FeatureCollection<E extends Feature> extends FeatureObject {
     );
   }
 
+  /// Returns true if this and [other] contain exactly same coordinate values
+  /// (or both are empty) in the same order and with the same coordinate type.
+  ///
+  /// If [ignoreCustomGeometries] is true, then `customGeometries` of features
+  /// are ignored in testing.
+  bool equalsCoords(
+    FeatureCollection other, {
+    bool ignoreCustomGeometries = false,
+  }) {
+    if (identical(this, other)) return true;
+
+    if (bounds != null && other.bounds != null && !(bounds! == other.bounds!)) {
+      // both feature collections has bound boxes and boxes do not equal
+      return false;
+    }
+
+    final fc1 = features;
+    final fc2 = other.features;
+    if (fc1.length != fc2.length) return false;
+    for (var i = 0; i < fc1.length; i++) {
+      if (!fc1[i].equalsCoords(
+        fc2[i],
+        ignoreCustomGeometries: ignoreCustomGeometries,
+      )) {
+        return false;
+      }
+    }
+    return true;
+  }
+
   /// True if this feature collection equals with [other] by testing 2D
   /// coordinates of geometries of [features] (that must be in same order in
   /// both collections) contained.
@@ -262,7 +292,7 @@ class FeatureCollection<E extends Feature> extends FeatureObject {
           other.bounds!,
           toleranceHoriz: toleranceHoriz,
         )) {
-      // both geometries has bound boxes and boxes do not equal in 2D
+      // both feature collections has bound boxes and boxes do not equal in 2D
       return false;
     }
 
@@ -315,7 +345,7 @@ class FeatureCollection<E extends Feature> extends FeatureObject {
           toleranceHoriz: toleranceHoriz,
           toleranceVert: toleranceVert,
         )) {
-      // both geometries has bound boxes and boxes do not equal in 3D
+      // both feature collections has bound boxes and boxes do not equal in 3D
       return false;
     }
 

dart/geobase/lib/src/vector_data/model/geometry/geometry.dart

@@ -103,6 +103,10 @@ abstract class Geometry extends Bounded {
     return encoder.toBytes();
   }
 
+  /// Returns true if this and [other] contain exactly same coordinate values
+  /// (or both are empty) in the same order and with the same coordinate type.
+  bool equalsCoords(Geometry other);
+
   /// True if this geometry equals with [other] by testing 2D coordinates of all
   /// positions (that must be in same order in both geometries).
   ///

dart/geobase/lib/src/vector_data/model/geometry/geometry_collection.dart

@@ -201,6 +201,24 @@ class GeometryCollection<E extends Geometry> extends Geometry {
           bounds: bounds,
         );
 
+  @override
+  bool equalsCoords(Geometry other) {
+    if (other is! GeometryCollection) return false;
+    if (identical(this, other)) return true;
+    if (bounds != null && other.bounds != null && !(bounds! == other.bounds!)) {
+      // both geometries has bound boxes and boxes do not equal
+      return false;
+    }
+
+    final g1 = geometries;
+    final g2 = other.geometries;
+    if (g1.length != g2.length) return false;
+    for (var i = 0; i < g1.length; i++) {
+      if (!g1[i].equalsCoords(g2[i])) return false;
+    }
+    return true;
+  }
+
   @override
   bool equals2D(
     Geometry other, {

dart/geobase/lib/src/vector_data/model/geometry/linestring.dart

@@ -213,6 +213,18 @@ class LineString extends SimpleGeometry {
 
   // NOTE: coordinates as raw data
 
+  @override
+  bool equalsCoords(Geometry other) {
+    if (other is! LineString) return false;
+    if (identical(this, other)) return true;
+    if (bounds != null && other.bounds != null && !(bounds! == other.bounds!)) {
+      // both geometries has bound boxes and boxes do not equal
+      return false;
+    }
+
+    return chain.equalsCoords(other.chain);
+  }
+
   @override
   bool equals2D(
     Geometry other, {

dart/geobase/lib/src/vector_data/model/geometry/multi_linestring.dart

@@ -254,6 +254,24 @@ class MultiLineString extends SimpleGeometry {
 
   // NOTE: coordinates as raw data
 
+  @override
+  bool equalsCoords(Geometry other) {
+    if (other is! MultiLineString) return false;
+    if (identical(this, other)) return true;
+    if (bounds != null && other.bounds != null && !(bounds! == other.bounds!)) {
+      // both geometries has bound boxes and boxes do not equal
+      return false;
+    }
+
+    final c1 = chains;
+    final c2 = other.chains;
+    if (c1.length != c2.length) return false;
+    for (var i = 0; i < c1.length; i++) {
+      if (!c1[i].equalsCoords(c2[i])) return false;
+    }
+    return true;
+  }
+
   @override
   bool equals2D(
     Geometry other, {

dart/geobase/lib/src/vector_data/model/geometry/multi_point.dart

@@ -225,6 +225,24 @@ class MultiPoint extends SimpleGeometry {
 
   // NOTE: coordinates as raw data
 
+  @override
+  bool equalsCoords(Geometry other) {
+    if (other is! MultiPoint) return false;
+    if (identical(this, other)) return true;
+    if (bounds != null && other.bounds != null && !(bounds! == other.bounds!)) {
+      // both geometries has bound boxes and boxes do not equal
+      return false;
+    }
+
+    final p1 = positions;
+    final p2 = other.positions;
+    if (p1.length != p2.length) return false;
+    for (var i = 0; i < p1.length; i++) {
+      if (p1[i] != p2[i]) return false;
+    }
+    return true;
+  }
+
   @override
   bool equals2D(
     Geometry other, {

dart/geobase/lib/src/vector_data/model/geometry/multi_polygon.dart

@@ -293,6 +293,33 @@ class MultiPolygon extends SimpleGeometry {
 
   // NOTE: coordinates as raw data
 
+  @override
+  bool equalsCoords(Geometry other) {
+    if (other is! MultiPolygon) return false;
+    if (identical(this, other)) return true;
+    if (bounds != null && other.bounds != null && !(bounds! == other.bounds!)) {
+      // both geometries has bound boxes and boxes do not equal
+      return false;
+    }
+
+    final arr1 = ringArrays;
+    final arr2 = other.ringArrays;
+    if (arr1.length != arr2.length) return false;
+    // loop all arrays of ring data
+    for (var j = 0; j < arr1.length; j++) {
+      // get linear ring lists from arrays by index j
+      final r1 = arr1[j];
+      final r2 = arr2[j];
+      // ensure r1 and r2 has same amount of linear rings
+      if (r1.length != r2.length) return false;
+      // loop all linear rings and test coordinates
+      for (var i = 0; i < r1.length; i++) {
+        if (!r1[i].equalsCoords(r2[i])) return false;
+      }
+    }
+    return true;
+  }
+
   @override
   bool equals2D(
     Geometry other, {

dart/geobase/lib/src/vector_data/model/geometry/point.dart

@@ -212,6 +212,10 @@ class Point implements SimpleGeometry {
     return encoder.toBytes();
   }
 
+  @override
+  bool equalsCoords(Geometry other) =>
+      other is Point && position == other.position;
+
   @override
   bool equals2D(
     Geometry other, {