Add read-only option support and add TODOs

kgryte · kgryte · commit 6555bc0ed06e · 2022-01-25T22:58:14.000-08:00
diff --git a/lib/node_modules/@stdlib/ndarray/array/README.md b/lib/node_modules/@stdlib/ndarray/array/README.md
@@ -79,11 +79,11 @@ arr = array( array( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ) );
 
 The function accepts the following `options`:
 
--   `buffer`: data source. If provided along with a `buffer` argument, the argument takes precedence.
+-   **buffer**: data source. If provided along with a `buffer` argument, the argument takes precedence.
 
--   `dtype`: underlying storage [data type][@stdlib/ndarray/dtypes]. If not specified and a data source is provided, the data type is inferred from the provided data source. If an input data source is not of the same type, this option specifies the data type to which to cast the input data. For non-[`ndarray`][@stdlib/ndarray/ctor] generic array data sources, the function casts generic array data elements to the default data type. In order to prevent this cast, the `dtype` option **must** be explicitly set to `'generic'`. Any time a cast is required, the `copy` option is set to `true`, as memory must be copied from the data source to an output data buffer. Default: `'float64'`.
+-   **dtype**: underlying storage [data type][@stdlib/ndarray/dtypes]. If not specified and a data source is provided, the data type is inferred from the provided data source. If an input data source is not of the same type, this option specifies the data type to which to cast the input data. For non-[`ndarray`][@stdlib/ndarray/ctor] generic array data sources, the function casts generic array data elements to the default data type. In order to prevent this cast, the `dtype` option **must** be explicitly set to `'generic'`. Any time a cast is required, the `copy` option is set to `true`, as memory must be copied from the data source to an output data buffer. Default: `'float64'`.
 
--   `order`: specifies the memory layout of the data source as either row-major (C-style) or column-major (Fortran-style). The option may be one of the following values:
+-   **order**: specifies the memory layout of the data source as either row-major (C-style) or column-major (Fortran-style). The option may be one of the following values:
 
     -   `row-major`: the order of the returned array is row-major.
     -   `column-major`: the order of the returned array is column-major.
@@ -92,15 +92,15 @@ The function accepts the following `options`:
 
     Note that specifying an order which differs from the order of a provided data source does **not** entail a conversion from one memory layout to another. In short, this option is descriptive, not prescriptive. Default: `'row-major'`.
 
--   `shape`: array shape (dimensions). If a shape is not specified, the function attempts to infer a shape based on a provided data source. For example, if provided a nested array, the function resolves nested array dimensions. If provided a multidimensional array data source, the function uses the array's associated shape. For most use cases, such inference suffices. For the remaining use cases, specifying a shape is necessary. For example, provide a shape to create a multidimensional array view over a linear data buffer, ignoring any existing shape meta data associated with a provided data source.
+-   **shape**: array shape (dimensions). If a shape is not specified, the function attempts to infer a shape based on a provided data source. For example, if provided a nested array, the function resolves nested array dimensions. If provided a multidimensional array data source, the function uses the array's associated shape. For most use cases, such inference suffices. For the remaining use cases, specifying a shape is necessary. For example, provide a shape to create a multidimensional array view over a linear data buffer, ignoring any existing shape meta data associated with a provided data source.
 
--   `flatten`: `boolean` indicating whether to automatically flatten generic array data sources. If an array shape is not specified, the shape is inferred from the dimensions of nested arrays prior to flattening. If a use case requires partial flattening, partially flatten **prior** to invoking this function and set the option value to `false` to prevent further flattening during invocation. Default: `true`.
+-   **flatten**: `boolean` indicating whether to automatically flatten generic array data sources. If an array shape is not specified, the shape is inferred from the dimensions of nested arrays prior to flattening. If a use case requires partial flattening, partially flatten **prior** to invoking this function and set the option value to `false` to prevent further flattening during invocation. Default: `true`.
 
--   `copy`: `boolean` indicating whether to (shallow) copy source data to a new data buffer. The function does **not** perform a deep copy. To prevent undesired shared changes in state for generic arrays containing objects, perform a deep copy **prior** to invoking this function. Default: `false`.
+-   **copy**: `boolean` indicating whether to (shallow) copy source data to a new data buffer. The function does **not** perform a deep copy. To prevent undesired shared changes in state for generic arrays containing objects, perform a deep copy **prior** to invoking this function. Default: `false`.
 
