Refactor ndarray constructor

This commit refactors the awkward constructor factory interface and
should ensure better performance on V8 due to having a single
object "shape", rather than many shapes stemming from multiple
constructors.

Author: kgryte

lib/node_modules/@stdlib/ndarray/ctor/README.md

@@ -1,23 +1,31 @@
 
-{{alias}}( dtype, ndims[, options] )
-    Returns an ndarray constructor.
+{{alias}}( dtype, buffer, shape, strides, offset, order[, options] )
+    Returns an ndarray.
 
     Parameters
     ----------
     dtype: string
         Underlying data type.
 
-    ndims: integer
-        Number of dimensions.
+    buffer: ArrayLikeObject|TypedArray|Buffer
+        Data buffer.
+
+    shape: ArrayLikeObject
+        Array shape.
+
+    strides: ArrayLikeObject
+        Array strides.
+
+    offset: integer
+        Index offset.
+
+    order: string
+        Specifies whether an array is row-major (C-style) or column-major
+        (Fortran-style).
 
     options: Object (optional)
         Options.
 
-    options.codegen: boolean (optional)
-        Boolean indicating whether to use code generation. Code generation can
-        boost performance, but may be problematic in browser contexts enforcing
-        a strict content security policy (CSP). Default: true.
-
     options.mode: string (optional)
         Specifies how to handle indices which exceed array dimensions. If equal
         to 'throw', an ndarray instance throws an error when an index exceeds
@@ -39,88 +47,76 @@
 
     Returns
     -------
-    ctor: Function
-        ndarray constructor.
+    ndarray: ndarray
+        ndarray instance.
 
-    ctor.BYTES_PER_ELEMENT: integer
-        Size (in bytes) of each array element (if known).
-
-    ctor.dtype: string
-        Underlying data type.
-
-    ctor.ndims: integer
-        Number of dimensions.
-
-    ctor.prototype.byteLength: integer
+    ndarray.prototype.byteLength: integer
         Size (in bytes) of the array (if known).
 
-    ctor.prototype.BYTES_PER_ELEMENT: integer
+    ndarray.prototype.BYTES_PER_ELEMENT: integer
         Size (in bytes) of each array element (if known).
 
-    ctor.prototype.data: ArrayLikeObject|TypedArray|Buffer
+    ndarray.prototype.data: ArrayLikeObject|TypedArray|Buffer
         Pointer to the underlying data buffer.
 
-    ctor.prototype.dtype: string
+    ndarray.prototype.dtype: string
         Underlying data type.
 
-    ctor.prototype.flags: Object
+    ndarray.prototype.flags: Object
         Information about the memory layout of the array.
 
-    ctor.prototype.length: integer
+    ndarray.prototype.length: integer
         Length of the array (i.e., number of elements).
 
-    ctor.prototype.ndims: integer
+    ndarray.prototype.ndims: integer
         Number of dimensions.
 
-    ctor.prototype.offset: integer
+    ndarray.prototype.offset: integer
         Index offset which specifies the buffer index at which to start
         iterating over array elements.
 
-    ctor.prototype.order: string
+    ndarray.prototype.order: string
         Array order. The array order is either row-major (C-style) or column-
         major (Fortran-style).
 
-    ctor.prototype.shape: Array
+    ndarray.prototype.shape: Array
         Array shape.
 
-    ctor.prototype.strides: Array
+    ndarray.prototype.strides: Array
         Index strides which specify how to access data along corresponding array
         dimensions.
 
-    ctor.prototype.get: Function
+    ndarray.prototype.get: Function
         Returns an array element specified according to provided subscripts. The
         number of provided subscripts should equal the number of dimensions.
 
-    ctor.prototype.iget: Function
+    ndarray.prototype.iget: Function
         Returns an array element located at a specified linear index.
 
-    ctor.prototype.set: Function
+    ndarray.prototype.set: Function
         Sets an array element specified according to provided subscripts. The
         number of provided subscripts should equal the number of dimensions.
 
-    ctor.prototype.iset: Function
+    ndarray.prototype.iset: Function
         Sets an array element located at a specified linear index.
 
-    ctor.prototype.toString: Function
+    ndarray.prototype.toString: Function
         Serializes an ndarray as a string. This method does **not** serialize
         data outside of the buffer region defined by the array configuration.
 
-    ctor.prototype.toJSON: Function
+    ndarray.prototype.toJSON: Function
         Serializes an ndarray as a JSON object. This method does **not**
         serialize data outside of the buffer region defined by the array
         configuration.
 
     Examples
     --------
-    > var ctor = {{alias}}( 'generic', 2 )
-    <Function>
-
-    // To create a new instance...
+    // Create a new instance...
     > var b = [ 1.0, 2.0, 3.0, 4.0 ]; // underlying data buffer
     > var d = [ 2, 2 ]; // shape
     > var s = [ 2, 1 ]; // strides
     > var o = 0; // index offset
-    > var arr = ctor( b, d, s, o, 'row-major' )
+    > var arr = {{alias}}( 'generic', b, d, s, o, 'row-major' )
     <ndarray>
 
     // Get an element using subscripts:

lib/node_modules/@stdlib/ndarray/ctor/benchmark/benchmark.js

@@ -16,15 +16,10 @@
 * limitations under the License.
 */
 
-/* eslint-disable stdlib/return-annotations-quote-props */
-
 'use strict';
 
 var Float32Array = require( '@stdlib/array/float32' );
-var ctor = require( './../lib' );
-
-// Create an ndarray constructor for a 4-dimensional array containing single-precision floating-point numbers:
-var ndarray = ctor( 'float32', 4 );
+var ndarray = require( './../lib' );
 
 // Create a data buffer:
 var buffer = new Float32Array( (3*3*3*3) + 100 );
@@ -42,7 +37,7 @@ var offset = 4;
 var order = 'row-major'; // C-style
 
 // Create a new ndarray:
-var arr = ndarray( buffer, shape, strides, offset, order );
+var arr = ndarray( 'float32', buffer, shape, strides, offset, order );
 
 // Retrieve an array value:
 var v = arr.get( 1, 2, 1, 2 );
@@ -59,8 +54,8 @@ console.log( v );
 
 // Serialize the array as a string:
 console.log( arr.toString() );
-// => ndarray( new Float32Array( [ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 10, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 ] ), [ 3, 3, 3, 3 ], [ 27, 9, 3, 1 ], 0, 'row-major' )
+// => "ndarray( 'float32', new Float32Array( [ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 10, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 ] ), [ 3, 3, 3, 3 ], [ 27, 9, 3, 1 ], 0, 'row-major' )"
 
 // Serialize the array as JSON:
 console.log( JSON.stringify( arr.toJSON() ) );
-// => {"type":"ndarray","dtype":"float32","flags":{},"order":"row-major","shape":[3,3,3,3],"strides":[27,9,3,1],"data":[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,10,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]}
+// => '{"type":"ndarray","dtype":"float32","flags":{},"order":"row-major","shape":[3,3,3,3],"strides":[27,9,3,1],"data":[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,10,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]}'