diff --git a/CONTRIBUTORS b/CONTRIBUTORS index 93c4bdef..2db37dba 100644 --- a/CONTRIBUTORS +++ b/CONTRIBUTORS @@ -37,3 +37,4 @@ Stephannie Jiménez Gacha Yernar Yergaziyev orimiles5 <97595296+orimiles5@users.noreply.github.com> rei2hu +rgizz diff --git a/README.md b/README.md index 513c4064..600cf11a 100644 --- a/README.md +++ b/README.md @@ -90,6 +90,7 @@ The namespace contains the following sub-namespaces:
- [`base`][@stdlib/ndarray/base]: base ndarray. +- [`iter`][@stdlib/ndarray/iter]: multidimensional array iterators.
@@ -101,24 +102,41 @@ In addition, the namespace contains the following multidimensional array utility
+- [`broadcastArray( x, shape )`][@stdlib/ndarray/broadcast-array]: broadcast an ndarray to a specified shape. - [`ndarrayCastingModes()`][@stdlib/ndarray/casting-modes]: list of ndarray casting modes. +- [`ndarrayDataBuffer( x )`][@stdlib/ndarray/data-buffer]: return the underlying data buffer of a provided ndarray. - [`defaults()`][@stdlib/ndarray/defaults]: default ndarray settings. - [`dispatch( fcns, types, data, nargs, nin, nout )`][@stdlib/ndarray/dispatch]: create an ndarray function interface which performs multiple dispatch. +- [`ndarrayDataType( x )`][@stdlib/ndarray/dtype]: return the data type of a provided ndarray. - [`ndarrayDataTypes( [kind] )`][@stdlib/ndarray/dtypes]: list of ndarray data types. - [`ndemptyLike( x[, options] )`][@stdlib/ndarray/empty-like]: create an uninitialized ndarray having the same shape and data type as a provided ndarray. - [`ndempty( shape[, options] )`][@stdlib/ndarray/empty]: create an uninitialized ndarray having a specified shape and data type. +- [`FancyArray( dtype, buffer, shape, strides, offset, order[, options] )`][@stdlib/ndarray/fancy]: fancy multidimensional array constructor. - [`scalar2ndarray( value[, options] )`][@stdlib/ndarray/from-scalar]: convert a scalar value to a zero-dimensional ndarray. - [`ind2sub( shape, idx[, options] )`][@stdlib/ndarray/ind2sub]: convert a linear index to an array of subscripts. - [`ndarrayIndexModes()`][@stdlib/ndarray/index-modes]: list of ndarray index modes. +- [`maybeBroadcastArray( x, shape )`][@stdlib/ndarray/maybe-broadcast-array]: broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. - [`ndarrayMinDataType( value )`][@stdlib/ndarray/min-dtype]: determine the minimum ndarray data type of the closest "kind" necessary for storing a provided scalar value. +- [`ndarrayMostlySafeCasts( [dtype] )`][@stdlib/ndarray/mostly-safe-casts]: return a list of ndarray data types to which a provided ndarray data type can be safely cast and, for floating-point data types, can be downcast. +- [`ndims( x )`][@stdlib/ndarray/ndims]: return the number of ndarray dimensions. - [`ndarrayNextDataType( [dtype] )`][@stdlib/ndarray/next-dtype]: return the next larger ndarray data type of the same kind. +- [`numel( x )`][@stdlib/ndarray/numel]: return the number of elements in an ndarray. +- [`ndarrayOffset( x )`][@stdlib/ndarray/offset]: return the index offset specifying the underlying buffer index of the first iterated ndarray element. +- [`ndarrayOrder( x )`][@stdlib/ndarray/order]: return the layout order of a provided ndarray. - [`ndarrayOrders()`][@stdlib/ndarray/orders]: list of ndarray orders. - [`ndarrayOutputDataTypePolicies()`][@stdlib/ndarray/output-dtype-policies]: list of output ndarray data type policies. - [`ndarrayPromotionRules( [dtype1, dtype2] )`][@stdlib/ndarray/promotion-rules]: return the ndarray data type with the smallest size and closest "kind" to which ndarray data types can be **safely** cast. - [`ndarraySafeCasts( [dtype] )`][@stdlib/ndarray/safe-casts]: return a list of ndarray data types to which a provided ndarray data type can be safely cast. - [`ndarraySameKindCasts( [dtype] )`][@stdlib/ndarray/same-kind-casts]: return a list of ndarray data types to which a provided ndarray data type can be safely cast or cast within the same "kind". +- [`ndarrayShape( x )`][@stdlib/ndarray/shape]: return the shape of a provided ndarray. +- [`ndsliceAssign( x, y, ...s[, options] )`][@stdlib/ndarray/slice-assign]: assign element values from a broadcasted input `ndarray` to corresponding elements in an output `ndarray` view. +- [`ndsliceDimensionFrom( x, dim, start[, options] )`][@stdlib/ndarray/slice-dimension-from]: return a read-only shifted view of an input `ndarray` along a specified dimension. +- [`ndsliceDimensionTo( x, dim, stop[, options] )`][@stdlib/ndarray/slice-dimension-to]: return a read-only truncated view of an input `ndarray` along a specified dimension. +- [`ndsliceDimension( x, dim, slice[, options] )`][@stdlib/ndarray/slice-dimension]: return a read-only view of an input `ndarray` when sliced along a specified dimension. +- [`ndslice( x, ...s[, options] )`][@stdlib/ndarray/slice]: return a read-only view of an input `ndarray`. +- [`ndarrayStrides( x )`][@stdlib/ndarray/strides]: return the strides of a provided ndarray. - [`sub2ind( shape, ...subscripts[, options] )`][@stdlib/ndarray/sub2ind]: convert subscripts to a linear index. -- [`ndarray2array( arr )`][@stdlib/ndarray/to-array]: convert an ndarray to a generic array. +- [`ndarray2array( x )`][@stdlib/ndarray/to-array]: convert an ndarray to a generic array. - [`ndzerosLike( x[, options] )`][@stdlib/ndarray/zeros-like]: create a zero-filled ndarray having the same shape and data type as a provided ndarray. - [`ndzeros( shape[, options] )`][@stdlib/ndarray/zeros]: create a zero-filled ndarray having a specified shape and data type. @@ -228,28 +246,48 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. +[@stdlib/ndarray/broadcast-array]: https://github.com/stdlib-js/ndarray/tree/main/broadcast-array + [@stdlib/ndarray/casting-modes]: https://github.com/stdlib-js/ndarray/tree/main/casting-modes +[@stdlib/ndarray/data-buffer]: https://github.com/stdlib-js/ndarray/tree/main/data-buffer + [@stdlib/ndarray/defaults]: https://github.com/stdlib-js/ndarray/tree/main/defaults [@stdlib/ndarray/dispatch]: https://github.com/stdlib-js/ndarray/tree/main/dispatch +[@stdlib/ndarray/dtype]: https://github.com/stdlib-js/ndarray/tree/main/dtype + [@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/ndarray/tree/main/dtypes [@stdlib/ndarray/empty-like]: https://github.com/stdlib-js/ndarray/tree/main/empty-like [@stdlib/ndarray/empty]: https://github.com/stdlib-js/ndarray/tree/main/empty +[@stdlib/ndarray/fancy]: https://github.com/stdlib-js/ndarray/tree/main/fancy + [@stdlib/ndarray/from-scalar]: https://github.com/stdlib-js/ndarray/tree/main/from-scalar [@stdlib/ndarray/ind2sub]: https://github.com/stdlib-js/ndarray/tree/main/ind2sub [@stdlib/ndarray/index-modes]: https://github.com/stdlib-js/ndarray/tree/main/index-modes +[@stdlib/ndarray/maybe-broadcast-array]: https://github.com/stdlib-js/ndarray/tree/main/maybe-broadcast-array + [@stdlib/ndarray/min-dtype]: https://github.com/stdlib-js/ndarray/tree/main/min-dtype +[@stdlib/ndarray/mostly-safe-casts]: https://github.com/stdlib-js/ndarray/tree/main/mostly-safe-casts + +[@stdlib/ndarray/ndims]: https://github.com/stdlib-js/ndarray/tree/main/ndims + [@stdlib/ndarray/next-dtype]: https://github.com/stdlib-js/ndarray/tree/main/next-dtype +[@stdlib/ndarray/numel]: https://github.com/stdlib-js/ndarray/tree/main/numel + +[@stdlib/ndarray/offset]: https://github.com/stdlib-js/ndarray/tree/main/offset + +[@stdlib/ndarray/order]: https://github.com/stdlib-js/ndarray/tree/main/order + [@stdlib/ndarray/orders]: https://github.com/stdlib-js/ndarray/tree/main/orders [@stdlib/ndarray/output-dtype-policies]: https://github.com/stdlib-js/ndarray/tree/main/output-dtype-policies @@ -260,6 +298,20 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. [@stdlib/ndarray/same-kind-casts]: https://github.com/stdlib-js/ndarray/tree/main/same-kind-casts +[@stdlib/ndarray/shape]: https://github.com/stdlib-js/ndarray/tree/main/shape + +[@stdlib/ndarray/slice-assign]: https://github.com/stdlib-js/ndarray/tree/main/slice-assign + +[@stdlib/ndarray/slice-dimension-from]: https://github.com/stdlib-js/ndarray/tree/main/slice-dimension-from + +[@stdlib/ndarray/slice-dimension-to]: https://github.com/stdlib-js/ndarray/tree/main/slice-dimension-to + +[@stdlib/ndarray/slice-dimension]: https://github.com/stdlib-js/ndarray/tree/main/slice-dimension + +[@stdlib/ndarray/slice]: https://github.com/stdlib-js/ndarray/tree/main/slice + +[@stdlib/ndarray/strides]: https://github.com/stdlib-js/ndarray/tree/main/strides + [@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray/tree/main/sub2ind [@stdlib/ndarray/to-array]: https://github.com/stdlib-js/ndarray/tree/main/to-array @@ -270,6 +322,8 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. [@stdlib/ndarray/base]: https://github.com/stdlib-js/ndarray/tree/main/base +[@stdlib/ndarray/iter]: https://github.com/stdlib-js/ndarray/tree/main/iter + [@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray/tree/main/array [@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray/tree/main/ctor diff --git a/base/README.md b/base/README.md index de921975..eb8160e4 100644 --- a/base/README.md +++ b/base/README.md @@ -43,6 +43,7 @@ var o = ns;
+- [`assign( arrays )`][@stdlib/ndarray/base/assign]: assign elements in an input ndarray to elements in an output ndarray. - [`binaryLoopOrder( shape, stridesX, stridesY, stridesZ )`][@stdlib/ndarray/base/binary-loop-interchange-order]: reorder ndarray dimensions and associated strides for loop interchange. - [`binaryBlockSize( dtypeX, dtypeY, dtypeZ )`][@stdlib/ndarray/base/binary-tiling-block-size]: resolve a loop block size for multi-dimensional array tiled loops. - [`bind2vind( shape, strides, offset, order, idx, mode )`][@stdlib/ndarray/base/bind2vind]: convert a linear index in an underlying data buffer to a linear index in an array view. @@ -57,17 +58,21 @@ var o = ns; - [`char2dtype( [ch] )`][@stdlib/ndarray/base/char2dtype]: return the data type string associated with a provided single letter character abbreviation. - [`clampIndex( idx, max )`][@stdlib/ndarray/base/clamp-index]: restrict an index to the interval `[0,max]`. - [`ndarray( dtype, buffer, shape, strides, offset, order )`][@stdlib/ndarray/base/ctor]: create a multidimensional array. +- [`data( x )`][@stdlib/ndarray/base/data-buffer]: return the underlying data buffer of a provided ndarray. - [`dtypeChar( [dtype] )`][@stdlib/ndarray/base/dtype-char]: return the single letter abbreviation for an underlying array data type. - [`dtypeDesc( [dtype] )`][@stdlib/ndarray/base/dtype-desc]: return the description for a specified data type. - [`dtypeEnum2Str( dtype )`][@stdlib/ndarray/base/dtype-enum2str]: return the data type string associated with an ndarray data type enumeration constant. - [`dtypeResolveEnum( dtype )`][@stdlib/ndarray/base/dtype-resolve-enum]: return the enumeration constant associated with a supported ndarray data type value. - [`dtypeResolveStr( dtype )`][@stdlib/ndarray/base/dtype-resolve-str]: return the data type string associated with a supported ndarray data type value. - [`dtypeStr2Enum( dtype )`][@stdlib/ndarray/base/dtype-str2enum]: return the enumeration constant associated with an ndarray data type string. +- [`dtype( x )`][@stdlib/ndarray/base/dtype]: return the data type of a provided ndarray. - [`dtype2c( dtype )`][@stdlib/ndarray/base/dtype2c]: return the C data type associated with a provided data type value. - [`dtypes2signatures( dtypes, nin, nout )`][@stdlib/ndarray/base/dtypes2signatures]: transform a list of array argument data types into a list of signatures. - [`emptyLike( x )`][@stdlib/ndarray/base/empty-like]: create an uninitialized ndarray having the same shape and data type as a provided ndarray. - [`empty( dtype, shape, order )`][@stdlib/ndarray/base/empty]: create an uninitialized ndarray having a specified shape and data type. - [`expandDimensions( x, axis )`][@stdlib/ndarray/base/expand-dimensions]: expand the shape of an array by inserting a new dimension of size one at a specified axis. +- [`fliplr( x, writable )`][@stdlib/ndarray/base/fliplr]: return a view of an input ndarray in which the order of elements along the last dimension is reversed. +- [`flipud( x, writable )`][@stdlib/ndarray/base/flipud]: return a view of an input ndarray in which the order of elements along the second-to-last dimension is reversed. - [`scalar2ndarray( value, dtype, order )`][@stdlib/ndarray/base/from-scalar]: convert a scalar value to a zero-dimensional ndarray. - [`ind( idx, max, mode )`][@stdlib/ndarray/base/ind]: return an index given an index mode. - [`ind2sub( shape, strides, offset, order, idx, mode )`][@stdlib/ndarray/base/ind2sub]: convert a linear index to an array of subscripts. @@ -78,20 +83,36 @@ var o = ns; - [`minViewBufferIndex( shape, strides, offset )`][@stdlib/ndarray/base/min-view-buffer-index]: compute the minimum linear index in an underlying data buffer accessible to an array view. - [`minmaxViewBufferIndex( shape, strides, offset )`][@stdlib/ndarray/base/minmax-view-buffer-index]: compute the minimum and maximum linear indices in an underlying data buffer which are accessible to an array view. - [`ndarraylike2object( x )`][@stdlib/ndarray/base/ndarraylike2object]: convert an `ndarray`-like object to an object likely to have the same "shape". +- [`ndims( x )`][@stdlib/ndarray/base/ndims]: return the number of ndarray dimensions. +- [`nextCartesianIndex( shape, order, idx, dim )`][@stdlib/ndarray/base/next-cartesian-index]: return the next Cartesian index (i.e., set of subscripts/dimension indices). - [`nonsingletonDimensions( shape )`][@stdlib/ndarray/base/nonsingleton-dimensions]: return the number of non-singleton dimensions. +- [`normalizeIndex( idx, max )`][@stdlib/ndarray/base/normalize-index]: normalize an index to the interval `[0,max]`. - [`nullaryLoopOrder( shape, stridesX )`][@stdlib/ndarray/base/nullary-loop-interchange-order]: reorder ndarray dimensions and associated strides for loop interchange. - [`nullaryBlockSize( dtypeX )`][@stdlib/ndarray/base/nullary-tiling-block-size]: resolve a loop block size for multi-dimensional array tiled loops. - [`nullary( arrays, fcn )`][@stdlib/ndarray/base/nullary]: apply a nullary callback and assign results to elements in an output ndarray. - [`numel( shape )`][@stdlib/ndarray/base/numel]: return the number of elements in an array. +- [`offset( x )`][@stdlib/ndarray/base/offset]: return the index offset specifying the underlying buffer index of the first iterated ndarray element. +- [`order( x )`][@stdlib/ndarray/base/order]: return the layout order of a provided ndarray. - [`outputPolicyEnum2Str( policy )`][@stdlib/ndarray/base/output-policy-enum2str]: return the policy string associated with an output ndarray data type policy enumeration constant. - [`outputPolicyResolveEnum( policy )`][@stdlib/ndarray/base/output-policy-resolve-enum]: return the enumeration constant associated with a supported ndarray data type policy value. - [`outputPolicyResolveStr( dtype )`][@stdlib/ndarray/base/output-policy-resolve-str]: return the policy string associated with a supported ndarray data type policy value. - [`outputPolicyStr2Enum( policy )`][@stdlib/ndarray/base/output-policy-str2enum]: return the enumeration constant associated with an output ndarray data type policy string. - [`prependSingletonDimensions( x, n )`][@stdlib/ndarray/base/prepend-singleton-dimensions]: prepend singleton dimensions. - [`removeSingletonDimensions( x )`][@stdlib/ndarray/base/remove-singleton-dimensions]: remove singleton dimensions. +- [`reverseDimension( x, dim, writable )`][@stdlib/ndarray/base/reverse-dimension]: return a view of an input ndarray in which the order of elements along a specified dimension is reversed. +- [`reverse( x, writable )`][@stdlib/ndarray/base/reverse]: return a view of an input ndarray in which the order of elements along each dimension is reversed. - [`serializeMetaData( x )`][@stdlib/ndarray/base/serialize-meta-data]: serialize ndarray meta data. +- [`shape( x, copy )`][@stdlib/ndarray/base/shape]: return the shape of a provided ndarray. - [`shape2strides( shape, order )`][@stdlib/ndarray/base/shape2strides]: generate a stride array from an array shape. - [`singletonDimensions( shape )`][@stdlib/ndarray/base/singleton-dimensions]: return the number of singleton dimensions. +- [`sliceAssign( x, y, slice, strict )`][@stdlib/ndarray/base/slice-assign]: assign element values from a broadcasted input `ndarray` to corresponding elements in an output `ndarray` view. +- [`sliceDimensionFrom( x, dim, start, strict, writable )`][@stdlib/ndarray/base/slice-dimension-from]: return a shifted view of an input ndarray along a specified dimension. +- [`sliceDimensionTo( x, dim, stop, strict, writable )`][@stdlib/ndarray/base/slice-dimension-to]: return a truncated view of an input ndarray along a specified dimension. +- [`sliceDimension( x, dim, slice, strict, writable )`][@stdlib/ndarray/base/slice-dimension]: return a view of an input ndarray when sliced along a specified dimension. +- [`sliceFrom( x, start, strict, writable )`][@stdlib/ndarray/base/slice-from]: return a shifted view of an input ndarray. +- [`sliceTo( x, stop, strict, writable )`][@stdlib/ndarray/base/slice-to]: return a truncated view of an input ndarray. +- [`slice( x, slice, strict, writable )`][@stdlib/ndarray/base/slice]: return a view of an input ndarray. +- [`strides( x, copy )`][@stdlib/ndarray/base/strides]: return the strides of a provided ndarray. - [`strides2offset( shape, strides )`][@stdlib/ndarray/base/strides2offset]: determine the index offset which specifies the location of the first indexed value in a multidimensional array based on a stride array. - [`strides2order( strides )`][@stdlib/ndarray/base/strides2order]: determine the order of a multidimensional array based on a provided stride array. - [`sub2ind( shape, strides, offset, ...subscripts, mode )`][@stdlib/ndarray/base/sub2ind]: convert subscripts to a linear index. @@ -162,6 +183,8 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/base/assert]: https://github.com/stdlib-js/ndarray/tree/main/base/assert +[@stdlib/ndarray/base/assign]: https://github.com/stdlib-js/ndarray/tree/main/base/assign + [@stdlib/ndarray/base/binary-loop-interchange-order]: https://github.com/stdlib-js/ndarray/tree/main/base/binary-loop-interchange-order [@stdlib/ndarray/base/binary-tiling-block-size]: https://github.com/stdlib-js/ndarray/tree/main/base/binary-tiling-block-size @@ -190,6 +213,8 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/base/ctor]: https://github.com/stdlib-js/ndarray/tree/main/base/ctor +[@stdlib/ndarray/base/data-buffer]: https://github.com/stdlib-js/ndarray/tree/main/base/data-buffer + [@stdlib/ndarray/base/dtype-char]: https://github.com/stdlib-js/ndarray/tree/main/base/dtype-char [@stdlib/ndarray/base/dtype-desc]: https://github.com/stdlib-js/ndarray/tree/main/base/dtype-desc @@ -202,6 +227,8 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/base/dtype-str2enum]: https://github.com/stdlib-js/ndarray/tree/main/base/dtype-str2enum +[@stdlib/ndarray/base/dtype]: https://github.com/stdlib-js/ndarray/tree/main/base/dtype + [@stdlib/ndarray/base/dtype2c]: https://github.com/stdlib-js/ndarray/tree/main/base/dtype2c [@stdlib/ndarray/base/dtypes2signatures]: https://github.com/stdlib-js/ndarray/tree/main/base/dtypes2signatures @@ -212,6 +239,10 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/base/expand-dimensions]: https://github.com/stdlib-js/ndarray/tree/main/base/expand-dimensions +[@stdlib/ndarray/base/fliplr]: https://github.com/stdlib-js/ndarray/tree/main/base/fliplr + +[@stdlib/ndarray/base/flipud]: https://github.com/stdlib-js/ndarray/tree/main/base/flipud + [@stdlib/ndarray/base/from-scalar]: https://github.com/stdlib-js/ndarray/tree/main/base/from-scalar [@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray/tree/main/base/ind @@ -232,8 +263,14 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/base/ndarraylike2object]: https://github.com/stdlib-js/ndarray/tree/main/base/ndarraylike2object +[@stdlib/ndarray/base/ndims]: https://github.com/stdlib-js/ndarray/tree/main/base/ndims + +[@stdlib/ndarray/base/next-cartesian-index]: https://github.com/stdlib-js/ndarray/tree/main/base/next-cartesian-index + [@stdlib/ndarray/base/nonsingleton-dimensions]: https://github.com/stdlib-js/ndarray/tree/main/base/nonsingleton-dimensions +[@stdlib/ndarray/base/normalize-index]: https://github.com/stdlib-js/ndarray/tree/main/base/normalize-index + [@stdlib/ndarray/base/nullary-loop-interchange-order]: https://github.com/stdlib-js/ndarray/tree/main/base/nullary-loop-interchange-order [@stdlib/ndarray/base/nullary-tiling-block-size]: https://github.com/stdlib-js/ndarray/tree/main/base/nullary-tiling-block-size @@ -242,6 +279,10 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/base/numel]: https://github.com/stdlib-js/ndarray/tree/main/base/numel +[@stdlib/ndarray/base/offset]: https://github.com/stdlib-js/ndarray/tree/main/base/offset + +[@stdlib/ndarray/base/order]: https://github.com/stdlib-js/ndarray/tree/main/base/order + [@stdlib/ndarray/base/output-policy-enum2str]: https://github.com/stdlib-js/ndarray/tree/main/base/output-policy-enum2str [@stdlib/ndarray/base/output-policy-resolve-enum]: https://github.com/stdlib-js/ndarray/tree/main/base/output-policy-resolve-enum @@ -254,12 +295,34 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/base/remove-singleton-dimensions]: https://github.com/stdlib-js/ndarray/tree/main/base/remove-singleton-dimensions +[@stdlib/ndarray/base/reverse-dimension]: https://github.com/stdlib-js/ndarray/tree/main/base/reverse-dimension + +[@stdlib/ndarray/base/reverse]: https://github.com/stdlib-js/ndarray/tree/main/base/reverse + [@stdlib/ndarray/base/serialize-meta-data]: https://github.com/stdlib-js/ndarray/tree/main/base/serialize-meta-data +[@stdlib/ndarray/base/shape]: https://github.com/stdlib-js/ndarray/tree/main/base/shape + [@stdlib/ndarray/base/shape2strides]: https://github.com/stdlib-js/ndarray/tree/main/base/shape2strides [@stdlib/ndarray/base/singleton-dimensions]: https://github.com/stdlib-js/ndarray/tree/main/base/singleton-dimensions +[@stdlib/ndarray/base/slice-assign]: https://github.com/stdlib-js/ndarray/tree/main/base/slice-assign + +[@stdlib/ndarray/base/slice-dimension-from]: https://github.com/stdlib-js/ndarray/tree/main/base/slice-dimension-from + +[@stdlib/ndarray/base/slice-dimension-to]: https://github.com/stdlib-js/ndarray/tree/main/base/slice-dimension-to + +[@stdlib/ndarray/base/slice-dimension]: https://github.com/stdlib-js/ndarray/tree/main/base/slice-dimension + +[@stdlib/ndarray/base/slice-from]: https://github.com/stdlib-js/ndarray/tree/main/base/slice-from + +[@stdlib/ndarray/base/slice-to]: https://github.com/stdlib-js/ndarray/tree/main/base/slice-to + +[@stdlib/ndarray/base/slice]: https://github.com/stdlib-js/ndarray/tree/main/base/slice + +[@stdlib/ndarray/base/strides]: https://github.com/stdlib-js/ndarray/tree/main/base/strides + [@stdlib/ndarray/base/strides2offset]: https://github.com/stdlib-js/ndarray/tree/main/base/strides2offset [@stdlib/ndarray/base/strides2order]: https://github.com/stdlib-js/ndarray/tree/main/base/strides2order diff --git a/base/assert/README.md b/base/assert/README.md index 6639e318..c76e64e3 100644 --- a/base/assert/README.md +++ b/base/assert/README.md @@ -55,6 +55,7 @@ var o = ns; - [`isFloatingPointDataType( value )`][@stdlib/ndarray/base/assert/is-floating-point-data-type]: test if an input value is a supported ndarray floating-point data type. - [`isIndexMode( value )`][@stdlib/ndarray/base/assert/is-index-mode]: test if an input value is a supported ndarray index mode. - [`isIntegerDataType( value )`][@stdlib/ndarray/base/assert/is-integer-data-type]: test if an input value is a supported ndarray integer data type. +- [`isMostlySafeDataTypeCast( from, to )`][@stdlib/ndarray/base/assert/is-mostly-safe-data-type-cast]: determine whether an ndarray data type can be safely cast or, for floating-point data types, downcast to another ndarray data type. - [`isNumericDataType( value )`][@stdlib/ndarray/base/assert/is-numeric-data-type]: test if an input value is a supported ndarray numeric data type. - [`isOrder( value )`][@stdlib/ndarray/base/assert/is-order]: test if an input value is an ndarray order. - [`isReadOnly( arr )`][@stdlib/ndarray/base/assert/is-read-only]: test if an ndarray is **read-only**. @@ -133,6 +134,8 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/base/assert/is-integer-data-type]: https://github.com/stdlib-js/ndarray/tree/main/base/assert/is-integer-data-type +[@stdlib/ndarray/base/assert/is-mostly-safe-data-type-cast]: https://github.com/stdlib-js/ndarray/tree/main/base/assert/is-mostly-safe-data-type-cast + [@stdlib/ndarray/base/assert/is-numeric-data-type]: https://github.com/stdlib-js/ndarray/tree/main/base/assert/is-numeric-data-type [@stdlib/ndarray/base/assert/is-order]: https://github.com/stdlib-js/ndarray/tree/main/base/assert/is-order diff --git a/iter/README.md b/iter/README.md index fe26cd59..4a040e9b 100644 --- a/iter/README.md +++ b/iter/README.md @@ -41,6 +41,17 @@ var o = ns; +
+ +- [`nditerColumns( x[, options] )`][@stdlib/ndarray/iter/columns]: create an iterator which iterates over each column in a matrix (or stack of matrices). +- [`nditerEntries( x[, options] )`][@stdlib/ndarray/iter/entries]: create an iterator which returns `[index, value]` pairs for each element in a provided `ndarray`. +- [`nditerIndices( shape[, options] )`][@stdlib/ndarray/iter/indices]: create an iterator which returns indices for use indexing into an `ndarray` having a specified shape. +- [`nditerRows( x[, options] )`][@stdlib/ndarray/iter/rows]: create an iterator which iterates over each row in a matrix (or stack of matrices). +- [`nditer2arrayEach( iterator )`][@stdlib/ndarray/iter/to-array-each]: create an iterator which converts each iterated `ndarray` to a generic array. +- [`nditerValues( x[, options] )`][@stdlib/ndarray/iter/values]: create an iterator which returns individual elements from a provided `ndarray`. + +
+ @@ -78,6 +89,22 @@ console.log( objectKeys( ns ) );
+ + +[@stdlib/ndarray/iter/columns]: https://github.com/stdlib-js/ndarray/tree/main/iter/columns + +[@stdlib/ndarray/iter/entries]: https://github.com/stdlib-js/ndarray/tree/main/iter/entries + +[@stdlib/ndarray/iter/indices]: https://github.com/stdlib-js/ndarray/tree/main/iter/indices + +[@stdlib/ndarray/iter/rows]: https://github.com/stdlib-js/ndarray/tree/main/iter/rows + +[@stdlib/ndarray/iter/to-array-each]: https://github.com/stdlib-js/ndarray/tree/main/iter/to-array-each + +[@stdlib/ndarray/iter/values]: https://github.com/stdlib-js/ndarray/tree/main/iter/values + + +