Auto-generated commit

Author: stdlib-bot

README.md

@@ -225,6 +225,7 @@ var arr = ndarray2array( y );
 
 ## Notes
 
+-   An output [`ndarray`][@stdlib/ndarray/ctor] **must** be writable. If provided a **read-only** [`ndarray`][@stdlib/ndarray/ctor], the function throws an error.
 -   A **slice argument** must be either a [`Slice`][@stdlib/slice/ctor], an integer, `null`, or `undefined`.
 -   The number of slice dimensions must match the number of output array dimensions. Hence, if `y` is a zero-dimensional [`ndarray`][@stdlib/ndarray/ctor], then, if `s` is a [`MultiSlice`][@stdlib/slice/multi], `s` should be empty, and, if `s` is an array, `s` should not contain any slice arguments. Similarly, if `y` is a one-dimensional [`ndarray`][@stdlib/ndarray/ctor], then, if `s` is a [`MultiSlice`][@stdlib/slice/multi], `s` should have one slice dimension, and, if `s` is an array, `s` should contain a single slice argument. And so on and so forth.
 -   The input [`ndarray`][@stdlib/ndarray/ctor] **must** be [broadcast compatible][@stdlib/ndarray/base/broadcast-shapes] with the output [`ndarray`][@stdlib/ndarray/ctor] view.

dist/index.js

@@ -34,7 +34,7 @@
         assigned to corresponding elements in a 'float32' output array).
 
     y: ndarray
-        Output array.
+        Output array. The output array must be writable.
 
     s: ...MultiSlice|Slice|null|undefined|integer|ArrayLike
         Slice arguments.

dist/index.js.map

@@ -25,6 +25,7 @@ var isMultiSlice = require( '@stdlib/assert-is-multi-slice' );
 var isArrayLikeObject = require( '@stdlib/assert-is-array-like-object' );
 var isPlainObject = require( '@stdlib/assert-is-plain-object' );
 var isBoolean = require( '@stdlib/assert-is-boolean' ).isPrimitive;
+var isReadOnly = require( '@stdlib/ndarray-base-assert-is-read-only' );
 var hasOwnProp = require( '@stdlib/assert-has-own-property' );
 var MultiSlice = require( '@stdlib/slice-multi' );
 var base = require( '@stdlib/ndarray-base-slice-assign' );
@@ -52,6 +53,7 @@ var format = require( '@stdlib/string-format' );
 * @throws {RangeError} slice exceeds array bounds
 * @throws {Error} input array must be broadcast compatible with an output array view
 * @throws {TypeError} input array cannot be safely cast to the output array data type
+* @throws {Error} cannot write to a read-only ndarray
 * @returns {ndarray} output array
 *
 * @example
@@ -116,6 +118,9 @@ function sliceAssign( x, y, s ) {
 	if ( !isndarrayLike( y ) ) {
 		throw new TypeError( format( 'invalid argument. Second argument must be an ndarray. Value: `%s`.', y ) );
 	}
+	if ( isReadOnly( y ) ) {
+		throw new Error( 'invalid argument. Cannot write to a read-only array.' );
+	}
 	if ( isPlainObject( arguments[ nargs-1 ] ) ) {
 		nargs -= 1;
 		options = arguments[ nargs ];

docs/repl.txt

@@ -43,6 +43,7 @@
     "@stdlib/assert-is-multi-slice": "^0.1.0",
     "@stdlib/assert-is-ndarray-like": "^0.1.0",
     "@stdlib/assert-is-plain-object": "^0.1.0",
+    "@stdlib/ndarray-base-assert-is-read-only": "^0.1.0",
     "@stdlib/ndarray-base-slice-assign": "github:stdlib-js/ndarray-base-slice-assign#main",
     "@stdlib/slice-multi": "^0.1.0",
     "@stdlib/string-format": "^0.1.0",

lib/main.js

@@ -248,6 +248,57 @@ tape( 'the function throws an error if provided a second argument which is not a
 	}
 });
 
+tape( 'the function throws an error if provided a read-only output array (multislice)', function test( t ) {
+	var x;
+	var y;
+
+	x = scalar2ndarray( 2.0, 'float64', 'row-major' );
+	y = zeros( [ 2, 2 ], {
+		'readonly': true
+	});
+
+	t.throws( badValue, Error, 'throws an error' );
+	t.end();
+
+	function badValue() {
+		sliceAssign( x, y, new MultiSlice( null, null ) );
+	}
+});
+
+tape( 'the function throws an error if provided a read-only output array (array)', function test( t ) {
+	var x;
+	var y;
+
+	x = scalar2ndarray( 2.0, 'float64', 'row-major' );
+	y = zeros( [ 2, 2 ], {
+		'readonly': true
+	});
+
+	t.throws( badValue, Error, 'throws an error' );
+	t.end();
+
+	function badValue() {
+		sliceAssign( x, y, [ null, null ] );
+	}
+});
+
+tape( 'the function throws an error if provided a read-only output array (slice arguments)', function test( t ) {
+	var x;
+	var y;
+
+	x = scalar2ndarray( 2.0, 'float64', 'row-major' );
+	y = zeros( [ 2, 2 ], {
+		'readonly': true
+	});
+
+	t.throws( badValue, Error, 'throws an error' );
+	t.end();
+
+	function badValue() {
+		sliceAssign( x, y, null, null );
+	}
+});
+
 tape( 'the function throws an error if provided an options argument which is not an object (multislice)', function test( t ) {
 	var values;
 	var x;

package.json

@@ -248,6 +248,57 @@ tape( 'the function throws an error if provided a second argument which is not a
 	}
 });
 
+tape( 'the function throws an error if provided a read-only output array (multislice)', function test( t ) {
+	var x;
+	var y;
+
+	x = scalar2ndarray( 2.0, 'float64', 'row-major' );
+	y = zeros( [ 2, 2 ], {
+		'readonly': true
+	});
+
+	t.throws( badValue, Error, 'throws an error' );
+	t.end();
+
+	function badValue() {
+		sliceAssign( x, y, new MultiSlice( null, null ) );
+	}
+});
+
+tape( 'the function throws an error if provided a read-only output array (array)', function test( t ) {
+	var x;
+	var y;
+
+	x = scalar2ndarray( 2.0, 'float64', 'row-major' );
+	y = zeros( [ 2, 2 ], {
+		'readonly': true
+	});
+
+	t.throws( badValue, Error, 'throws an error' );
+	t.end();
+
+	function badValue() {
+		sliceAssign( x, y, [ null, null ] );
+	}
+});
+
+tape( 'the function throws an error if provided a read-only output array (slice arguments)', function test( t ) {
+	var x;
+	var y;
+
+	x = scalar2ndarray( 2.0, 'float64', 'row-major' );
+	y = zeros( [ 2, 2 ], {
+		'readonly': true
+	});
+
+	t.throws( badValue, Error, 'throws an error' );
+	t.end();
+
+	function badValue() {
+		sliceAssign( x, y, null, null );
+	}
+});
+
 tape( 'the function throws an error if provided an options argument which is not an object (multislice)', function test( t ) {
 	var values;
 	var x;