--   `ndmin`: specifies the minimum number of dimensions. If an array shape has fewer dimensions than required by `ndmin`, the function **prepends** singleton dimensions to the array shape in order to satisfy the dimensions requirement. Default: `0`.
+-   **ndmin**: specifies the minimum number of dimensions. If an array shape has fewer dimensions than required by `ndmin`, the function **prepends** singleton dimensions to the array shape in order to satisfy the dimensions requirement. Default: `0`.
 
--   `casting`: specifies the casting rule used to determine acceptable casts. The option may be one of the following values:
+-   **casting**: specifies the casting rule used to determine acceptable casts. The option may be one of the following values:
 
     -   `none`: only allow casting between identical types.
     -   `equiv`: allow casting between identical and byte swapped types.
@@ -110,15 +110,17 @@ The function accepts the following `options`:
 
     Default: `'safe'`.
 
--   `mode`: specifies how to handle indices which exceed array dimensions.
+-   **mode**: specifies how to handle indices which exceed array dimensions.
 
     -   `throw`: specifies that an [`ndarray`][@stdlib/ndarray/ctor] instance should throw an error when an index exceeds array dimensions.
     -   `wrap`: specifies that an [`ndarray`][@stdlib/ndarray/ctor] instance should wrap around an index exceeding array dimensions using modulo arithmetic.
     -   `clamp`: specifies that an [`ndarray`][@stdlib/ndarray/ctor] instance should set an index exceeding array dimensions to either `0` (minimum index) or the maximum index.
 
     Default: `'throw'`.
 
--   `submode`: a mode array which specifies for each dimension how to handle subscripts which exceed array dimensions. If provided fewer modes than dimensions, the function recycles modes using modulo arithmetic. Default: `[ options.mode ]`.
+-   **submode**: a mode array which specifies for each dimension how to handle subscripts which exceed array dimensions. If provided fewer modes than dimensions, the function recycles modes using modulo arithmetic. Default: `[ options.mode ]`.
+
+-   **readonly**: `boolean` indicating whether an [`ndarray`][@stdlib/ndarray/ctor] instance should be **read-only**. Default: `false`.
 
 By default, an [`ndarray`][@stdlib/ndarray/ctor] instance **throws** when provided an index which exceeds array dimensions. To support alternative indexing behavior, set the `mode` option, which will affect all public methods for getting and setting array elements.
 
diff --git a/lib/node_modules/@stdlib/ndarray/array/docs/repl.txt b/lib/node_modules/@stdlib/ndarray/array/docs/repl.txt
@@ -122,6 +122,9 @@
 
         Default: [ options.mode ].
 
+    options.readonly: boolean (optional)
+        Boolean indicating whether an array should be read-only. Default: false.
+
     Returns
     -------
     out: ndarray
diff --git a/lib/node_modules/@stdlib/ndarray/array/docs/types/index.d.ts b/lib/node_modules/@stdlib/ndarray/array/docs/types/index.d.ts
@@ -19,11 +19,9 @@
 // TypeScript Version: 2.0
 
 /// <reference types="@stdlib/types"/>
-/// <reference types="node"/>
 
-import { Buffer } from 'buffer';
-import { ArrayLike, TypedArray } from '@stdlib/types/array';
-import { DataType, ndarray, Mode, Order } from '@stdlib/types/ndarray';
+import { ArrayLike } from '@stdlib/types/array';
+import { DataType, ndarray, Mode, Order, Shape } from '@stdlib/types/ndarray';
 
 /**
 * Interface defining function options.
@@ -42,7 +40,7 @@ interface Options {
 	/**
 	* Array shape.
 	*/
-	shape?: ArrayLike<number>;
+	shape?: Shape;
 
 	/**
 	* Specifies how to handle indices which exceed array dimensions (default: 'throw').
@@ -73,12 +71,12 @@ interface Options {
 	* Casting rule used to determine what constitutes an acceptable cast (default: 'safe').
 	*/
 	casting?: string;
-}
 
