Merge pull request #52 from Sergio0694/feature_cpuDNN-refactoring

Feature cpuDNN refactoring

Author: Sergio0694

NeuralNetwork.NET.Cuda/AssemblyInfo.cs

@@ -16,6 +16,8 @@ namespace NeuralNetworkNET.APIs.Structs
     [DebuggerDisplay("Entities: {Entities}, Length: {Length}, Ptr: {Ptr}")]
     public readonly struct Tensor
     {
+        #region Fields and parameters
+
         /// <summary>
         /// The <see cref="IntPtr"/> value to the allocated memory
         /// </summary>
@@ -51,6 +53,8 @@ public bool IsNull
             get => Ptr == IntPtr.Zero;
         }
 
+        #endregion
+
         /// <summary>
         /// Gets a null instance
         /// </summary>
@@ -109,6 +113,20 @@ public static unsafe void Reshape(float* p, int n, int chw, out Tensor tensor)
             tensor = new Tensor(ptr, n, chw);
         }
 
+        /// <summary>
+        /// Creates a new instance with the same shape as the input <see cref="Tensor"/>
+        /// </summary>
+        /// <param name="mask">The <see cref="Tensor"/> to use to copy the shape</param>
+        /// <param name="tensor">The output <see cref="Tensor"/></param>
+        public static void Like(in Tensor mask, out Tensor tensor) => New(mask.Entities, mask.Length, out tensor);
+
+        /// <summary>
+        /// Creates a new instance with the same shape as the input <see cref="Tensor"/> and all the values initializes to 0
+        /// </summary>
+        /// <param name="mask">The <see cref="Tensor"/> to use to copy the shape</param>
+        /// <param name="tensor">The output <see cref="Tensor"/></param>
+        public static void LikeZeroed(in Tensor mask, out Tensor tensor) => NewZeroed(mask.Entities, mask.Length, out tensor);
+
         /// <summary>
         /// Creates a new instance by copying the contents at the given memory location and reshaping it to the desired size
         /// </summary>
@@ -155,6 +173,34 @@ public static unsafe void From([NotNull] float[] v, int n, int chw, out Tensor t
 
         #region Tools
 
+        /// <summary>
+        /// Creates a new instance by wrapping the current memory area
+        /// </summary>
+        /// <param name="n">The height of the final matrix</param>
+        /// <param name="chw">The width of the final matrix</param>
+        /// <param name="tensor">The resulting instance</param>
+        [MethodImpl(MethodImplOptions.AggressiveInlining)]
+        public void Reshape(int n, int chw, out Tensor tensor)
+        {
+            if (n * chw != Size) throw new ArgumentException("Invalid input resized shape");
+            tensor = new Tensor(Ptr, n, chw);
+        }
+
+        /// <summary>
+        /// Checks whether or not the current instance has the same shape of the input <see cref="Tensor"/>
+        /// </summary>
+        /// <param name="tensor">The instance to compare</param>
+        [MethodImpl(MethodImplOptions.AggressiveInlining)]
+        public bool MatchShape(in Tensor tensor) => Entities == tensor.Entities && Length == tensor.Length;
+
+        /// <summary>
+        /// Checks whether or not the current instance has the same shape as the input arguments
+        /// </summary>
+        /// <param name="entities">The expected number of entities</param>
+        /// <param name="length">The expected length of each entity</param>
+        [MethodImpl(MethodImplOptions.AggressiveInlining)]
+        public bool MatchShape(int entities, int length) => Entities == entities && Length == length;
+
         /// <summary>
         /// Overwrites the contents of the current matrix with the input matrix
         /// </summary>
@@ -181,43 +227,36 @@ internal void Duplicate(out Tensor tensor)
         /// <summary>
         /// Copies the contents of the unmanaged array to a managed <see cref="Array"/>
         /// </summary>
+        /// <param name="keepAlive">Indicates whether or not to automatically dispose the current instance</param>
         [Pure, NotNull]
-        public float[] ToArray()
+        public float[] ToArray(bool keepAlive = true)
         {
             if (Ptr == IntPtr.Zero) return new float[0];
             float[] result = new float[Size];
             Marshal.Copy(Ptr, result, 0, Size);
+            if (!keepAlive) Free();
             return result;
         }
 
         /// <summary>
         /// Copies the contents of the unmanaged array to a managed 2D <see cref="Array"/>
         /// </summary>
+        /// <param name="keepAlive">Indicates whether or not to automatically dispose the current instance</param>
         [Pure, NotNull]
-        public unsafe float[,] ToArray2D()
+        public unsafe float[,] ToArray2D(bool keepAlive = true)
         {
             if (Ptr == IntPtr.Zero) return new float[0, 0];
             float[,] result = new float[Entities, Length];
             int size = sizeof(float) * Size;
             fixed (float* presult = result)
                 Buffer.MemoryCopy(this, presult, size, size);
+            if (!keepAlive) Free();
             return result;
         }
 
         #endregion
 
-        /// <summary>
-        /// Creates a new instance by wrapping the current memory area
-        /// </summary>
-        /// <param name="n">The height of the final matrix</param>
-        /// <param name="chw">The width of the final matrix</param>
-        /// <param name="tensor">The resulting instance</param>
-        [MethodImpl(MethodImplOptions.AggressiveInlining)]
-        public void Reshape(int n, int chw, out Tensor tensor)
-        {
-            if (n * chw != Size) throw new ArgumentException("Invalid input resized shape");
-            tensor = new Tensor(Ptr, n, chw);
-        }
+        #region Memory management
 
         /// <summary>
         /// Frees the memory associated with the current instance
@@ -237,8 +276,11 @@ public void TryFree()
 
         // Implicit pointer conversion
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
+        [SuppressMessage("ReSharper", "ImpureMethodCallOnReadonlyValueField")]
         public static unsafe implicit operator float*(in Tensor tensor) => (float*)tensor.Ptr.ToPointer();
 
+        #endregion
+
         #region Debug
 
         /// <summary>