Shape: added 'readonly' to methods to prevent local copying on calls

Author: Nucs

src/NumSharp.Core/View/Shape.Reshaping.cs

@@ -20,7 +20,7 @@ public partial struct Shape
         /// <exception cref="ArgumentException">If <paramref name="newShape"/>'s size == 0</exception>
         /// <param name="unsafe">When true, then guards are skipped.</param>
         [MethodImpl((MethodImplOptions)768)]
-        public Shape Reshape(Shape newShape, bool @unsafe = true)
+        public readonly Shape Reshape(Shape newShape, bool @unsafe = true)
         {
             if (IsBroadcasted)
             {
@@ -53,7 +53,7 @@ public Shape Reshape(Shape newShape, bool @unsafe = true)
         /// <exception cref="IncorrectShapeException">If shape's size mismatches current shape size.</exception>
         /// <exception cref="ArgumentException">If <paramref name="newShape"/>'s size == 0</exception>
         [MethodImpl((MethodImplOptions)768)]
-        private void _reshapeBroadcast(ref Shape newShape, bool @unsafe = true)
+        private readonly void _reshapeBroadcast(ref Shape newShape, bool @unsafe = true)
         {
             //handle -1 in reshape
             _inferMissingDimension(ref newShape);
@@ -75,7 +75,7 @@ private void _reshapeBroadcast(ref Shape newShape, bool @unsafe = true)
         }
 
         [SuppressMessage("ReSharper", "ParameterHidesMember")]
-        private void _inferMissingDimension(ref Shape shape)
+        private readonly void _inferMissingDimension(ref Shape shape)
         {
             var indexOfNegOne = -1;
             int product = 1;
@@ -148,7 +148,7 @@ private void _inferMissingDimension(ref Shape shape)
         /// <param name="axis"></param>
         /// <returns></returns>
         [SuppressMessage("ReSharper", "LocalVariableHidesMember")]
-        public Shape ExpandDimension(int axis)
+        public readonly Shape ExpandDimension(int axis)
         {
             Shape ret;
             if (IsScalar)

src/NumSharp.Core/View/Shape.Unmanaged.cs

@@ -16,7 +16,7 @@ public partial struct Shape
         /// <returns>The index in the memory block that refers to a specific value.</returns>
         /// <remarks>Handles sliced indices and broadcasting</remarks>
         [MethodImpl((MethodImplOptions)768)]
-        public unsafe int GetOffset(int* indices, int ndims)
+        public readonly unsafe int GetOffset(int* indices, int ndims)
         {
             int offset;
             if (!IsSliced)
@@ -116,7 +116,7 @@ public unsafe int GetOffset(int* indices, int ndims)
         /// <returns></returns>
         /// <remarks>Used for slicing, returned shape is the new shape of the slice and offset is the offset from current address.</remarks>
         [MethodImpl((MethodImplOptions)768)]
-        public unsafe (Shape Shape, int Offset) GetSubshape(int* dims, int ndims)
+        public readonly unsafe (Shape Shape, int Offset) GetSubshape(int* dims, int ndims)
         {
             if (ndims == 0)
                 return (this, 0);
@@ -215,7 +215,7 @@ public static unsafe void InferNegativeCoordinates(int[] dimensions, int* coords
         /// <returns>The index in the memory block that refers to a specific value.</returns>
         /// <remarks>Handles sliced indices and broadcasting</remarks>
         [MethodImpl((MethodImplOptions)768)]
-        private unsafe int GetOffset_broadcasted(int* indices, int ndims)
+        private readonly unsafe int GetOffset_broadcasted(int* indices, int ndims)
         {
             int offset;
             var vi = ViewInfo;
@@ -313,7 +313,7 @@ private unsafe int GetOffset_broadcasted(int* indices, int ndims)
         /// Note: to be used only inside of GetOffset()
         /// </summary>
         [MethodImpl((MethodImplOptions)768)]
-        private unsafe int GetOffset_IgnoreViewInfo(int* indices, int ndims)
+        private readonly unsafe int GetOffset_IgnoreViewInfo(int* indices, int ndims)
         {
             if (dimensions.Length == 0 && ndims == 1)
                 return indices[0];

src/NumSharp.Core/View/Shape.cs

@@ -24,7 +24,7 @@ public partial struct Shape : ICloneable, IEquatable<Shape>
         /// <summary>
         ///     True if the shape of this array was obtained by a slicing operation that caused the underlying data to be non-contiguous
         /// </summary>
-        public bool IsSliced
+        public readonly bool IsSliced
         {
             [MethodImpl(MethodImplOptions.AggressiveInlining)]
             get => ViewInfo != null;
@@ -33,7 +33,7 @@ public bool IsSliced
         /// <summary>
         ///     Does this Shape represents a non-sliced and non-broadcasted hence contagious unmanaged memory?
         /// </summary>
-        public bool IsContiguous
+        public readonly bool IsContiguous
         {
             [MethodImpl(MethodImplOptions.AggressiveInlining)]
             get => !IsSliced && !IsBroadcasted;
@@ -42,7 +42,7 @@ public bool IsContiguous
         /// <summary>
         ///     Is this Shape a recusive view? (deeper than 1 view)
         /// </summary>
-        public bool IsRecursive
+        public readonly bool IsRecursive
         {
             [MethodImpl(MethodImplOptions.AggressiveInlining)]
             get => ViewInfo != null && ViewInfo.ParentShape.IsEmpty == false;
@@ -64,7 +64,7 @@ public bool IsRecursive
         /// <summary>
         ///     Is this shape a broadcast and/or has modified strides?
         /// </summary>
-        public bool IsBroadcasted => BroadcastInfo != null;
+        public readonly bool IsBroadcasted => BroadcastInfo != null;
 
         /// <summary>
         ///     Is this shape a scalar? (<see cref="NDim"/>==0 && <see cref="size"/> == 1)
@@ -75,9 +75,9 @@ public bool IsRecursive
         /// True if the shape is not initialized.
         /// Note: A scalar shape is not empty.
         /// </summary>
-        public bool IsEmpty => _hashCode == 0;
+        public readonly bool IsEmpty => _hashCode == 0;
 
-        public char Order => layout;
+        public readonly char Order => layout;
 
         /// <summary>
         ///     Singleton instance of a <see cref="Shape"/> that represents a scalar.
@@ -160,19 +160,19 @@ public static Shape Matrix(int rows, int cols)
             return shape;
         }
 
-        public int NDim
+        public readonly int NDim
         {
             [MethodImpl(MethodImplOptions.AggressiveInlining)]
             get => dimensions.Length;
         }
 
-        public int[] Dimensions
+        public readonly int[] Dimensions
         {
             [MethodImpl(MethodImplOptions.AggressiveInlining)]
             get => dimensions;
         }
 
-        public int[] Strides
+        public readonly int[] Strides
         {
             [MethodImpl(MethodImplOptions.AggressiveInlining)]
             get => strides;
@@ -181,7 +181,7 @@ public int[] Strides
         /// <summary>
         ///     The linear size of this shape.
         /// </summary>
-        public int Size
+        public readonly int Size
         {
             [MethodImpl(MethodImplOptions.AggressiveInlining)]
             get => size;
@@ -346,7 +346,7 @@ public static Shape Empty(int ndim)
 
 
         [MethodImpl((MethodImplOptions)768)]
-        private void _computeStrides()
+        private readonly void _computeStrides()
         {
             if (dimensions.Length == 0)
                 return;
@@ -361,11 +361,11 @@ private void _computeStrides()
 
 
         [MethodImpl((MethodImplOptions)768)]
-        private void _computeStrides(int axis)
+        private readonly void _computeStrides(int axis)
         {
             if (dimensions.Length == 0)
                 return;
-
+            
             if (axis == 0)
                 strides[0] = strides[1] * dimensions[1];
             else
@@ -378,7 +378,7 @@ private void _computeStrides(int axis)
                 }
         }
 
-        public int this[int dim]
+        public readonly int this[int dim]
         {
             [MethodImpl(MethodImplOptions.AggressiveInlining)]
             get => dimensions[dim < 0 ? dimensions.Length + dim : dim];
@@ -393,7 +393,7 @@ public int this[int dim]
         /// <returns>The transformed offset.</returns>
         /// <remarks>Avoid using unless it is unclear if shape is sliced or not.</remarks>
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
-        public int TransformOffset(int offset)
+        public readonly int TransformOffset(int offset)
         {
             // ReSharper disable once ConvertIfStatementToReturnStatement
             if (ViewInfo == null && BroadcastInfo == null)
@@ -415,7 +415,7 @@ public int TransformOffset(int offset)
         /// <returns>The index in the memory block that refers to a specific value.</returns>
         /// <remarks>Handles sliced indices and broadcasting</remarks>
         [MethodImpl((MethodImplOptions)768)]
-        public int GetOffset(params int[] indices)
+        public readonly int GetOffset(params int[] indices)
         {
             int offset;
             if (!IsSliced)
@@ -513,7 +513,7 @@ public int GetOffset(params int[] indices)
         /// <returns>The index in the memory block that refers to a specific value.</returns>
         /// <remarks>Handles sliced indices and broadcasting</remarks>
         [MethodImpl((MethodImplOptions)768)]
-        internal int GetOffset_1D(int index)
+        internal readonly int GetOffset_1D(int index)
         {
             int offset;
             if (!IsSliced)
@@ -609,7 +609,7 @@ internal int GetOffset_1D(int index)
         /// Note: to be used only inside of GetOffset()
         /// </summary>
         [MethodImpl((MethodImplOptions)768)]
-        private int GetOffset_IgnoreViewInfo(params int[] indices)
+        private readonly int GetOffset_IgnoreViewInfo(params int[] indices)
         {
             if (dimensions.Length == 0 && indices.Length == 1)
                 return indices[0];
@@ -634,7 +634,7 @@ private int GetOffset_IgnoreViewInfo(params int[] indices)
         /// <returns>The index in the memory block that refers to a specific value.</returns>
         /// <remarks>Handles sliced indices and broadcasting</remarks>
         [MethodImpl((MethodImplOptions)768)]
-        private int GetOffset_broadcasted(params int[] indices)
+        private readonly int GetOffset_broadcasted(params int[] indices)
         {
             int offset;
             var vi = ViewInfo;
@@ -704,7 +704,7 @@ private int GetOffset_broadcasted(params int[] indices)
         /// <returns>The index in the memory block that refers to a specific value.</returns>
         /// <remarks>Handles sliced indices and broadcasting</remarks>
         [MethodImpl((MethodImplOptions)768)]
-        private int GetOffset_broadcasted_1D(int index)
+        private readonly int GetOffset_broadcasted_1D(int index)
         {
             int offset;
             var vi = ViewInfo;
@@ -775,7 +775,7 @@ private int GetOffset_broadcasted_1D(int index)
         /// <returns></returns>
         /// <remarks>Used for slicing, returned shape is the new shape of the slice and offset is the offset from current address.</remarks>
         [MethodImpl((MethodImplOptions)768)]
-        public (Shape Shape, int Offset) GetSubshape(params int[] indicies)
+        public readonly (Shape Shape, int Offset) GetSubshape(params int[] indicies)
         {
             if (indicies.Length == 0)
                 return (this, 0);
@@ -853,7 +853,7 @@ private int GetOffset_broadcasted_1D(int index)
         /// <param name="offset">the index if you would iterate from 0 to shape.size in row major order</param>
         /// <returns></returns>
         [MethodImpl((MethodImplOptions)768)]
-        public int[] GetCoordinates(int offset)
+        public readonly int[] GetCoordinates(int offset)
         {
             int[] coords = null;
 
@@ -903,7 +903,7 @@ public int[] GetCoordinates(int offset)
         /// <param name="offset">Is the index in the original array before it was sliced and/or reshaped</param>
         /// <remarks>Note: due to slicing the absolute indices (offset in memory) are different from what GetCoordinates would return, which are relative indices in the shape.</remarks>
         [MethodImpl((MethodImplOptions)768)]
-        public int[] GetCoordinatesFromAbsoluteIndex(int offset)
+        public readonly int[] GetCoordinatesFromAbsoluteIndex(int offset)
         {
             if (!IsSliced)
                 return GetCoordinates(offset);
@@ -1095,11 +1095,11 @@ internal void ComputeHashcode()
         #region Slicing support
 
         [MethodImpl((MethodImplOptions)768)]
-        public Shape Slice(string slicing_notation) =>
+        public readonly Shape Slice(string slicing_notation) =>
             this.Slice(NumSharp.Slice.ParseSlices(slicing_notation));
 
         [MethodImpl((MethodImplOptions)768)]
-        public Shape Slice(params Slice[] input_slices)
+        public readonly Shape Slice(params Slice[] input_slices)
         {
             if (IsEmpty)
                 throw new InvalidOperationException("Unable to slice an empty shape.");
@@ -1200,22 +1200,22 @@ public static implicit operator Shape((int, int, int, int, int, int) dims) =>
 
         #region Deconstructor
 
-        public void Deconstruct(out int dim1, out int dim2)
+        public readonly void Deconstruct(out int dim1, out int dim2)
         {
             var dims = this.dimensions;
             dim1 = dims[0];
             dim2 = dims[1];
         }
 
-        public void Deconstruct(out int dim1, out int dim2, out int dim3)
+        public readonly void Deconstruct(out int dim1, out int dim2, out int dim3)
         {
             var dims = this.dimensions;
             dim1 = dims[0];
             dim2 = dims[1];
             dim3 = dims[2];
         }
 
-        public void Deconstruct(out int dim1, out int dim2, out int dim3, out int dim4)
+        public readonly void Deconstruct(out int dim1, out int dim2, out int dim3, out int dim4)
         {
             var dims = this.dimensions;
             dim1 = dims[0];
@@ -1224,7 +1224,7 @@ public void Deconstruct(out int dim1, out int dim2, out int dim3, out int dim4)
             dim4 = dims[3];
         }
 
-        public void Deconstruct(out int dim1, out int dim2, out int dim3, out int dim4, out int dim5)
+        public readonly void Deconstruct(out int dim1, out int dim2, out int dim3, out int dim4, out int dim5)
         {
             var dims = this.dimensions;
             dim1 = dims[0];
@@ -1234,7 +1234,7 @@ public void Deconstruct(out int dim1, out int dim2, out int dim3, out int dim4,
             dim5 = dims[4];
         }
 
-        public void Deconstruct(out int dim1, out int dim2, out int dim3, out int dim4, out int dim5, out int dim6)
+        public readonly void Deconstruct(out int dim1, out int dim2, out int dim3, out int dim4, out int dim5, out int dim6)
         {
             var dims = this.dimensions;
             dim1 = dims[0];
@@ -1275,7 +1275,7 @@ public void Deconstruct(out int dim1, out int dim2, out int dim3, out int dim4,
             return !(a == b);
         }
 
-        public override bool Equals(object obj)
+        public override readonly bool Equals(object obj)
         {
             if (ReferenceEquals(null, obj))
             {
@@ -1293,7 +1293,7 @@ public override bool Equals(object obj)
         /// <summary>Indicates whether the current object is equal to another object of the same type.</summary>
         /// <param name="other">An object to compare with this object.</param>
         /// <returns>true if the current object is equal to the <paramref name="other">other</paramref> parameter; otherwise, false.</returns>
-        public bool Equals(Shape other)
+        public readonly bool Equals(Shape other)
         {
             if ((_hashCode == 0 && _hashCode == other._hashCode) || dimensions == null && other.dimensions == null) //they are empty.
                 return true;
@@ -1361,14 +1361,14 @@ public override string ToString() =>
 
         /// <summary>Creates a new object that is a copy of the current instance.</summary>
         /// <returns>A new object that is a copy of this instance.</returns>
-        object ICloneable.Clone() =>
+        readonly object ICloneable.Clone() =>
             Clone(true, false, false);
 
         /// <summary>
         ///     Creates a complete copy of this Shape.
         /// </summary>
         /// <param name="deep">Should make a complete deep clone or a shallow if false.</param>
-        public Shape Clone(bool deep = true, bool unview = false, bool unbroadcast = false)
+        public readonly Shape Clone(bool deep = true, bool unview = false, bool unbroadcast = false)
         {
             if (IsEmpty)
                 return default;
@@ -1406,7 +1406,7 @@ public Shape Clone(bool deep = true, bool unview = false, bool unbroadcast = fal
         ///     Cleans ViewInfo and returns a newly constructed.
         /// </summary>
         /// <returns></returns>
-        public Shape Clean()
+        public readonly Shape Clean()
         {
             if (IsScalar)
                 return NewScalar();