-/**
-* Array or typed array.
-*/
-type ArrayOrBufferOrTypedArray = Array<any> | TypedArray | Buffer | null;
+	/**
+	* Boolean indicating if an array should be read-only (default: false).
+	*/
+	readonly?: boolean;
+}
 
 /**
 * Returns a multidimensional array.
@@ -94,6 +92,7 @@ type ArrayOrBufferOrTypedArray = Array<any> | TypedArray | Buffer | null;
 * @param options.flatten - boolean indicating whether to automatically flatten generic array data sources (default: true)
 * @param options.ndmin - minimum number of dimensions (default: 0)
 * @param options.casting - casting rule used to determine what constitutes an acceptable cast (default: 'safe')
+* @param options.readonly - boolean indicating whether an array should be read-only
 * @throws must provide valid options
 * @throws must provide either an array shape, data source, or both
 * @throws invalid cast
@@ -130,6 +129,7 @@ declare function array( options: Options ): ndarray;
 * @param options.flatten - boolean indicating whether to automatically flatten generic array data sources (default: true)
 * @param options.ndmin - minimum number of dimensions (default: 0)
 * @param options.casting - casting rule used to determine what constitutes an acceptable cast (default: 'safe')
+* @param options.readonly - boolean indicating whether an array should be read-only
 * @throws must provide valid options
 * @throws must provide either an array shape, data source, or both
 * @throws invalid cast
@@ -168,7 +168,7 @@ declare function array( options: Options ): ndarray;
 * var v = arr.get( 0, 0 );
 * // returns 1.0
 */
-declare function array( buffer: ArrayOrBufferOrTypedArray, options?: Options ): ndarray; // tslint-disable-line max-line-length
+declare function array( buffer: ArrayLike<any>, options?: Options ): ndarray;
 
 
 // EXPORTS //
diff --git a/lib/node_modules/@stdlib/ndarray/array/docs/types/test.ts b/lib/node_modules/@stdlib/ndarray/array/docs/types/test.ts
@@ -32,8 +32,8 @@ import array = require( './index' );
 	array( true ); // $ExpectError
 	array( false ); // $ExpectError
 	array( undefined ); // $ExpectError
-	array( '5' ); // $ExpectError
-	array( ( x: number ): number => x ); // $ExpectError
+	array( 5 ); // $ExpectError
+	array( null ); // $ExpectError
 }
 
 // The function does not compile if provided a second argument which is not an options object...
diff --git a/lib/node_modules/@stdlib/ndarray/array/lib/cast_buffer.js b/lib/node_modules/@stdlib/ndarray/array/lib/cast_buffer.js
@@ -58,7 +58,7 @@ function castBuffer( buffer, len, dtype ) {
 	} else {
 		out = new ctor( len );
 		for ( i = 0; i < len; i++ ) {
-			out[ i ] = buffer[ i ];
+			out[ i ] = buffer[ i ]; // TODO: wrap and use accessors here and above
 		}
 	}
 	return out;
diff --git a/lib/node_modules/@stdlib/ndarray/array/lib/copy_view.js b/lib/node_modules/@stdlib/ndarray/array/lib/copy_view.js
@@ -41,7 +41,7 @@ function generic( arr ) {
 	len = arr.length;
 	out = [];
 	for ( i = 0; i < len; i++ ) {
-		out.push( arr.get( i ) );
+		out.push( arr.get( i ) ); // FIXME: what if `arr` has more than one dimensions?
 	}
 	return out;
 }
@@ -61,7 +61,7 @@ function binary( arr ) {
 	len = arr.length;
 	out = allocUnsafe( len );
 	for ( i = 0; i < len; i++ ) {
-		out[ i ] = arr.get( i );
+		out[ i ] = arr.get( i ); // FIXME: what if `arr` has more than one dimensions?
 	}
 	return out;
 }
@@ -82,9 +82,9 @@ function typed( arr, dtype ) {
 
 	ctor = bufferCtors( dtype );
 	len = arr.length;
-	out = new ctor( len );
+	out = new ctor( len ); // FIXME: need to account for complex number arrays; in which case, we may want to do something similar to `array/convert`
 	for ( i = 0; i < len; i++ ) {
-		out[ i ] = arr.get( i );
+		out[ i ] = arr.get( i ); // FIXME: what if `arr` has more than one dimensions?
 	}
 	return out;
 }
