feat!: rename exported aliases

This commit renames aliases to more naturally map to package names.
Previously, exported aliases attempted to match the global REPL
namespace aliases. This made more sense when the main distributable
artifacts were a "flat" and "tree" bundle and we wanted to have
similar naming conventions across both. Times have changed, however,
and the use of REPL aliases in the "ndarray" namespace feels awkward
and are hard to predict from a user POV, without knowing the
conventions of the REPL global namespace. Accordingly, this commit
changes aliases to what we'd typically use for a nested namespace.

BREAKING CHANGE: rename exported aliases

To migrate, users should consult the documentation for the updated
aliases. For the most part, updating code should be as simple as
dropping an `ndarray` or `nd` prefix. For others, they should more
directly match, or be inferrable from, the package name.

Author: kgryte

lib/node_modules/@stdlib/ndarray/lib/index.js

@@ -46,13 +46,13 @@ var ns = {};
 setReadOnly( ns, 'array', require( '@stdlib/ndarray/array' ) );
 
 /**
-* @name ndat
+* @name at
 * @memberof ns
 * @readonly
 * @type {Function}
 * @see {@link module:@stdlib/ndarray/at}
 */
-setReadOnly( ns, 'ndat', require( '@stdlib/ndarray/at' ) );
+setReadOnly( ns, 'at', require( '@stdlib/ndarray/at' ) );
 
 /**
 * @name base
@@ -82,13 +82,13 @@ setReadOnly( ns, 'broadcastArray', require( '@stdlib/ndarray/broadcast-array' )
 setReadOnly( ns, 'broadcastArrays', require( '@stdlib/ndarray/broadcast-arrays' ) );
 
 /**
-* @name ndarrayCastingModes
+* @name castingModes
 * @memberof ns
 * @readonly
 * @type {Function}
 * @see {@link module:@stdlib/ndarray/casting-modes}
 */
-setReadOnly( ns, 'ndarrayCastingModes', require( '@stdlib/ndarray/casting-modes' ) );
+setReadOnly( ns, 'castingModes', require( '@stdlib/ndarray/casting-modes' ) );
 
 /**
 * @name ndarray
@@ -100,13 +100,13 @@ setReadOnly( ns, 'ndarrayCastingModes', require( '@stdlib/ndarray/casting-modes'
 setReadOnly( ns, 'ndarray', require( '@stdlib/ndarray/ctor' ) );
 
 /**
-* @name ndarrayDataBuffer
+* @name dataBuffer
 * @memberof ns
 * @readonly
 * @type {Function}
 * @see {@link module:@stdlib/ndarray/data-buffer}
 */
-setReadOnly( ns, 'ndarrayDataBuffer', require( '@stdlib/ndarray/data-buffer' ) );
+setReadOnly( ns, 'dataBuffer', require( '@stdlib/ndarray/data-buffer' ) );
 
 /**
 * @name defaults
@@ -127,40 +127,40 @@ setReadOnly( ns, 'defaults', require( '@stdlib/ndarray/defaults' ) );
 setReadOnly( ns, 'dispatch', require( '@stdlib/ndarray/dispatch' ) );
 
 /**
-* @name ndarrayDataType
+* @name dtype
 * @memberof ns
 * @readonly
 * @type {Function}
 * @see {@link module:@stdlib/ndarray/dtype}
 */
-setReadOnly( ns, 'ndarrayDataType', require( '@stdlib/ndarray/dtype' ) );
+setReadOnly( ns, 'dtype', require( '@stdlib/ndarray/dtype' ) );
 
 /**
-* @name ndarrayDataTypes
+* @name dtypes
 * @memberof ns
 * @readonly
 * @type {Function}
 * @see {@link module:@stdlib/ndarray/dtypes}
 */
-setReadOnly( ns, 'ndarrayDataTypes', require( '@stdlib/ndarray/dtypes' ) );
+setReadOnly( ns, 'dtypes', require( '@stdlib/ndarray/dtypes' ) );
 
 /**
-* @name ndempty
+* @name empty
 * @memberof ns
 * @readonly
 * @type {Function}
 * @see {@link module:@stdlib/ndarray/empty}
 */
