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: lib/node_modules/@stdlib/array/base/assert/README.md
+3Lines changed: 3 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -67,6 +67,7 @@ The namespace exports the following:
67
67
- <spanclass="signature">[`isSafeDataTypeCast( from, to )`][@stdlib/array/base/assert/is-safe-data-type-cast]</span><spanclass="delimiter">: </span><spanclass="description">determine whether an array data type can be safely cast to another array data type.</span>
68
68
- <spanclass="signature">[`isSameKindDataTypeCast( from, to )`][@stdlib/array/base/assert/is-same-kind-data-type-cast]</span><spanclass="delimiter">: </span><spanclass="description">determine whether an array data type can be safely cast to, or is of the same "kind" as, another array data type.</span>
69
69
- <spanclass="signature">[`isSignedIntegerDataType( value )`][@stdlib/array/base/assert/is-signed-integer-data-type]</span><spanclass="delimiter">: </span><spanclass="description">test if an input value is a supported array signed integer data type.</span>
70
+
- <spanclass="signature">[`isSortedAscending( x )`][@stdlib/array/base/assert/is-sorted-ascending]</span><spanclass="delimiter">: </span><spanclass="description">test if an array is sorted in ascending order.</span>
70
71
- <spanclass="signature">[`isUnsignedIntegerDataType( value )`][@stdlib/array/base/assert/is-unsigned-integer-data-type]</span><spanclass="delimiter">: </span><spanclass="description">test if an input value is a supported array unsigned integer data type.</span>
Copy file name to clipboardExpand all lines: lib/node_modules/@stdlib/blas/ext/base/README.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -109,7 +109,7 @@ var ns = extblas;
109
109
- <spanclass="signature">[`gnansumkbn2( N, x, strideX )`][@stdlib/blas/ext/base/gnansumkbn2]</span><spanclass="delimiter">: </span><spanclass="description">calculate the sum of strided array elements, ignoring `NaN` values and using a second-order iterative Kahan–Babuška algorithm.</span>
110
110
- <spanclass="signature">[`gnansumors( N, x, strideX )`][@stdlib/blas/ext/base/gnansumors]</span><spanclass="delimiter">: </span><spanclass="description">calculate the sum of strided array elements, ignoring `NaN` values and using ordinary recursive summation.</span>
111
111
- <spanclass="signature">[`gnansumpw( N, x, strideX )`][@stdlib/blas/ext/base/gnansumpw]</span><spanclass="delimiter">: </span><spanclass="description">calculate the sum of strided array elements, ignoring `NaN` values and using pairwise summation.</span>
112
-
- <spanclass="signature">[`grev( N, x, stride )`][@stdlib/blas/ext/base/grev]</span><spanclass="delimiter">: </span><spanclass="description">reverse a strided array in-place.</span>
112
+
- <spanclass="signature">[`grev( N, x, strideX )`][@stdlib/blas/ext/base/grev]</span><spanclass="delimiter">: </span><spanclass="description">reverse a strided array in-place.</span>
113
113
- <spanclass="signature">[`gsort2hp( N, order, x, strideX, y, strideY )`][@stdlib/blas/ext/base/gsort2hp]</span><spanclass="delimiter">: </span><spanclass="description">simultaneously sort two strided arrays based on the sort order of the first array using heapsort.</span>
114
114
- <spanclass="signature">[`gsort2ins( N, order, x, strideX, y, strideY )`][@stdlib/blas/ext/base/gsort2ins]</span><spanclass="delimiter">: </span><spanclass="description">simultaneously sort two strided arrays based on the sort order of the first array using insertion sort.</span>
115
115
- <spanclass="signature">[`gsort2sh( N, order, x, strideX, y, strideY )`][@stdlib/blas/ext/base/gsort2sh]</span><spanclass="delimiter">: </span><spanclass="description">simultaneously sort two strided arrays based on the sort order of the first array using Shellsort.</span>
Copy file name to clipboardExpand all lines: lib/node_modules/@stdlib/ndarray/base/README.md
+12Lines changed: 12 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -98,6 +98,7 @@ var o = ns;
98
98
- <spanclass="signature">[`nextCartesianIndex( shape, order, idx, dim )`][@stdlib/ndarray/base/next-cartesian-index]</span><spanclass="delimiter">: </span><spanclass="description">return the next Cartesian index (i.e., set of subscripts/dimension indices).</span>
99
99
- <spanclass="signature">[`nonsingletonDimensions( shape )`][@stdlib/ndarray/base/nonsingleton-dimensions]</span><spanclass="delimiter">: </span><spanclass="description">return the number of non-singleton dimensions.</span>
100
100
- <spanclass="signature">[`normalizeIndex( idx, max )`][@stdlib/ndarray/base/normalize-index]</span><spanclass="delimiter">: </span><spanclass="description">normalize an index to the interval `[0,max]`.</span>
101
+
- <spanclass="signature">[`normalizeIndices( indices, max )`][@stdlib/ndarray/base/normalize-indices]</span><spanclass="delimiter">: </span><spanclass="description">normalize a list of indices to the interval `[0,max]`.</span>
101
102
- <spanclass="signature">[`nullaryLoopOrder( shape, stridesX )`][@stdlib/ndarray/base/nullary-loop-interchange-order]</span><spanclass="delimiter">: </span><spanclass="description">reorder ndarray dimensions and associated strides for loop interchange.</span>
102
103
- <spanclass="signature">[`nullaryBlockSize( dtypeX )`][@stdlib/ndarray/base/nullary-tiling-block-size]</span><spanclass="delimiter">: </span><spanclass="description">resolve a loop block size for multi-dimensional array tiled loops.</span>
103
104
- <spanclass="signature">[`nullary( arrays, fcn )`][@stdlib/ndarray/base/nullary]</span><spanclass="delimiter">: </span><spanclass="description">apply a nullary callback and assign results to elements in an output ndarray.</span>
@@ -124,13 +125,16 @@ var o = ns;
124
125
- <spanclass="signature">[`sliceFrom( x, start, strict, writable )`][@stdlib/ndarray/base/slice-from]</span><spanclass="delimiter">: </span><spanclass="description">return a shifted view of an input ndarray.</span>
125
126
- <spanclass="signature">[`sliceTo( x, stop, strict, writable )`][@stdlib/ndarray/base/slice-to]</span><spanclass="delimiter">: </span><spanclass="description">return a truncated view of an input ndarray.</span>
126
127
- <spanclass="signature">[`slice( x, slice, strict, writable )`][@stdlib/ndarray/base/slice]</span><spanclass="delimiter">: </span><spanclass="description">return a view of an input ndarray.</span>
128
+
- <spanclass="signature">[`spreadDimensions( ndims, x, dims )`][@stdlib/ndarray/base/spread-dimensions]</span><spanclass="delimiter">: </span><spanclass="description">expand the shape of an array to a specified dimensionality by spreading its dimensions to specified dimension indices and inserting dimensions of size one for the remaining dimensions.</span>
127
129
- <spanclass="signature">[`stride( x, dim )`][@stdlib/ndarray/base/stride]</span><spanclass="delimiter">: </span><spanclass="description">return the stride along a specified dimension for a provided ndarray.</span>
128
130
- <spanclass="signature">[`strides( x, copy )`][@stdlib/ndarray/base/strides]</span><spanclass="delimiter">: </span><spanclass="description">return the strides of a provided ndarray.</span>
129
131
- <spanclass="signature">[`strides2offset( shape, strides )`][@stdlib/ndarray/base/strides2offset]</span><spanclass="delimiter">: </span><spanclass="description">determine the index offset which specifies the location of the first indexed value in a multidimensional array based on a stride array.</span>
130
132
- <spanclass="signature">[`strides2order( strides )`][@stdlib/ndarray/base/strides2order]</span><spanclass="delimiter">: </span><spanclass="description">determine the order of a multidimensional array based on a provided stride array.</span>
131
133
- <spanclass="signature">[`sub2ind( shape, strides, offset, ...subscripts, mode )`][@stdlib/ndarray/base/sub2ind]</span><spanclass="delimiter">: </span><spanclass="description">convert subscripts to a linear index.</span>
132
134
- <spanclass="signature">[`ndarray2array( buffer, shape, strides, offset, order )`][@stdlib/ndarray/base/to-array]</span><spanclass="delimiter">: </span><spanclass="description">convert an ndarray buffer to a generic array.</span>
135
+
- <spanclass="signature">[`toNormalizedIndices( indices, max )`][@stdlib/ndarray/base/to-normalized-indices]</span><spanclass="delimiter">: </span><spanclass="description">normalize a list of indices to the interval `[0,max]`.</span>
133
136
- <spanclass="signature">[`toReversed( x )`][@stdlib/ndarray/base/to-reversed]</span><spanclass="delimiter">: </span><spanclass="description">return a new ndarray where the order of elements of an input ndarray is reversed along each dimension.</span>
137
+
- <spanclass="signature">[`toUniqueNormalizedIndices( indices, max )`][@stdlib/ndarray/base/to-unique-normalized-indices]</span><spanclass="delimiter">: </span><spanclass="description">return a list of unique indices after normalizing to the interval `[0,max]`.</span>
134
138
- <spanclass="signature">[`transpose( x )`][@stdlib/ndarray/base/transpose]</span><spanclass="delimiter">: </span><spanclass="description">transpose a matrix (or a stack of matrices).</span>
135
139
- <spanclass="signature">[`unaryBy( arrays, fcn, clbk[, thisArg] )`][@stdlib/ndarray/base/unary-by]</span><spanclass="delimiter">: </span><spanclass="description">apply a unary function to each element in an input ndarray according to a callback function and assign results to elements in an output ndarray.</span>
136
140
- <spanclass="signature">[`unaryLoopOrder( shape, stridesX, stridesY )`][@stdlib/ndarray/base/unary-loop-interchange-order]</span><spanclass="delimiter">: </span><spanclass="description">reorder ndarray dimensions and associated strides for loop interchange.</span>
Copy file name to clipboardExpand all lines: lib/node_modules/@stdlib/ndarray/base/assert/README.md
+6Lines changed: 6 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -50,6 +50,7 @@ var o = ns;
50
50
- <spanclass="signature">[`isBufferLengthCompatible( len, shape, strides, offset )`][@stdlib/ndarray/base/assert/is-buffer-length-compatible]</span><spanclass="delimiter">: </span><spanclass="description">determine if a buffer length is compatible with ndarray meta data.</span>
51
51
- <spanclass="signature">[`isCastingMode( value )`][@stdlib/ndarray/base/assert/is-casting-mode]</span><spanclass="delimiter">: </span><spanclass="description">test if an input value is a supported ndarray casting mode.</span>
52
52
- <spanclass="signature">[`isColumnMajorContiguous( shape, strides, offset )`][@stdlib/ndarray/base/assert/is-column-major-contiguous]</span><spanclass="delimiter">: </span><spanclass="description">determine if an array is column-major contiguous.</span>
53
+
- <spanclass="signature">[`isColumnMajorString( value )`][@stdlib/ndarray/base/assert/is-column-major-string]</span><spanclass="delimiter">: </span><spanclass="description">test whether an input value is the string representing column-major order.</span>
53
54
- <spanclass="signature">[`isColumnMajor( strides )`][@stdlib/ndarray/base/assert/is-column-major]</span><spanclass="delimiter">: </span><spanclass="description">given a stride array, determine whether an array is column-major.</span>
54
55
- <spanclass="signature">[`isComplexFloatingPointDataType( value )`][@stdlib/ndarray/base/assert/is-complex-floating-point-data-type]</span><spanclass="delimiter">: </span><spanclass="description">test if an input value is a supported ndarray complex-valued floating-point data type.</span>
55
56
- <spanclass="signature">[`isContiguous( shape, strides, offset )`][@stdlib/ndarray/base/assert/is-contiguous]</span><spanclass="delimiter">: </span><spanclass="description">determine if an array is contiguous.</span>
@@ -64,6 +65,7 @@ var o = ns;
64
65
- <spanclass="signature">[`isRealDataType( value )`][@stdlib/ndarray/base/assert/is-real-data-type]</span><spanclass="delimiter">: </span><spanclass="description">test if an input value is a supported ndarray real-valued data type.</span>
65
66
- <spanclass="signature">[`isRealFloatingPointDataType( value )`][@stdlib/ndarray/base/assert/is-real-floating-point-data-type]</span><spanclass="delimiter">: </span><spanclass="description">test if an input value is a supported ndarray real-valued floating-point data type.</span>
66
67
- <spanclass="signature">[`isRowMajorContiguous( shape, strides, offset )`][@stdlib/ndarray/base/assert/is-row-major-contiguous]</span><spanclass="delimiter">: </span><spanclass="description">determine if an array is row-major contiguous.</span>
68
+
- <spanclass="signature">[`isRowMajorString( value )`][@stdlib/ndarray/base/assert/is-row-major-string]</span><spanclass="delimiter">: </span><spanclass="description">test whether an input value is the string representing row-major order.</span>
67
69
- <spanclass="signature">[`isRowMajor( strides )`][@stdlib/ndarray/base/assert/is-row-major]</span><spanclass="delimiter">: </span><spanclass="description">given a stride array, determine whether an array is row-major.</span>
68
70
- <spanclass="signature">[`isSafeDataTypeCast( from, to )`][@stdlib/ndarray/base/assert/is-safe-data-type-cast]</span><spanclass="delimiter">: </span><spanclass="description">determine whether an ndarray data type can be safely cast to another ndarray data type.</span>
69
71
- <spanclass="signature">[`isSameKindDataTypeCast( from, to )`][@stdlib/ndarray/base/assert/is-same-kind-data-type-cast]</span><spanclass="delimiter">: </span><spanclass="description">determine whether an ndarray data type can be safely cast to, or is of the same "kind" as, another ndarray data type.</span>
0 commit comments