diff --git a/lib/node_modules/@stdlib/ndarray/array/lib/defaults.json b/lib/node_modules/@stdlib/ndarray/array/lib/defaults.json
@@ -5,5 +5,6 @@
 	"flatten": true,
 	"mode": "throw",
 	"ndmin": 0,
-	"order": "row-major"
+	"order": "row-major",
+  "readonly": false
 }
diff --git a/lib/node_modules/@stdlib/ndarray/array/lib/main.js b/lib/node_modules/@stdlib/ndarray/array/lib/main.js
@@ -64,6 +64,7 @@ var expandStrides = require( './expand_strides.js' );
 * @param {boolean} [options.flatten=true] - boolean indicating whether to automatically flatten generic array data sources
 * @param {NonNegativeInteger} [options.ndmin=0] - minimum number of dimensions
 * @param {string} [options.casting="safe"] - casting rule used to determine what constitutes an acceptable cast
+* @param {boolean} [options.readonly=false] - boolean indicating if an array should be read-only
 * @throws {TypeError} options argument must be an object
 * @throws {TypeError} must provide valid options
 * @throws {Error} must provide either an array shape, data source, or both
@@ -245,6 +246,11 @@ function array() {
 	} else {
 		nopts.submode = [ nopts.mode ];
 	}
+	if ( hasOwnProp( options, 'readonly' ) ) {
+		nopts.readonly = options.readonly;
+	} else {
+		nopts.readonly = defaults.readonly;
+	}
 	if ( hasOwnProp( options, 'copy' ) ) {
 		opts.copy = options.copy;
 		if ( !isBoolean( opts.copy ) ) {

Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@ function castBuffer( buffer, len, dtype ) {`
`58`	`58`	`} else {`
`59`	`59`	`out = new ctor( len );`
`60`	`60`	`for ( i = 0; i < len; i++ ) {`
`61`		`- out[ i ] = buffer[ i ];`
	`61`	`+ out[ i ] = buffer[ i ]; // TODO: wrap and use accessors here and above`
`62`	`62`	`}`
`63`	`63`	`}`
`64`	`64`	`return out;`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ function generic( arr ) {`
`41`	`41`	`len = arr.length;`
`42`	`42`	`out = [];`
`43`	`43`	`for ( i = 0; i < len; i++ ) {`
`44`		`- out.push( arr.get( i ) );`
	`44`	+ out.push( arr.get( i ) ); // FIXME: what if `arr` has more than one dimensions?
`45`	`45`	`}`
`46`	`46`	`return out;`
`47`	`47`	`}`
`@@ -61,7 +61,7 @@ function binary( arr ) {`
`61`	`61`	`len = arr.length;`
`62`	`62`	`out = allocUnsafe( len );`
`63`	`63`	`for ( i = 0; i < len; i++ ) {`
`64`		`- out[ i ] = arr.get( i );`
	`64`	+ out[ i ] = arr.get( i ); // FIXME: what if `arr` has more than one dimensions?
`65`	`65`	`}`
`66`	`66`	`return out;`
`67`	`67`	`}`
`@@ -82,9 +82,9 @@ function typed( arr, dtype ) {`
`82`	`82`
`83`	`83`	`ctor = bufferCtors( dtype );`
`84`	`84`	`len = arr.length;`
`85`		`- out = new ctor( len );`
	`85`	+ out = new ctor( len ); // FIXME: need to account for complex number arrays; in which case, we may want to do something similar to `array/convert`
`86`	`86`	`for ( i = 0; i < len; i++ ) {`
`87`		`- out[ i ] = arr.get( i );`
	`87`	+ out[ i ] = arr.get( i ); // FIXME: what if `arr` has more than one dimensions?
`88`	`88`	`}`
`89`	`89`	`return out;`
`90`	`90`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,5 +5,6 @@`
`5`	`5`	`"flatten": true,`
`6`	`6`	`"mode": "throw",`
`7`	`7`	`"ndmin": 0,`
`8`		`- "order": "row-major"`
	`8`	`+ "order": "row-major",`
	`9`	`+ "readonly": false`
`9`	`10`	`}`