Cube support (revamped)

Directory.Packages.props

@@ -2,7 +2,7 @@
   <PropertyGroup>
     <EFCoreVersion>10.0.0-rc.2.25502.107</EFCoreVersion>
     <MicrosoftExtensionsVersion>10.0.0-rc.2.25502.107</MicrosoftExtensionsVersion>
-    <NpgsqlVersion>10.0.0-rc.1</NpgsqlVersion>
+    <NpgsqlVersion>10.0.0-rc.2-ci.20251103T150833</NpgsqlVersion>
   </PropertyGroup>
 
   <ItemGroup>

src/EFCore.PG/Extensions/DbFunctionsExtensions/NpgsqlCubeDbFunctionsExtensions.cs

@@ -0,0 +1,169 @@
+// ReSharper disable once CheckNamespace
+
+using NpgsqlTypes;
+
+namespace Microsoft.EntityFrameworkCore;
+
+/// <summary>
+///     Provides extension methods for <see cref="NpgsqlCube" /> supporting PostgreSQL translation.
+/// </summary>
+/// <remarks>
+///     See <see href="https://www.postgresql.org/docs/current/cube.html">PostgreSQL documentation for the cube extension</see>.
+/// </remarks>
+public static class NpgsqlCubeDbFunctionsExtensions
+{
+    /// <summary>
+    ///     Determines whether two cubes overlap (have points in common).
+    /// </summary>
+    /// <param name="cube">The first cube.</param>
+    /// <param name="other">The second cube.</param>
+    /// <returns>
+    ///     true if the cubes overlap; otherwise, false.
+    /// </returns>
+    /// <exception cref="InvalidOperationException">
+    ///     <see cref="Overlaps" /> is only intended for use via SQL translation as part of an EF Core LINQ query.
+    /// </exception>
+    public static bool Overlaps(this NpgsqlCube cube, NpgsqlCube other)
+        => throw new InvalidOperationException(CoreStrings.FunctionOnClient(nameof(Overlaps)));
+
+    /// <summary>
+    ///     Determines whether a cube contains another cube.
+    /// </summary>
+    /// <param name="cube">The cube to check.</param>
+    /// <param name="other">The cube that may be contained.</param>
+    /// <returns>
+    ///     true if <paramref name="cube" /> contains <paramref name="other" />; otherwise, false.
+    /// </returns>
+    /// <exception cref="InvalidOperationException">
+    ///     <see cref="Contains" /> is only intended for use via SQL translation as part of an EF Core LINQ query.
+    /// </exception>
+    public static bool Contains(this NpgsqlCube cube, NpgsqlCube other)
+        => throw new InvalidOperationException(CoreStrings.FunctionOnClient(nameof(Contains)));
+
+    /// <summary>
+    ///     Determines whether a cube is contained by another cube.
+    /// </summary>
+    /// <param name="cube">The cube to check.</param>
+    /// <param name="other">The cube that may contain it.</param>
+    /// <returns>
+    ///     true if <paramref name="cube" /> is contained by <paramref name="other" />; otherwise, false.
+    /// </returns>
+    /// <exception cref="InvalidOperationException">
+    ///     <see cref="ContainedBy" /> is only intended for use via SQL translation as part of an EF Core LINQ query.
+    /// </exception>
+    public static bool ContainedBy(this NpgsqlCube cube, NpgsqlCube other)
+        => throw new InvalidOperationException(CoreStrings.FunctionOnClient(nameof(ContainedBy)));
+
+    /// <summary>
+    ///     Extracts the n-th coordinate of the cube.
+    /// </summary>
+    /// <param name="cube">The cube.</param>
+    /// <param name="index">The coordinate index to extract.</param>
+    /// <returns>The coordinate value at the specified index.</returns>
+    /// <remarks>
+    ///     This method uses zero-based indexing (C# convention), which is translated to PostgreSQL's one-based indexing.
+    /// </remarks>
+    /// <exception cref="InvalidOperationException">
+    ///     <see cref="NthCoordinate" /> is only intended for use via SQL translation as part of an EF Core LINQ query.
+    /// </exception>
+    public static double NthCoordinate(this NpgsqlCube cube, int index)
+        => throw new InvalidOperationException(CoreStrings.FunctionOnClient(nameof(NthCoordinate)));
+
+    /// <summary>
+    ///     Extracts the n-th coordinate of the cube for K-nearest neighbor (KNN) indexing.
+    /// </summary>
+    /// <param name="cube">The cube.</param>
+    /// <param name="index">The coordinate index to extract.</param>
+    /// <returns>The coordinate value at the specified index.</returns>
+    /// <remarks>
+    ///     <para>
+    ///         This method uses zero-based indexing (C# convention), which is translated to PostgreSQL's one-based indexing.
+    ///     </para>
+    ///     <para>
+    ///         This is the same as <see cref="NthCoordinate" /> except it is marked "lossy" for GiST indexing purposes,
+    ///         which is useful for K-nearest neighbor queries.
+    ///     </para>
+    /// </remarks>
+    /// <exception cref="InvalidOperationException">
+    ///     <see cref="NthCoordinateKnn" /> is only intended for use via SQL translation as part of an EF Core LINQ query.
+    /// </exception>
+    public static double NthCoordinateKnn(this NpgsqlCube cube, int index)
+        => throw new InvalidOperationException(CoreStrings.FunctionOnClient(nameof(NthCoordinateKnn)));
+
+    /// <summary>
+    ///     Computes the Euclidean distance between two cubes.
+    /// </summary>
+    /// <param name="cube">The first cube.</param>
+    /// <param name="other">The second cube.</param>
+    /// <returns>The Euclidean distance between the two cubes.</returns>
+    /// <exception cref="InvalidOperationException">
+    ///     <see cref="Distance" /> is only intended for use via SQL translation as part of an EF Core LINQ query.
+    /// </exception>
+    public static double Distance(this NpgsqlCube cube, NpgsqlCube other)
+        => throw new InvalidOperationException(CoreStrings.FunctionOnClient(nameof(Distance)));
+
+    /// <summary>
+    ///     Computes the taxicab (L-1 metric) distance between two cubes.
+    /// </summary>
+    /// <param name="cube">The first cube.</param>
+    /// <param name="other">The second cube.</param>
+    /// <returns>The taxicab distance between the two cubes.</returns>
+    /// <exception cref="InvalidOperationException">
+    ///     <see cref="DistanceTaxicab" /> is only intended for use via SQL translation as part of an EF Core LINQ query.
+    /// </exception>
+    public static double DistanceTaxicab(this NpgsqlCube cube, NpgsqlCube other)
+        => throw new InvalidOperationException(CoreStrings.FunctionOnClient(nameof(DistanceTaxicab)));
+
+    /// <summary>
+    ///     Computes the Chebyshev (L-inf metric) distance between two cubes.
+    /// </summary>
+    /// <param name="cube">The first cube.</param>
+    /// <param name="other">The second cube.</param>
+    /// <returns>The Chebyshev distance between the two cubes.</returns>
+    /// <exception cref="InvalidOperationException">
+    ///     <see cref="DistanceChebyshev" /> is only intended for use via SQL translation as part of an EF Core LINQ query.
+    /// </exception>
+    public static double DistanceChebyshev(this NpgsqlCube cube, NpgsqlCube other)
+        => throw new InvalidOperationException(CoreStrings.FunctionOnClient(nameof(DistanceChebyshev)));
+
+    /// <summary>
+    ///     Computes the union of two cubes, producing the smallest cube that encloses both.
+    /// </summary>
+    /// <param name="cube">The first cube.</param>
+    /// <param name="other">The second cube.</param>
+    /// <returns>The smallest cube that encloses both input cubes.</returns>
+    /// <exception cref="InvalidOperationException">
+    ///     <see cref="Union" /> is only intended for use via SQL translation as part of an EF Core LINQ query.
+    /// </exception>
+    public static NpgsqlCube Union(this NpgsqlCube cube, NpgsqlCube other)
+        => throw new InvalidOperationException(CoreStrings.FunctionOnClient(nameof(Union)));
+
+    /// <summary>
+    ///     Computes the intersection of two cubes.
+    /// </summary>
+    /// <param name="cube">The first cube.</param>
+    /// <param name="other">The second cube.</param>
+    /// <returns>The intersection of the two cubes.</returns>
+    /// <exception cref="InvalidOperationException">
+    ///     <see cref="Intersect" /> is only intended for use via SQL translation as part of an EF Core LINQ query.
+    /// </exception>
+    public static NpgsqlCube Intersect(this NpgsqlCube cube, NpgsqlCube other)
+        => throw new InvalidOperationException(CoreStrings.FunctionOnClient(nameof(Intersect)));
+
+    /// <summary>
+    ///     Increases the size of a cube by a specified radius in at least the specified number of dimensions.
+    /// </summary>
+    /// <param name="cube">The cube to enlarge.</param>
+    /// <param name="radius">The amount by which to enlarge the cube (can be negative to shrink).</param>
+    /// <param name="dimensions">The number of dimensions to enlarge (optional, defaults to all dimensions).</param>
+    /// <returns>The enlarged (or shrunk) cube.</returns>
+    /// <remarks>
+    ///     If the specified number of dimensions is greater than the cube's current dimensions,
+    ///     the extra dimensions are added with the specified radius.
+    /// </remarks>
+    /// <exception cref="InvalidOperationException">
+    ///     <see cref="Enlarge" /> is only intended for use via SQL translation as part of an EF Core LINQ query.
+    /// </exception>
+    public static NpgsqlCube Enlarge(this NpgsqlCube cube, double radius, int dimensions)
+        => throw new InvalidOperationException(CoreStrings.FunctionOnClient(nameof(Enlarge)));
+}