diff --git a/README.md b/README.md index 040a56c0..6078208a 100644 --- a/README.md +++ b/README.md @@ -104,52 +104,52 @@ In addition, the namespace contains the following multidimensional array utility
-- [`ndat( x[, ...indices] )`][@stdlib/ndarray/at]: return an `ndarray` element. +- [`at( x[, ...indices] )`][@stdlib/ndarray/at]: return an `ndarray` element. - [`broadcastArray( x, shape )`][@stdlib/ndarray/broadcast-array]: broadcast an ndarray to a specified shape. - [`broadcastArrays( ...arrays )`][@stdlib/ndarray/broadcast-arrays]: broadcast ndarrays to a common 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. +- [`castingModes()`][@stdlib/ndarray/casting-modes]: list of ndarray casting modes. +- [`dataBuffer( 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. +- [`dtype( x )`][@stdlib/ndarray/dtype]: return the data type of a provided ndarray. +- [`dtypes( [kind] )`][@stdlib/ndarray/dtypes]: list of ndarray data types. +- [`emptyLike( x[, options] )`][@stdlib/ndarray/empty-like]: create an uninitialized ndarray having the same shape and data type as a provided ndarray. +- [`empty( 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. -- [`ndarrayFlag( x, name )`][@stdlib/ndarray/flag]: return a specified flag for a provided ndarray. -- [`ndarrayFlags( x )`][@stdlib/ndarray/flags]: return the flags of a provided ndarray. +- [`flag( x, name )`][@stdlib/ndarray/flag]: return a specified flag for a provided ndarray. +- [`flags( x )`][@stdlib/ndarray/flags]: return the flags of a provided ndarray. - [`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. +- [`indexModes()`][@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. - [`maybeBroadcastArrays( arrays )`][@stdlib/ndarray/maybe-broadcast-arrays]: broadcast ndarrays to a common 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. +- [`minDataType( value )`][@stdlib/ndarray/min-dtype]: determine the minimum ndarray data type of the closest "kind" necessary for storing a provided scalar value. +- [`mostlySafeCasts( [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. +- [`nextDataType( [dtype] )`][@stdlib/ndarray/next-dtype]: return the next larger ndarray data type of the same kind. - [`numelDimension( x, dim )`][@stdlib/ndarray/numel-dimension]: return the size (i.e., number of elements) of a specified dimension for a provided ndarray. - [`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. -- [`ndsliceFrom( x, ...start[, options] )`][@stdlib/ndarray/slice-from]: return a read-only shifted view of an input ndarray. -- [`ndsliceTo( x, ...stop[, options] )`][@stdlib/ndarray/slice-to]: return a read-only truncated view of an input ndarray. -- [`ndslice( x, ...s[, options] )`][@stdlib/ndarray/slice]: return a read-only view of an input `ndarray`. -- [`ndarrayStride( x, dim )`][@stdlib/ndarray/stride]: return the stride along a specified dimension for a provided ndarray. -- [`ndarrayStrides( x )`][@stdlib/ndarray/strides]: return the strides of a provided ndarray. +- [`offset( x )`][@stdlib/ndarray/offset]: return the index offset specifying the underlying buffer index of the first iterated ndarray element. +- [`order( x )`][@stdlib/ndarray/order]: return the layout order of a provided ndarray. +- [`orders()`][@stdlib/ndarray/orders]: list of ndarray orders. +- [`outputDataTypePolicies()`][@stdlib/ndarray/output-dtype-policies]: list of output ndarray data type policies. +- [`promotionRules( [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. +- [`safeCasts( [dtype] )`][@stdlib/ndarray/safe-casts]: return a list of ndarray data types to which a provided ndarray data type can be safely cast. +- [`sameKindCasts( [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". +- [`shape( x )`][@stdlib/ndarray/shape]: return the shape of a provided ndarray. +- [`sliceAssign( x, y, ...s[, options] )`][@stdlib/ndarray/slice-assign]: assign element values from a broadcasted input `ndarray` to corresponding elements in an output `ndarray` view. +- [`sliceDimensionFrom( x, dim, start[, options] )`][@stdlib/ndarray/slice-dimension-from]: return a read-only shifted view of an input `ndarray` along a specified dimension. +- [`sliceDimensionTo( x, dim, stop[, options] )`][@stdlib/ndarray/slice-dimension-to]: return a read-only truncated view of an input `ndarray` along a specified dimension. +- [`sliceDimension( x, dim, slice[, options] )`][@stdlib/ndarray/slice-dimension]: return a read-only view of an input `ndarray` when sliced along a specified dimension. +- [`sliceFrom( x, ...start[, options] )`][@stdlib/ndarray/slice-from]: return a read-only shifted view of an input ndarray. +- [`sliceTo( x, ...stop[, options] )`][@stdlib/ndarray/slice-to]: return a read-only truncated view of an input ndarray. +- [`slice( x, ...s[, options] )`][@stdlib/ndarray/slice]: return a read-only view of an input `ndarray`. +- [`stride( x, dim )`][@stdlib/ndarray/stride]: return the stride along a specified dimension for a provided ndarray. +- [`strides( 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( 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. +- [`zerosLike( x[, options] )`][@stdlib/ndarray/zeros-like]: create a zero-filled ndarray having the same shape and data type as a provided ndarray. +- [`zeros( shape[, options] )`][@stdlib/ndarray/zeros]: create a zero-filled ndarray having a specified shape and data type.