You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/types/index.d.ts
+4-2Lines changed: 4 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -310,7 +310,7 @@ interface Namespace {
310
310
* @param options.flatten - boolean indicating whether to automatically flatten generic array data sources (default: true)
311
311
* @param options.ndmin - minimum number of dimensions (default: 0)
312
312
* @param options.casting - casting rule used to determine what constitutes an acceptable cast (default: 'safe')
313
-
* @param options.readonly - boolean indicating whether an array should be read-only (default: false)
313
+
* @param options.readonly - boolean indicating whether an array should be read-only
314
314
* @throws must provide valid options
315
315
* @throws must provide either an array shape, data source, or both
316
316
* @throws invalid cast
@@ -680,6 +680,7 @@ interface Namespace {
680
680
*
681
681
* @example
682
682
* var array = require( './../../array' );
683
+
* var ndarray2array = require( './../../to-array' );
683
684
*
684
685
* var x = array( [ -1.0, 2.0, 3.0, 4.0 ] );
685
686
* var y = array( [ -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] );
@@ -690,6 +691,7 @@ interface Namespace {
690
691
* @example
691
692
* var array = require( './../../array' );
692
693
* var empty = require( './../../empty' );
694
+
* var ndarray2array = require( './../../to-array' );
693
695
*
694
696
* var x = array( [ -1.0, 2.0, 3.0, 4.0 ] );
695
697
* var y = array( [ -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] );
@@ -2411,7 +2413,7 @@ interface Namespace {
2411
2413
*
2412
2414
* ## Notes
2413
2415
*
2414
-
* - The function throws an error if provided broadcast-incompatible ndarrays.
2416
+
* - The function throws an error if a provided broadcast-incompatible ndarrays.
2415
2417
* - If a provided ndarray has a shape matching the common shape, the function returns the provided ndarray.
2416
2418
* - If a provided ndarray has a different (broadcast compatible) shape than the common shape, the function returns a new **read-only** ndarray view of the provided ndarray's data. The view is typically **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to a view may affect multiple elements. If you need to write to an input array, copy the array before broadcasting.
0 commit comments