-setReadOnly( ns, 'ndempty', require( '@stdlib/ndarray/empty' ) );
+setReadOnly( ns, 'empty', require( '@stdlib/ndarray/empty' ) );
 
 /**
-* @name ndemptyLike
+* @name emptyLike
 * @memberof ns
 * @readonly
 * @type {Function}
 * @see {@link module:@stdlib/ndarray/empty-like}
 */
-setReadOnly( ns, 'ndemptyLike', require( '@stdlib/ndarray/empty-like' ) );
+setReadOnly( ns, 'emptyLike', require( '@stdlib/ndarray/empty-like' ) );
 
 /**
 * @name FancyArray
@@ -172,22 +172,22 @@ setReadOnly( ns, 'ndemptyLike', require( '@stdlib/ndarray/empty-like' ) );
 setReadOnly( ns, 'FancyArray', require( '@stdlib/ndarray/fancy' ) );
 
 /**
-* @name ndarrayFlag
+* @name flag
 * @memberof ns
 * @readonly
 * @type {Function}
 * @see {@link module:@stdlib/ndarray/flag}
 */
-setReadOnly( ns, 'ndarrayFlag', require( '@stdlib/ndarray/flag' ) );
+setReadOnly( ns, 'flag', require( '@stdlib/ndarray/flag' ) );
 
 /**
-* @name ndarrayFlags
+* @name flags
 * @memberof ns
 * @readonly
 * @type {Function}
 * @see {@link module:@stdlib/ndarray/flags}
 */
-setReadOnly( ns, 'ndarrayFlags', require( '@stdlib/ndarray/flags' ) );
+setReadOnly( ns, 'flags', require( '@stdlib/ndarray/flags' ) );
 
 /**
 * @name scalar2ndarray
@@ -208,13 +208,13 @@ setReadOnly( ns, 'scalar2ndarray', require( '@stdlib/ndarray/from-scalar' ) );
 setReadOnly( ns, 'ind2sub', require( '@stdlib/ndarray/ind2sub' ) );
 
 /**
-* @name ndarrayIndexModes
+* @name indexModes
 * @memberof ns
 * @readonly
 * @type {Function}
 * @see {@link module:@stdlib/ndarray/index-modes}
 */
-setReadOnly( ns, 'ndarrayIndexModes', require( '@stdlib/ndarray/index-modes' ) );
+setReadOnly( ns, 'indexModes', require( '@stdlib/ndarray/index-modes' ) );
 
 /**
 * @name iter
@@ -244,22 +244,22 @@ setReadOnly( ns, 'maybeBroadcastArray', require( '@stdlib/ndarray/maybe-broadcas
 setReadOnly( ns, 'maybeBroadcastArrays', require( '@stdlib/ndarray/maybe-broadcast-arrays' ) );
 
 /**
-* @name ndarrayMinDataType
+* @name minDataType
 * @memberof ns
 * @readonly
 * @type {Function}
 * @see {@link module:@stdlib/ndarray/min-dtype}
 */
-setReadOnly( ns, 'ndarrayMinDataType', require( '@stdlib/ndarray/min-dtype' ) );
+setReadOnly( ns, 'minDataType', require( '@stdlib/ndarray/min-dtype' ) );
 
 /**
-* @name ndarrayMostlySafeCasts
+* @name mostlySafeCasts
 * @memberof ns
 * @readonly
 * @type {Function}
 * @see {@link module:@stdlib/ndarray/mostly-safe-casts}
 */
-setReadOnly( ns, 'ndarrayMostlySafeCasts', require( '@stdlib/ndarray/mostly-safe-casts' ) );
+setReadOnly( ns, 'mostlySafeCasts', require( '@stdlib/ndarray/mostly-safe-casts' ) );
 
 /**
 * @name ndims
@@ -271,13 +271,13 @@ setReadOnly( ns, 'ndarrayMostlySafeCasts', require( '@stdlib/ndarray/mostly-safe
 setReadOnly( ns, 'ndims', require( '@stdlib/ndarray/ndims' ) );
 
 /**
-* @name ndarrayNextDataType
+* @name nextDataType
 * @memberof ns
 * @readonly
 * @type {Function}
 * @see {@link module:@stdlib/ndarray/next-dtype}
 */
