@stdlib/ndarray-base 0.0.7 → 0.2.0

package/lib/index.js

@@ -22,6 +22,10 @@
 * When adding modules to the namespace, ensure that they are added in alphabetical order according to module name.
 */
 
+/*
+* The following modules are intentionally not exported: function-object, napi, unary
+*/
+
 // MODULES //
 
 var setReadOnly = require( '@stdlib/utils-define-read-only-property' );
@@ -45,6 +49,33 @@ var ns = {};
 */
 setReadOnly( ns, 'assert', require( '@stdlib/ndarray-base-assert' ) );
 
+/**
+* @name assign
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/assign}
+*/
+setReadOnly( ns, 'assign', require( '@stdlib/ndarray-base-assign' ) );
+
+/**
+* @name binaryLoopOrder
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/binary-loop-interchange-order}
+*/
+setReadOnly( ns, 'binaryLoopOrder', require( '@stdlib/ndarray-base-binary-loop-interchange-order' ) );
+
+/**
+* @name binaryBlockSize
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/binary-tiling-block-size}
+*/
+setReadOnly( ns, 'binaryBlockSize', require( '@stdlib/ndarray-base-binary-tiling-block-size' ) );
+
 /**
 * @name bind2vind
 * @memberof ns
@@ -63,6 +94,24 @@ setReadOnly( ns, 'bind2vind', require( '@stdlib/ndarray-base-bind2vind' ) );
 */
 setReadOnly( ns, 'broadcastArray', require( '@stdlib/ndarray-base-broadcast-array' ) );
 
+/**
+* @name broadcastArrays
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/broadcast-arrays}
+*/
+setReadOnly( ns, 'broadcastArrays', require( '@stdlib/ndarray-base-broadcast-arrays' ) );
+
+/**
+* @name broadcastScalar
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/broadcast-scalar}
+*/
+setReadOnly( ns, 'broadcastScalar', require( '@stdlib/ndarray-base-broadcast-scalar' ) );
+
 /**
 * @name broadcastShapes
 * @memberof ns
@@ -144,6 +193,24 @@ setReadOnly( ns, 'clampIndex', require( '@stdlib/ndarray-base-clamp-index' ) );
 */
 setReadOnly( ns, 'ndarray', require( '@stdlib/ndarray-base-ctor' ) );
 
+/**
+* @name data
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/data-buffer}
+*/
+setReadOnly( ns, 'data', require( '@stdlib/ndarray-base-data-buffer' ) );
+
+/**
+* @name dtype
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/dtype}
+*/
+setReadOnly( ns, 'dtype', require( '@stdlib/ndarray-base-dtype' ) );
+
 /**
 * @name dtypeChar
 * @memberof ns
@@ -216,6 +283,24 @@ setReadOnly( ns, 'dtype2c', require( '@stdlib/ndarray-base-dtype2c' ) );
 */
 setReadOnly( ns, 'dtypes2signatures', require( '@stdlib/ndarray-base-dtypes2signatures' ) );
 
+/**
+* @name empty
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/empty}
+*/
+setReadOnly( ns, 'empty', require( '@stdlib/ndarray-base-empty' ) );
+
+/**
+* @name emptyLike
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/empty-like}
+*/
+setReadOnly( ns, 'emptyLike', require( '@stdlib/ndarray-base-empty-like' ) );
+
 /**
 * @name expandDimensions
 * @memberof ns
@@ -225,6 +310,42 @@ setReadOnly( ns, 'dtypes2signatures', require( '@stdlib/ndarray-base-dtypes2sign
 */
 setReadOnly( ns, 'expandDimensions', require( '@stdlib/ndarray-base-expand-dimensions' ) );
 
+/**
+* @name flag
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/flag}
+*/
+setReadOnly( ns, 'flag', require( '@stdlib/ndarray-base-flag' ) );
+
+/**
+* @name flags
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/flags}
+*/
+setReadOnly( ns, 'flags', require( '@stdlib/ndarray-base-flags' ) );
+
+/**
+* @name fliplr
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/fliplr}
+*/
+setReadOnly( ns, 'fliplr', require( '@stdlib/ndarray-base-fliplr' ) );
+
+/**
+* @name flipud
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/flipud}
+*/
+setReadOnly( ns, 'flipud', require( '@stdlib/ndarray-base-flipud' ) );
+
 /**
 * @name scalar2ndarray
 * @memberof ns
@@ -279,6 +400,15 @@ setReadOnly( ns, 'maxViewBufferIndex', require( '@stdlib/ndarray-base-max-view-b
 */
 setReadOnly( ns, 'maybeBroadcastArray', require( '@stdlib/ndarray-base-maybe-broadcast-array' ) );
 
