[release/10.0-preview4] Rewrite of System.Numerics.Tensors to allow for more code sharing, various correctness fixes, and stability improvements

src/libraries/System.Numerics.Tensors/src/Resources/Strings.resx

@@ -201,8 +201,8 @@
   <data name="ThrowArgument_SetSliceNoRange" xml:space="preserve">
     <value>When no ranges are specified the values tensor must be equal in size as the input tensor.</value>
   </data>
-  <data name="ThrowArgument_LengthsNotBroadcastCompatible" xml:space="preserve">
-    <value>Lengths are not broadcast compatible.</value>
+  <data name="ThrowArgument_LengthsNotCompatible" xml:space="preserve">
+    <value>Lengths are not compatible with each other.</value>
   </data>
   <data name="ThrowArgument_SplitNotSplitEvenly" xml:space="preserve">
     <value>The number of splits must perfectly divide the dimension.</value>
@@ -240,4 +240,7 @@
   <data name="Arithmetic_NaN" xml:space="preserve">
     <value>Function does not accept floating point Not-a-Number values.</value>
   </data>
-</root>
+  <data name="ThrowArgument_LengthIsNonZeroForNullReference" xml:space="preserve">
+    <value>The provided length is non zero while the data reference is null.</value>
+  </data>
+</root>

src/libraries/System.Numerics.Tensors/src/System.Numerics.Tensors.csproj

@@ -19,20 +19,8 @@
   </ItemGroup>
 
   <ItemGroup Condition="'$(TargetFrameworkIdentifier)' == '.NETCoreApp'">
-    <Compile Include="System\Numerics\Tensors\netcore\TensorShape.cs" />
-    <Compile Include="System\Numerics\Tensors\netcore\TensorHelpers.cs" />
-    <Compile Include="System\Numerics\Tensors\netcore\TensorExtensions.cs" />
-    <Compile Include="System\Numerics\Tensors\netcore\Tensor.Factory.cs" />
-    <Compile Include="System\Numerics\Tensors\netcore\Tensor.cs" />
-    <Compile Include="System\Numerics\Tensors\netcore\ITensor.cs" />
-    <Compile Include="System\Numerics\Tensors\netcore\IReadOnlyTensor.cs" />
-    <Compile Include="System\Numerics\Tensors\netcore\TensorSpanDebugView.cs" />
-    <Compile Include="System\Numerics\Tensors\netcore\ReadOnlyTensorSpan.cs" />
-    <Compile Include="System\Numerics\Tensors\netcore\TensorSpanHelpers.cs" />
-    <Compile Include="System\Numerics\Tensors\netcore\TensorSpanHelpers.T.cs" />
-    <Compile Include="System\Numerics\Tensors\netcore\TensorSpan.cs" />
-    <Compile Include="System\NIndex.cs" />
-    <Compile Include="System\NRange.cs" />
+    <Compile Include="System\Buffers\NIndex.cs" />
+    <Compile Include="System\Buffers\NRange.cs" />
     <Compile Include="System\Numerics\Tensors\netcore\Common\TensorPrimitives.IAggregationOperator.cs" />
     <Compile Include="System\Numerics\Tensors\netcore\Common\TensorPrimitives.IBinaryOperator.cs" />
     <Compile Include="System\Numerics\Tensors\netcore\Common\TensorPrimitives.IBooleanUnaryOperator.cs" />
@@ -44,6 +32,14 @@
     <Compile Include="System\Numerics\Tensors\netcore\Common\TensorPrimitives.IUnaryOneToFourOperator.cs" />
     <Compile Include="System\Numerics\Tensors\netcore\Common\TensorPrimitives.IUnaryOperator.cs" />
     <Compile Include="System\Numerics\Tensors\netcore\Common\TensorPrimitives.IUnaryTwoToOneOperator.cs" />
+    <Compile Include="System\Numerics\Tensors\netcore\IReadOnlyTensor.cs" />
+    <Compile Include="System\Numerics\Tensors\netcore\IReadOnlyTensor_1.cs" />
+    <Compile Include="System\Numerics\Tensors\netcore\ITensor.cs" />
+    <Compile Include="System\Numerics\Tensors\netcore\ITensor_1.cs" />
+    <Compile Include="System\Numerics\Tensors\netcore\ReadOnlyTensorSpan_1.cs" />
+    <Compile Include="System\Numerics\Tensors\netcore\Tensor.cs" />
+    <Compile Include="System\Numerics\Tensors\netcore\Tensor_1.cs" />
+    <Compile Include="System\Numerics\Tensors\netcore\TensorOperation.cs" />
     <Compile Include="System\Numerics\Tensors\netcore\TensorPrimitives.Abs.cs" />
     <Compile Include="System\Numerics\Tensors\netcore\TensorPrimitives.Acos.cs" />
     <Compile Include="System\Numerics\Tensors\netcore\TensorPrimitives.Acosh.cs" />