-setReadOnly( ns, 'ndarrayNextDataType', require( '@stdlib/ndarray/next-dtype' ) );
+setReadOnly( ns, 'nextDataType', require( '@stdlib/ndarray/next-dtype' ) );
 
 /**
 * @name numel
@@ -298,88 +298,88 @@ setReadOnly( ns, 'numel', require( '@stdlib/ndarray/numel' ) );
 setReadOnly( ns, 'numelDimension', require( '@stdlib/ndarray/numel-dimension' ) );
 
 /**
-* @name ndarrayOffset
+* @name offset
 * @memberof ns
 * @readonly
 * @type {Function}
 * @see {@link module:@stdlib/ndarray/offset}
 */
-setReadOnly( ns, 'ndarrayOffset', require( '@stdlib/ndarray/offset' ) );
+setReadOnly( ns, 'offset', require( '@stdlib/ndarray/offset' ) );
 
 /**
-* @name ndarrayOrder
+* @name order
 * @memberof ns
 * @readonly
 * @type {Function}
 * @see {@link module:@stdlib/ndarray/order}
 */
-setReadOnly( ns, 'ndarrayOrder', require( '@stdlib/ndarray/order' ) );
+setReadOnly( ns, 'order', require( '@stdlib/ndarray/order' ) );
 
 /**
-* @name ndarrayOrders
+* @name orders
 * @memberof ns
 * @readonly
 * @type {Function}
 * @see {@link module:@stdlib/ndarray/orders}
 */
-setReadOnly( ns, 'ndarrayOrders', require( '@stdlib/ndarray/orders' ) );
+setReadOnly( ns, 'orders', require( '@stdlib/ndarray/orders' ) );
 
 /**
-* @name ndarrayOutputDataTypePolicies
+* @name outputDataTypePolicies
 * @memberof ns
 * @readonly
 * @type {Function}
 * @see {@link module:@stdlib/ndarray/output-dtype-policies}
 */
-setReadOnly( ns, 'ndarrayOutputDataTypePolicies', require( '@stdlib/ndarray/output-dtype-policies' ) );
+setReadOnly( ns, 'outputDataTypePolicies', require( '@stdlib/ndarray/output-dtype-policies' ) );
 
 /**
-* @name ndarrayPromotionRules
+* @name promotionRules
 * @memberof ns
 * @readonly
 * @type {Function}
 * @see {@link module:@stdlib/ndarray/promotion-rules}
 */
-setReadOnly( ns, 'ndarrayPromotionRules', require( '@stdlib/ndarray/promotion-rules' ) );
+setReadOnly( ns, 'promotionRules', require( '@stdlib/ndarray/promotion-rules' ) );
 
 /**
-* @name ndarraySafeCasts
+* @name safeCasts
 * @memberof ns
 * @readonly
 * @type {Function}
 * @see {@link module:@stdlib/ndarray/safe-casts}
 */
-setReadOnly( ns, 'ndarraySafeCasts', require( '@stdlib/ndarray/safe-casts' ) );
+setReadOnly( ns, 'safeCasts', require( '@stdlib/ndarray/safe-casts' ) );
 
 /**
-* @name ndarraySameKindCasts
+* @name sameKindCasts
 * @memberof ns
 * @readonly
 * @type {Function}
 * @see {@link module:@stdlib/ndarray/same-kind-casts}
 */
-setReadOnly( ns, 'ndarraySameKindCasts', require( '@stdlib/ndarray/same-kind-casts' ) );
+setReadOnly( ns, 'sameKindCasts', require( '@stdlib/ndarray/same-kind-casts' ) );
 
 /**
-* @name ndarrayShape
+* @name shape
 * @memberof ns
 * @readonly
 * @type {Function}
 * @see {@link module:@stdlib/ndarray/shape}
 */
-setReadOnly( ns, 'ndarrayShape', require( '@stdlib/ndarray/shape' ) );
+setReadOnly( ns, 'shape', require( '@stdlib/ndarray/shape' ) );
 
 /**
-* @name ndslice
+* @name slice
 * @memberof ns
 * @readonly
 * @type {Function}
 * @see {@link module:@stdlib/ndarray/slice}
 */
-setReadOnly( ns, 'ndslice', require( '@stdlib/ndarray/slice' ) );
+setReadOnly( ns, 'slice', require( '@stdlib/ndarray/slice' ) );
 
 /**
-* @name ndsliceAssign
+* @name sliceAssign
 * @memberof ns
 * @readonly
 * @type {Function}
@@ -388,67 +388,67 @@ setReadOnly( ns, 'ndslice', require( '@stdlib/ndarray/slice' ) );
 setReadOnly( ns, 'ndsliceAssign', require( '@stdlib/ndarray/slice-assign' ) );
 
 /**
-* @name ndsliceDimension
+* @name sliceDimension
 * @memberof ns
 * @readonly
 * @type {Function}
 * @see {@link module:@stdlib/ndarray/slice-dimension}
 */