+/**
+* @name maybeBroadcastArrays
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/maybe-broadcast-arrays}
+*/
+setReadOnly( ns, 'maybeBroadcastArrays', require( '@stdlib/ndarray-base-maybe-broadcast-arrays' ) );
+
 /**
 * @name metaDataProps
 * @memberof ns
@@ -315,6 +445,24 @@ setReadOnly( ns, 'minmaxViewBufferIndex', require( '@stdlib/ndarray-base-minmax-
 */
 setReadOnly( ns, 'ndarraylike2object', require( '@stdlib/ndarray-base-ndarraylike2object' ) );
 
+/**
+* @name ndims
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/ndims}
+*/
+setReadOnly( ns, 'ndims', require( '@stdlib/ndarray-base-ndims' ) );
+
+/**
+* @name nextCartesianIndex
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/next-cartesian-index}
+*/
+setReadOnly( ns, 'nextCartesianIndex', require( '@stdlib/ndarray-base-next-cartesian-index' ) );
+
 /**
 * @name nonsingletonDimensions
 * @memberof ns
@@ -324,6 +472,42 @@ setReadOnly( ns, 'ndarraylike2object', require( '@stdlib/ndarray-base-ndarraylik
 */
 setReadOnly( ns, 'nonsingletonDimensions', require( '@stdlib/ndarray-base-nonsingleton-dimensions' ) );
 
+/**
+* @name normalizeIndex
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/normalize-index}
+*/
+setReadOnly( ns, 'normalizeIndex', require( '@stdlib/ndarray-base-normalize-index' ) );
+
+/**
+* @name nullary
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/nullary}
+*/
+setReadOnly( ns, 'nullary', require( '@stdlib/ndarray-base-nullary' ) );
+
+/**
+* @name nullaryLoopOrder
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/nullary-loop-interchange-order}
+*/
+setReadOnly( ns, 'nullaryLoopOrder', require( '@stdlib/ndarray-base-nullary-loop-interchange-order' ) );
+
+/**
+* @name nullaryBlockSize
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/nullary-tiling-block-size}
+*/
+setReadOnly( ns, 'nullaryBlockSize', require( '@stdlib/ndarray-base-nullary-tiling-block-size' ) );
+
 /**
 * @name numel
 * @memberof ns
@@ -333,6 +517,69 @@ setReadOnly( ns, 'nonsingletonDimensions', require( '@stdlib/ndarray-base-nonsin
 */
 setReadOnly( ns, 'numel', require( '@stdlib/ndarray-base-numel' ) );
 
+/**
+* @name numelDimension
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/numel-dimension}
+*/
+setReadOnly( ns, 'numelDimension', require( '@stdlib/ndarray-base-numel-dimension' ) );
+
+/**
+* @name offset
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/offset}
+*/
+setReadOnly( ns, 'offset', require( '@stdlib/ndarray-base-offset' ) );
+
+/**
+* @name order
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/order}
+*/
+setReadOnly( ns, 'order', require( '@stdlib/ndarray-base-order' ) );
+
+/**
+* @name outputPolicyEnum2Str
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/output-policy-enum2str}
+*/
+setReadOnly( ns, 'outputPolicyEnum2Str', require( '@stdlib/ndarray-base-output-policy-enum2str' ) );
+
+/**
+* @name outputPolicyResolveEnum
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/output-policy-resolve-enum}
+*/
+setReadOnly( ns, 'outputPolicyResolveEnum', require( '@stdlib/ndarray-base-output-policy-resolve-enum' ) );
+
+/**
+* @name outputPolicyResolveStr
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/output-policy-resolve-str}
+*/
+setReadOnly( ns, 'outputPolicyResolveStr', require( '@stdlib/ndarray-base-output-policy-resolve-str' ) );
+
+/**
+* @name outputPolicyStr2Enum
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/output-policy-str2enum}
+*/
+setReadOnly( ns, 'outputPolicyStr2Enum', require( '@stdlib/ndarray-base-output-policy-str2enum' ) );
+
 /**
 * @name prependSingletonDimensions
 * @memberof ns
@@ -351,6 +598,24 @@ setReadOnly( ns, 'prependSingletonDimensions', require( '@stdlib/ndarray-base-pr
 */
 setReadOnly( ns, 'removeSingletonDimensions', require( '@stdlib/ndarray-base-remove-singleton-dimensions' ) );
 