@@ -170,6 +166,9 @@
     <Compile Include="System\Numerics\Tensors\netcore\TensorPrimitives.TrailingZeroCount.cs" />
     <Compile Include="System\Numerics\Tensors\netcore\TensorPrimitives.Truncate.cs" />
     <Compile Include="System\Numerics\Tensors\netcore\TensorPrimitives.Xor.cs" />
+    <Compile Include="System\Numerics\Tensors\netcore\TensorShape.cs" />
+    <Compile Include="System\Numerics\Tensors\netcore\TensorSpan.cs" />
+    <Compile Include="System\Numerics\Tensors\netcore\TensorSpanDebugView.cs" />
   </ItemGroup>
 
   <ItemGroup Condition="$([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)', 'net9.0'))">

src/libraries/System.Numerics.Tensors/src/System/Numerics/Tensors/netcore/IReadOnlyTensor.cs

@@ -2,181 +2,50 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System.Buffers;
-using System.Collections.Generic;
 using System.Diagnostics.CodeAnalysis;
 
 namespace System.Numerics.Tensors
 {
-
-    /// <summary>
-    /// Represents a read-only tensor.
-    /// </summary>
+    /// <summary>Represents a read-only tensor.</summary>
     [Experimental(Experimentals.TensorTDiagId, UrlFormat = Experimentals.SharedUrlFormat)]
     public interface IReadOnlyTensor
     {
-        /// <summary>
-        /// Gets a value that indicates whether the collection is currently empty.
-        /// </summary>
+        /// <summary>Gets the specified element of the tensor.</summary>
+        /// <param name="indexes">The index of the element for which to get.</param>
+        /// <returns>The element that exists at <paramref name="indexes" />.</returns>
+        /// <exception cref="ArgumentOutOfRangeException">
+        ///   Thrown when one of the following conditions is met:
+        ///   * <paramref name="indexes" /> does not contain <see cref="Rank" /> elements
+        ///   * <paramref name="indexes" /> contains an element that is negative or greater than or equal to the corresponding dimension length
+        /// </exception>
+        object? this[params scoped ReadOnlySpan<nint> indexes] { get; }
+
+        /// <inheritdoc cref="this[ReadOnlySpan{nint}]" />
+        object? this[params scoped ReadOnlySpan<NIndex> indexes] { get; }
+
+        /// <summary>Gets the total number of items in the tensor.</summary>
+        nint FlattenedLength { get; }
+
+        /// <summary>Gets a value indicating whether this tensor is empty.</summary>
+        /// <value><see langword="true"/> if this tensor is empty; otherwise, <see langword="false"/>.</value>
         bool IsEmpty { get; }
 
-        /// <summary>
-        /// Gets a value that indicates whether the underlying buffer is pinned.
-        /// </summary>
+        /// <summary>Gets a value that indicates whether the underlying buffer is pinned.</summary>
         bool IsPinned { get; }
 
-        /// <summary>
-        /// Gets the number of elements in the tensor.
-        /// </summary>
-        nint FlattenedLength { get; }
-
-        /// <summary>
-        /// Gets the number of dimensions in the tensor.
-        /// </summary>
-        int Rank { get; }
-
-        /// <summary>
-        /// Gets the length of each dimension in the tensor.
-        /// </summary>
+        /// <summary>Gets the length of each dimension in the tensor.</summary>
         [UnscopedRef]
         ReadOnlySpan<nint> Lengths { get; }
 
-        /// <summary>
-        /// Gets the stride of each dimension in the tensor.
-        /// </summary>
+        /// <summary>Gets the rank, or number of dimensions, in the tensor.</summary>
+        int Rank { get; }
+
+        /// <summary>Gets the stride of each dimension in the tensor.</summary>
         [UnscopedRef]
         ReadOnlySpan<nint> Strides { get; }
 
-        /// <summary>
-        /// Gets the value at the specified indexes.
-        /// </summary>
-        /// <param name="indexes">The indexes to be used.</param>
-        object this[params scoped ReadOnlySpan<nint> indexes] { get; }
-
-        /// <summary>
-        /// Gets the value at the specified indexes.
-        /// </summary>
-        /// <param name="indexes">The indexes to be used.</param>
-        object this[params scoped ReadOnlySpan<NIndex> indexes] { get; }
-
-        /// <summary>
-        /// Pins and gets a <see cref="MemoryHandle"/> to the backing memory.
-        /// </summary>
+        /// <summary>Pins and gets a <see cref="MemoryHandle"/> to the backing memory.</summary>
         /// <returns><see cref="MemoryHandle"/></returns>
         MemoryHandle GetPinnedHandle();
     }
-
-    /// <summary>
-    /// Represents a read-only tensor.
-    /// </summary>
-    /// <typeparam name="TSelf">The type that implements this interface.</typeparam>
-    /// <typeparam name="T">The element type.</typeparam>
-    [Experimental(Experimentals.TensorTDiagId, UrlFormat = Experimentals.SharedUrlFormat)]
-    public interface IReadOnlyTensor<TSelf, T> : IReadOnlyTensor, IEnumerable<T>
-        where TSelf : IReadOnlyTensor<TSelf, T>
-    {
-        /// <summary>
-        /// Gets an empty tensor.
-        /// </summary>
-        static abstract TSelf? Empty { get; }
-
-        /// <summary>
-        /// Gets the value at the specified indexes.
-        /// </summary>
-        /// <param name="indexes">The indexes to be used.</param>
-        new T this[params scoped ReadOnlySpan<nint> indexes] { get; }
-
-        /// <summary>
-        /// Gets the value at the specified indexes.
-        /// </summary>
-        /// <param name="indexes">The indexes to be used.</param>
-        new T this[params scoped ReadOnlySpan<NIndex> indexes] { get; }
-
-        /// <summary>
-        /// Gets the values at the specified ranges.
-        /// </summary>
-        /// <param name="ranges">The ranges to be used.</param>
-        TSelf this[params scoped ReadOnlySpan<NRange> ranges] { get; }
-
-        /// <summary>
-        /// Creates a read-only tensor span for the entire underlying buffer.
-        /// </summary>
-        /// <returns>The converted <see cref="ReadOnlyTensorSpan{T}"/>.</returns>
-        ReadOnlyTensorSpan<T> AsReadOnlyTensorSpan();
-
-        /// <summary>
-        /// Creates a read-only tensor span for the specified start indexes.
-        /// </summary>
-        /// <param name="start">The start locations to be used.</param>
-        /// <returns>The converted <see cref="ReadOnlyTensorSpan{T}"/>.</returns>
-        ReadOnlyTensorSpan<T> AsReadOnlyTensorSpan(params scoped ReadOnlySpan<nint> start);
-
-        /// <summary>
-        /// Creates a read-only tensor span for the specified start indexes.
-        /// </summary>
-        /// <param name="startIndex">The started indexes to be used.</param>
-        /// <returns>The converted <see cref="ReadOnlyTensorSpan{T}"/>.</returns>
-        ReadOnlyTensorSpan<T> AsReadOnlyTensorSpan(params scoped ReadOnlySpan<NIndex> startIndex);
-
-        /// <summary>
-        /// Creates a read-only tensor span for the specified ranges.
-        /// </summary>
-        /// <param name="range">The ranges to be used.</param>
-        /// <returns>The converted <see cref="ReadOnlyTensorSpan{T}"/>.</returns>
-        ReadOnlyTensorSpan<T> AsReadOnlyTensorSpan(params scoped ReadOnlySpan<NRange> range);
-
-        /// <summary>
-        /// Copies the tensor to the specified destination. The destination tensor must be equal to or larger than the source tensor.
-        /// </summary>
-        /// <param name="destination">The destination span where the data should be copied to.</param>
-        void CopyTo(scoped TensorSpan<T> destination);
-
-        /// <summary>
-        /// Flattens the tensor to the specified destination. The destination span must be equal to or larger than the number of elements in the source tensor.
-        /// </summary>
-        /// <param name="destination">The destination span where the data should be flattened to.</param>
-        void FlattenTo(scoped Span<T> destination);
-
-        /// <summary>
-        /// Returns a reference to the 0th element of the tensor. If the tensor is empty, returns <see langword="null"/>.
-        /// </summary>
-        /// <remarks>
-        /// This method can be used for pinning and is required to support the use of the tensor within a fixed statement.
-        /// </remarks>
-        ref readonly T GetPinnableReference();
-
-        /// <summary>
-        /// Slices the tensor using the specified start indexes.
-        /// </summary>
-        /// <param name="start">The start locations to be used.</param>
-        /// <returns>The sliced tensor.</returns>
-        TSelf Slice(params scoped ReadOnlySpan<nint> start);
-
-        /// <summary>
-        /// Slices the tensor using the specified start indexes.
-        /// </summary>
-        /// <param name="startIndex">The start indexes to be used.</param>
-        /// <returns>The sliced tensor.</returns>
-        TSelf Slice(params scoped ReadOnlySpan<NIndex> startIndex);
-
-        /// <summary>
-        /// Slices the tensor using the specified ranges.
-        /// </summary>
-        /// <param name="range">The ranges to be used.</param>
-        /// <returns>The sliced tensor.</returns>
-        TSelf Slice(params scoped ReadOnlySpan<NRange> range);
-
-        /// <summary>
-        /// Tries to copy the tensor to the specified destination. The destination tensor must be equal to or larger than the source tensor.
-        /// </summary>
-        /// <param name="destination">The destination span where the data should be copied to.</param>
-        /// <returns><see langword="true" /> if the copy succeeded, <see langword="false" /> otherwise.</returns>
-        bool TryCopyTo(scoped TensorSpan<T> destination);
-
-        /// <summary>
-        /// Tries to flatten the tensor to the specified destination. The destination span must be equal to or larger than the number of elements in the source tensor.
-        /// </summary>
-        /// <param name="destination">The destination span where the data should be flattened to.</param>
-        /// <returns><see langword="true" /> if the flatten succeeded, <see langword="false" /> otherwise.</returns>
-        bool TryFlattenTo(scoped Span<T> destination);
-    }
 }