-setReadOnly( ns, 'ndsliceDimension', require( '@stdlib/ndarray/slice-dimension' ) );
+setReadOnly( ns, 'sliceDimension', require( '@stdlib/ndarray/slice-dimension' ) );
 
 /**
-* @name ndsliceDimensionFrom
+* @name sliceDimensionFrom
 * @memberof ns
 * @readonly
 * @type {Function}
 * @see {@link module:@stdlib/ndarray/slice-dimension-from}
 */
-setReadOnly( ns, 'ndsliceDimensionFrom', require( '@stdlib/ndarray/slice-dimension-from' ) );
+setReadOnly( ns, 'sliceDimensionFrom', require( '@stdlib/ndarray/slice-dimension-from' ) );
 
 /**
-* @name ndsliceDimensionTo
+* @name sliceDimensionTo
 * @memberof ns
 * @readonly
 * @type {Function}
 * @see {@link module:@stdlib/ndarray/slice-dimension-to}
 */
-setReadOnly( ns, 'ndsliceDimensionTo', require( '@stdlib/ndarray/slice-dimension-to' ) );
+setReadOnly( ns, 'sliceDimensionTo', require( '@stdlib/ndarray/slice-dimension-to' ) );
 
 /**
-* @name ndsliceFrom
+* @name sliceFrom
 * @memberof ns
 * @readonly
 * @type {Function}
 * @see {@link module:@stdlib/ndarray/slice-from}
 */
-setReadOnly( ns, 'ndsliceFrom', require( '@stdlib/ndarray/slice-from' ) );
+setReadOnly( ns, 'sliceFrom', require( '@stdlib/ndarray/slice-from' ) );
 
 /**
-* @name ndsliceTo
+* @name sliceTo
 * @memberof ns
 * @readonly
 * @type {Function}
 * @see {@link module:@stdlib/ndarray/slice-to}
 */
-setReadOnly( ns, 'ndsliceTo', require( '@stdlib/ndarray/slice-to' ) );
+setReadOnly( ns, 'sliceTo', require( '@stdlib/ndarray/slice-to' ) );
 
 /**
-* @name ndarrayStride
+* @name stride
 * @memberof ns
 * @readonly
 * @type {Function}
 * @see {@link module:@stdlib/ndarray/stride}
 */
-setReadOnly( ns, 'ndarrayStride', require( '@stdlib/ndarray/stride' ) );
+setReadOnly( ns, 'stride', require( '@stdlib/ndarray/stride' ) );
 
 /**
-* @name ndarrayStrides
+* @name strides
 * @memberof ns
 * @readonly
 * @type {Function}
 * @see {@link module:@stdlib/ndarray/strides}
 */
-setReadOnly( ns, 'ndarrayStrides', require( '@stdlib/ndarray/strides' ) );
+setReadOnly( ns, 'strides', require( '@stdlib/ndarray/strides' ) );
 
 /**
 * @name sub2ind
@@ -469,22 +469,22 @@ setReadOnly( ns, 'sub2ind', require( '@stdlib/ndarray/sub2ind' ) );
 setReadOnly( ns, 'ndarray2array', require( '@stdlib/ndarray/to-array' ) );
 
 /**
-* @name ndzeros
+* @name zeros
 * @memberof ns
 * @readonly
 * @type {Function}
 * @see {@link module:@stdlib/ndarray/zeros}
 */
-setReadOnly( ns, 'ndzeros', require( '@stdlib/ndarray/zeros' ) );
+setReadOnly( ns, 'zeros', require( '@stdlib/ndarray/zeros' ) );
 
 /**
-* @name ndzerosLike
+* @name zerosLike
 * @memberof ns
 * @readonly
 * @type {Function}
 * @see {@link module:@stdlib/ndarray/zeros-like}
 */
-setReadOnly( ns, 'ndzerosLike', require( '@stdlib/ndarray/zeros-like' ) );
+setReadOnly( ns, 'zerosLike', require( '@stdlib/ndarray/zeros-like' ) );
 
 
 // EXPORTS //