Skip to content

[WIP] API simplification #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Copilot wants to merge 2 commits into
base: develop
Choose a base branch
from
Draft

[WIP] API simplification #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f479745
Initial plan for issue
Copilot May 22, 2025
3eaf1b1
Remove Z and M properties from Coordinate structure and update core f…
Copilot May 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
160 changes: 49 additions & 111 deletions src/SpatialLite.Core/API/Coordinate.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,99 +1,39 @@
using System;

namespace SpatialLite.Core.API {
/// <summary>
/// Represents a location in the coordinate space.
/// </summary>
/// <remarks>
/// A Coordinate may include a M value. The M value allows an application to associate some measure with the <c>Coordinate</c>.
/// </remarks>
public struct Coordinate : IEquatable<Coordinate> {

/// <summary>
/// Represents an empty coordinate.
/// </summary>
/// <remarks>
/// The empty coordinate has all coordinates equal to NaN.
/// </remarks>
public static Coordinate Empty = new Coordinate(double.NaN, double.NaN, double.NaN, double.NaN);

/// <summary>
/// Initializes a new instance of the <c>Coordinate</c> struct with X, Y ordinates.
/// </summary>
/// <param name="x">X-coordinate value.</param>
/// <param name="y">Y-coordinate value.</param>
public Coordinate(double x, double y) {
X = x;
Y = y;
Z = double.NaN;
M = double.NaN;
/// <summary>
/// Represents a location in the coordinate space.
/// </summary>
public struct Coordinate : IEquatable<Coordinate> {

/// <summary>
/// Represents an empty coordinate.
/// </summary>
/// <remarks>
/// The empty coordinate has all coordinates equal to NaN.
/// </remarks>
public static Coordinate Empty = new Coordinate(double.NaN, double.NaN);

/// <summary>
/// Initializes a new instance of the <c>Coordinate</c> struct with X, Y ordinates.
/// </summary>
/// <param name="x">X-coordinate value.</param>
/// <param name="y">Y-coordinate value.</param>
public Coordinate(double x, double y) {
X = x;
Y = y;
}

/// <summary>
/// Initializes a new instance of the <c>Coordinate</c> struct with X, Y, Z ordinates.
/// </summary>
/// <param name="x">X-coordinate value.</param>
/// <param name="y">Y-coordinate value.</param>
/// <param name="z">Z-coordinate value.</param>
public Coordinate(double x, double y, double z) {
X = x;
Y = y;
Z = z;
M = double.NaN;
}

/// <summary>
/// Initializes a new instance of the <c>Coordinate</c> struct with X, Y, Z ordinates and M value.
/// </summary>
/// <param name="x">X-coordinate value.</param>
/// <param name="y">Y-coordinate value.</param>
/// <param name="z">Z-coordinate value.</param>
/// <param name="m">Measured value associated with the Coordinate.</param>
public Coordinate(double x, double y, double z, double m) {
X = x;
Y = y;
Z = z;
M = m;
}

/// <summary>
/// Gets the X-coordinate
/// </summary>
public double X { get; set; }

/// <summary>
/// Gets the Y-coordinate
/// </summary>
/// <summary>
/// Gets the X-coordinate
/// </summary>
public double X { get; set; }

/// <summary>
/// Gets the Y-coordinate
/// </summary>
public double Y { get; set; }

/// <summary>
/// Gets the Z-coordinate
/// </summary>
public double Z { get; set; }

/// <summary>
/// Gets the M value
/// </summary>
public double M { get; set; }

/// <summary>
/// Gets a value indicating whether this coordinate has assigned <see cref="Coordinate.Z"/> coordinate.
/// </summary>
public bool Is3D {
get {
return !double.IsNaN(this.Z);
}
}

/// <summary>
/// Gets a value indicating whether this coordinate has assigned <see cref="Coordinate.M"/> value.
/// </summary>
public bool IsMeasured {
get {
return !double.IsNaN(this.M);
}
}

/// <summary>
/// Determiens whether specific Coordinates values are equal
/// </summary>
Expand All @@ -114,12 +54,12 @@ public bool IsMeasured {
return !(lhs == rhs);
}

/// <summary>
/// Returns a <c>string</c> that represents the current <c>Coordinate</c>.
/// </summary>
/// <returns>A <c>string</c> that represents the current <c>Coordinate</c></returns>
public override string ToString() {
return string.Format(System.Globalization.CultureInfo.InvariantCulture, "[{0}; {1}; {2}, {3}]", this.X, this.Y, this.Z, this.M);
/// <summary>
/// Returns a <c>string</c> that represents the current <c>Coordinate</c>.
/// </summary>
/// <returns>A <c>string</c> that represents the current <c>Coordinate</c></returns>
public override string ToString() {
return string.Format(System.Globalization.CultureInfo.InvariantCulture, "[{0}; {1}]", this.X, this.Y);
}

/// <summary>
Expand All @@ -136,24 +76,22 @@ public override bool Equals(object obj) {
return this.Equals(other.Value);
}

/// <summary>
/// Determines whether two <c>Coordinate</c> values are equal.
/// </summary>
/// <param name="other">The <c>Coordinate</c> to compare with the current <c>Coordinate</c></param>
/// <returns>true if the specified <c>Coordinate</c> is equal to the current <c>Coordinate</c>; otherwise, false.</returns>
public bool Equals(Coordinate other) {
return ((this.X == other.X) || (double.IsNaN(this.X) && double.IsNaN(other.X))) &&
((this.Y == other.Y) || (double.IsNaN(this.Y) && double.IsNaN(other.Y))) &&
((this.Z == other.Z) || (double.IsNaN(this.Z) && double.IsNaN(other.Z))) &&
((this.M == other.M) || (double.IsNaN(this.M) && double.IsNaN(other.M)));
/// <summary>
/// Determines whether two <c>Coordinate</c> values are equal.
/// </summary>
/// <param name="other">The <c>Coordinate</c> to compare with the current <c>Coordinate</c></param>
/// <returns>true if the specified <c>Coordinate</c> is equal to the current <c>Coordinate</c>; otherwise, false.</returns>
public bool Equals(Coordinate other) {
return ((this.X == other.X) || (double.IsNaN(this.X) && double.IsNaN(other.X))) &&
((this.Y == other.Y) || (double.IsNaN(this.Y) && double.IsNaN(other.Y)));
}

/// <summary>
/// Serves as a hash function for the <c>Coordinate</c> structure.
/// </summary>
/// <returns>Hash code for current Coordinate value.</returns>
public override int GetHashCode() {
return X.GetHashCode() + 7 * Y.GetHashCode() + 13 * Z.GetHashCode() + 17 * M.GetHashCode();
/// <summary>
/// Serves as a hash function for the <c>Coordinate</c> structure.
/// </summary>
/// <returns>Hash code for current Coordinate value.</returns>
public override int GetHashCode() {
return X.GetHashCode() + 7 * Y.GetHashCode();
}

/// <summary>
Expand Down
Loading
Loading