Auto-generated commit

stdlib-bot · stdlib-bot · commit 126f380bc22b · 2023-10-07T03:16:51.000Z
diff --git a/README.md b/README.md
@@ -107,7 +107,7 @@ arr = ndarray2array( v );
 
 The function accepts the following `options`:
 
--   **readonly**: boolean indicating whether returned [`ndarray`][@stdlib/ndarray/ctor] views should be read-only. Default: `true`.
+-   **readonly**: boolean indicating whether returned [`ndarray`][@stdlib/ndarray/ctor] views should be read-only. In order to return writable [`ndarray`][@stdlib/ndarray/ctor] views, the input [`ndarray`][@stdlib/ndarray/ctor] must be writable. If the input [`ndarray`][@stdlib/ndarray/ctor] is read-only, setting this option to `false` raises an exception. Default: `true`.
 
 By default, the iterator returns [`ndarray`][@stdlib/ndarray/ctor] views which are **read-only**. To return writable [views][@stdlib/ndarray/slice], set the `readonly` option to `false`.
 
diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/docs/repl.txt b/docs/repl.txt
@@ -20,7 +20,8 @@
 
     options.readonly: boolean (optional)
         Boolean indicating whether returned ndarray views should be read-only.
-        Default: true.
+        If the input ndarray is read-only, setting this option to `false` raises
+        an exception. Default: true.
 
     Returns
     -------
diff --git a/docs/types/index.d.ts b/docs/types/index.d.ts
@@ -32,6 +32,10 @@ type Iterator<T> = TypedIterator<T> | TypedIterableIterator<T>;
 interface Options {
 	/**
 	* Boolean indicating whether returned views should be read-only (default: true).
+	*
+	* ## Notes
+	*
+	* -   If the input array is read-only, setting this option to `false` raises an exception.
 	*/
 	readonly?: boolean;
 }
diff --git a/lib/main.js b/lib/main.js
@@ -24,6 +24,7 @@ var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-propert
 var isPlainObject = require( '@stdlib/assert-is-plain-object' );
 var isBoolean = require( '@stdlib/assert-is-boolean' ).isPrimitive;
 var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' );
+var isReadOnly = require( '@stdlib/ndarray-base-assert-is-read-only' );
 var hasOwnProp = require( '@stdlib/assert-has-own-property' );
 var iteratorSymbol = require( '@stdlib/symbol-iterator' );
 var zeros = require( '@stdlib/array-base-zeros' );
@@ -46,6 +47,7 @@ var format = require( '@stdlib/string-format' );
 * @throws {TypeError} first argument must have at least two dimensions
 * @throws {TypeError} options argument must be an object
 * @throws {TypeError} must provide valid options
+* @throws {Error} cannot write to a read-only array
 * @returns {Iterator} iterator
 *
 * @example
@@ -106,6 +108,9 @@ function nditerRows( x ) {
 				throw new TypeError( format( 'invalid option. `%s` option must be a boolean. Option: `%s`.', 'readonly', options.readonly ) );
 			}
 			opts.writable = !options.readonly;
+			if ( opts.writable && isReadOnly( x ) ) {
+				throw new Error( format( 'invalid option. Cannot write to read-only array.' ) );
+			}
 		}
 	}
 	// Retrieve input array meta data:
diff --git a/package.json b/package.json
@@ -42,6 +42,7 @@
     "@stdlib/assert-is-boolean": "^0.1.1",
     "@stdlib/assert-is-ndarray-like": "^0.1.0",
     "@stdlib/assert-is-plain-object": "^0.1.1",
+    "@stdlib/ndarray-base-assert-is-read-only": "^0.1.1",
     "@stdlib/ndarray-base-next-cartesian-index": "github:stdlib-js/ndarray-base-next-cartesian-index#main",
     "@stdlib/ndarray-base-numel": "^0.1.1",
     "@stdlib/ndarray-base-slice": "github:stdlib-js/ndarray-base-slice#main",
@@ -56,7 +57,6 @@
     "@stdlib/assert-is-iterator-like": "^0.1.1",
     "@stdlib/bench": "^0.1.0",
     "@stdlib/ndarray-array": "^0.1.0",
-    "@stdlib/ndarray-base-assert-is-read-only": "^0.1.1",
     "@stdlib/ndarray-slice": "github:stdlib-js/ndarray-slice#main",
     "@stdlib/ndarray-to-array": "^0.1.0",
     "@stdlib/ndarray-zeros": "^0.1.0",
diff --git a/test/test.js b/test/test.js
@@ -155,6 +155,20 @@ tape( 'the function throws an error if provided a `readonly` option which is not
 	}
 });
 
+tape( 'the function throws an error if provided a `readonly` option which equal to `false` when the input array is read-only', function test( t ) {
+	t.throws( badValue, Error, 'throws an error' );
+	t.end();
+
+	function badValue() {
+		var x = zeros( [ 2, 2 ], {
+			'readonly': true
+		});
+		nditerRows( x, {
+			'readonly': false
+		});
+	}
+});
+
 tape( 'the function throws an error if provided an ndarray having fewer than two dimensions', function test( t ) {
 	var values;
 	var i;

Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,7 @@ var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-propert`
`24`	`24`	`var isPlainObject = require( '@stdlib/assert-is-plain-object' );`
`25`	`25`	`var isBoolean = require( '@stdlib/assert-is-boolean' ).isPrimitive;`
`26`	`26`	`var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' );`
	`27`	`+var isReadOnly = require( '@stdlib/ndarray-base-assert-is-read-only' );`
`27`	`28`	`var hasOwnProp = require( '@stdlib/assert-has-own-property' );`
`28`	`29`	`var iteratorSymbol = require( '@stdlib/symbol-iterator' );`
`29`	`30`	`var zeros = require( '@stdlib/array-base-zeros' );`
`@@ -46,6 +47,7 @@ var format = require( '@stdlib/string-format' );`
`46`	`47`	`* @throws {TypeError} first argument must have at least two dimensions`
`47`	`48`	`* @throws {TypeError} options argument must be an object`
`48`	`49`	`* @throws {TypeError} must provide valid options`
	`50`	`+* @throws {Error} cannot write to a read-only array`
`49`	`51`	`* @returns {Iterator} iterator`
`50`	`52`	`*`
`51`	`53`	`* @example`
`@@ -106,6 +108,9 @@ function nditerRows( x ) {`
`106`	`108`	throw new TypeError( format( 'invalid option. `%s` option must be a boolean. Option: `%s`.', 'readonly', options.readonly ) );
`107`	`109`	`}`
`108`	`110`	`opts.writable = !options.readonly;`
	`111`	`+ if ( opts.writable && isReadOnly( x ) ) {`
	`112`	`+ throw new Error( format( 'invalid option. Cannot write to read-only array.' ) );`
	`113`	`+ }`
`109`	`114`	`}`
`110`	`115`	`}`
`111`	`116`	`// Retrieve input array meta data:`