Add Interfaces for proper planning

Author: dotchris90

src/NumSharp.Core/Interfaces/IShape.cs

@@ -0,0 +1,22 @@
+using NumSharp;
+using System;
+using System.Collections.Generic;
+
+namespace NumSharp.Core.Interfaces
+{
+    public interface IShape
+    {
+        int Size {get;}
+        int NDim {get;}
+        int TensorOrder {get;}
+        IReadOnlyList<int> DimOffset {get;}
+        IReadOnlyList<int> Shapes {get;}
+        int ReShape(params int[] dimensions);
+        int GetIndexInShape(params int[] select); 
+        int[] GetDimIndexOutShape(int select);
+        int UniShape {get;}
+        (int, int) BiShape {get;}
+        (int, int, int) TriShape {get;}
+        bool ChangeTensorOrder(int order);
+    }
+}

src/NumSharp.Core/Interfaces/IStorage.cs

@@ -0,0 +1,153 @@
+using NumSharp;
+using System;
+
+namespace NumSharp.Core.Interfaces
+{
+    /// <summary>
+    /// An abstract interface as design basis for the true Storage
+    ///
+    /// Responsible for :
+    ///
+    ///  - store data type, elements, Shape
+    ///  - offers methods for accessing elements depending on shape
+    ///  - offers methods for casting elements
+    ///  - offers methods for change tensor order
+    ///  - GetData always return reference object to the true storage
+    ///  - GetData<T> and SetData<T> change dtype and cast storage
+    ///  - CloneData always create a clone of storage and return this as reference object
+    ///  - CloneData<T> clone storage and cast this clone 
+    ///     
+    /// </summary>
+    public interface IStorage
+    {
+        /// <summary>
+        /// Data Type of stored elements
+        /// </summary>
+        /// <value>numpys equal dtype</value>
+        Type DType {get;}
+        /// <summary>
+        /// storage shape for outside representation
+        /// </summary>
+        /// <value>numpys equal shape</value>
+        IShape Shape {get;}
+        /// <summary>
+        /// column wise or row wise order
+        /// </summary>
+        /// <value>0 row wise, 1 column wise</value>
+        int TensorOrder {get;}
+        /// <summary>
+        /// Allocate memory by dtype, shape, tensororder (default column wise)
+        /// </summary>
+        /// <param name="dtype">storage data type</param>
+        /// <param name="shape">storage data shape</param>
+        /// <param name="tensorOrder">row or column wise</param>
+        void Allocate(Type dtype, Shape shape, int tensorOrder = 1);
+        /// <summary>
+        /// Allocate memory by Array and tensororder and deduce shape and dtype (default column wise)
+        /// </summary>
+        /// <param name="values">elements to store</param>
+        /// <param name="tensorOrder">row or column wise</param>
+        void Allocate(Array values, int tensorOrder = 1);
+        /// <summary>
+        /// Get Back Storage with Columnwise tensor Layout
+        /// By this method the layout is changed if layout is not columnwise
+        /// </summary>
+        /// <returns>reference to storage (transformed or not)</returns>
+        IStorage GetColumWiseStorage();
+        /// <summary>
+        /// Get Back Storage with row wise tensor Layout
+        /// By this method the layout is changed if layout is not row wise
+        /// </summary>
+        /// <returns>reference to storage (transformed or not)</returns>
+        IStorage GetRowWiseStorage();
+        /// <summary>
+        /// Get reference to internal data storage
+        /// </summary>
+        /// <returns>reference to internal storage as System.Array</returns>
+        Array GetData();
+        /// <summary>
+        /// Clone internal storage and get reference to it
+        /// </summary>
+        /// <returns>reference to cloned storage as System.Array</returns>
+        Array CloneData();
+        /// <summary>
+        /// Get reference to internal data storage and cast elements to new dtype
+        /// </summary>
+        /// <param name="dtype">new storage data type</param>
+        /// <returns>reference to internal (casted) storage as System.Array </returns>
+        Array GetData(Type dtype);
+        /// <summary>
+        /// Clone internal storage and cast elements to new dtype
+        /// </summary>
+        /// <param name="dtype">cloned storage data type</param>
+        /// <returns>reference to cloned storage as System.Array</returns>
+        Array CloneData(Type dtype);
+        /// <summary>
+        /// Get reference to internal data storage and cast elements to new dtype
+        /// </summary>
+        /// <typeparam name="T">new storage data type</typeparam>
+        /// <returns>reference to internal (casted) storage as T[]</returns>
+        T[] GetData<T>();
+        /// <summary>
+        /// Get all elements from cloned storage as T[] and cast dtype
+        /// </summary>
+        /// <typeparam name="T">cloned storgae dtype</typeparam>
+        /// <returns>reference to cloned storage as T[]</returns>
+        T[] CloneData<T>();
+        /// <summary>
+        /// Get single value from internal storage and do not cast dtype
+        /// </summary>
+        /// <param name="indexes">indexes</param>
+        /// <returns>element from internal storage</returns>
+        object GetData(params int[] indexes);
+        /// <summary>
+        /// Get single value from internal storage as type T and cast dtype to T
+        /// </summary>
+        /// <param name="indexes">indexes</param>
+        /// <typeparam name="T">new storage data type</typeparam>
+        /// <returns>element from internal storage</returns>
+        T GetData<T>(params int[] indexes);
+        /// <summary>
+        /// Set an array to internal storage and keep dtype
+        /// </summary>
+        /// <param name="values"></param>
+        void SetData(Array values);
+        /// <summary>
+        /// Set 1 single value to internal storage and keep dtype
+        /// </summary>
+        /// <param name="value"></param>
+        /// <param name="indexes"></param>
+        void SetData(object value, params int[] indexes);
+        /// <summary>
+        /// Set a 1D Array of type T to internal storage and cast dtype
+        /// </summary>
+        /// <param name="values"></param>
+        /// <typeparam name="T"></typeparam>
+        void SetData<T>(T[] values);
+        /// <summary>
+        /// Set a single value of type dtype to internal storage and cast storage
+        /// </summary>
+        /// <param name="value"></param>
+        /// <param name="indexes"></param>
+        /// <typeparam name="T"></typeparam>
+        void SetData<T>(T value, params int[] indexes);
+        /// <summary>
+        /// Set an Array to internal storage, cast it to new dtype and change dtype  
+        /// </summary>
+        /// <param name="values"></param>
+        /// <param name="dtype"></param>
+        void SetData(Array values, Type dtype);
+        /// <summary>
+        /// Change dtype of elements
+        /// </summary>
+        /// <param name="dtype">new storage data type</param>
+        /// <returns>sucess or not</returns>
+        bool ChangeDataType(Type dtype);   
+        /// <summary>
+        /// Cange layout to 0 row wise or 1 colum wise
+        /// </summary>
+        /// <param name="order">0 or 1</param>
+        /// <returns>success or not</returns>
+        bool SwitchTensorOrder(int order);
+    }
+}