+/**
+* @name reverse
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/reverse}
+*/
+setReadOnly( ns, 'reverse', require( '@stdlib/ndarray-base-reverse' ) );
+
+/**
+* @name reverseDimension
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/reverse-dimension}
+*/
+setReadOnly( ns, 'reverseDimension', require( '@stdlib/ndarray-base-reverse-dimension' ) );
+
 /**
 * @name serializeMetaData
 * @memberof ns
@@ -360,6 +625,15 @@ setReadOnly( ns, 'removeSingletonDimensions', require( '@stdlib/ndarray-base-rem
 */
 setReadOnly( ns, 'serializeMetaData', require( '@stdlib/ndarray-base-serialize-meta-data' ) );
 
+/**
+* @name shape
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/shape}
+*/
+setReadOnly( ns, 'shape', require( '@stdlib/ndarray-base-shape' ) );
+
 /**
 * @name shape2strides
 * @memberof ns
@@ -378,6 +652,87 @@ setReadOnly( ns, 'shape2strides', require( '@stdlib/ndarray-base-shape2strides'
 */
 setReadOnly( ns, 'singletonDimensions', require( '@stdlib/ndarray-base-singleton-dimensions' ) );
 
+/**
+* @name slice
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/slice}
+*/
+setReadOnly( ns, 'slice', require( '@stdlib/ndarray-base-slice' ) );
+
+/**
+* @name sliceAssign
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/slice-assign}
+*/
+setReadOnly( ns, 'sliceAssign', require( '@stdlib/ndarray-base-slice-assign' ) );
+
+/**
+* @name sliceDimension
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/slice-dimension}
+*/
+setReadOnly( ns, 'sliceDimension', require( '@stdlib/ndarray-base-slice-dimension' ) );
+
+/**
+* @name sliceDimensionFrom
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/slice-dimension-from}
+*/
+setReadOnly( ns, 'sliceDimensionFrom', require( '@stdlib/ndarray-base-slice-dimension-from' ) );
+
+/**
+* @name sliceDimensionTo
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/slice-dimension-to}
+*/
+setReadOnly( ns, 'sliceDimensionTo', require( '@stdlib/ndarray-base-slice-dimension-to' ) );
+
+/**
+* @name sliceFrom
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/slice-from}
+*/
+setReadOnly( ns, 'sliceFrom', require( '@stdlib/ndarray-base-slice-from' ) );
+
+/**
+* @name sliceTo
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/slice-to}
+*/
+setReadOnly( ns, 'sliceTo', require( '@stdlib/ndarray-base-slice-to' ) );
+
+/**
+* @name stride
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/stride}
+*/
+setReadOnly( ns, 'stride', require( '@stdlib/ndarray-base-stride' ) );
+
+/**
+* @name strides
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/strides}
+*/
+setReadOnly( ns, 'strides', require( '@stdlib/ndarray-base-strides' ) );
+
 /**
 * @name strides2offset
 * @memberof ns
@@ -423,6 +778,51 @@ setReadOnly( ns, 'ndarray2array', require( '@stdlib/ndarray-base-to-array' ) );
 */
 setReadOnly( ns, 'transpose', require( '@stdlib/ndarray-base-transpose' ) );
 
+/**
+* @name unary
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/unary}
+*/
+setReadOnly( ns, 'unary', require( '@stdlib/ndarray-base-unary' ) );
+
+/**
+* @name unaryBy
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/unary-by}
+*/
+setReadOnly( ns, 'unaryBy', require( '@stdlib/ndarray-base-unary-by' ) );
+
+/**
+* @name unaryLoopOrder
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/unary-loop-interchange-order}
+*/
+setReadOnly( ns, 'unaryLoopOrder', require( '@stdlib/ndarray-base-unary-loop-interchange-order' ) );
+
+/**
+* @name unaryOutputDataType
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/unary-output-dtype}
+*/
+setReadOnly( ns, 'unaryOutputDataType', require( '@stdlib/ndarray-base-unary-output-dtype' ) );
+
+/**
+* @name unaryBlockSize
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/unary-tiling-block-size}
+*/
+setReadOnly( ns, 'unaryBlockSize', require( '@stdlib/ndarray-base-unary-tiling-block-size' ) );
+
 /**
 * @name vind2bind
 * @memberof ns