@stdlib/ndarray-base 0.0.6 → 0.1.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,24 @@ var ns = {};
 */
 setReadOnly( ns, 'assert', require( '@stdlib/ndarray-base-assert' ) );
 
+/**
+* @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 +85,15 @@ setReadOnly( ns, 'bind2vind', require( '@stdlib/ndarray-base-bind2vind' ) );
 */
 setReadOnly( ns, 'broadcastArray', require( '@stdlib/ndarray-base-broadcast-array' ) );
 
+/**
+* @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
@@ -117,6 +148,15 @@ setReadOnly( ns, 'bufferDataTypeEnum', require( '@stdlib/ndarray-base-buffer-dty
 */
 setReadOnly( ns, 'bytesPerElement', require( '@stdlib/ndarray-base-bytes-per-element' ) );
 
+/**
+* @name char2dtype
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/char2dtype}
+*/
+setReadOnly( ns, 'char2dtype', require( '@stdlib/ndarray-base-char2dtype' ) );
+
 /**
 * @name clampIndex
 * @memberof ns
@@ -144,6 +184,60 @@ setReadOnly( ns, 'ndarray', require( '@stdlib/ndarray-base-ctor' ) );
 */
 setReadOnly( ns, 'dtypeChar', require( '@stdlib/ndarray-base-dtype-char' ) );
 
+/**
+* @name dtypeDesc
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/dtype-desc}
+*/
+setReadOnly( ns, 'dtypeDesc', require( '@stdlib/ndarray-base-dtype-desc' ) );
+
+/**
+* @name dtypeEnum2Str
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/dtype-enum2str}
+*/
+setReadOnly( ns, 'dtypeEnum2Str', require( '@stdlib/ndarray-base-dtype-enum2str' ) );
+
+/**
+* @name dtypeResolveEnum
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/dtype-resolve-enum}
+*/
+setReadOnly( ns, 'dtypeResolveEnum', require( '@stdlib/ndarray-base-dtype-resolve-enum' ) );
+
+/**
+* @name dtypeResolveStr
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/dtype-resolve-str}
+*/
+setReadOnly( ns, 'dtypeResolveStr', require( '@stdlib/ndarray-base-dtype-resolve-str' ) );
+
+/**
+* @name dtypeStr2Enum
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/dtype-str2enum}
+*/
+setReadOnly( ns, 'dtypeStr2Enum', require( '@stdlib/ndarray-base-dtype-str2enum' ) );
+
+/**
+* @name dtype2c
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/dtype2c}
+*/
+setReadOnly( ns, 'dtype2c', require( '@stdlib/ndarray-base-dtype2c' ) );
+
 /**
 * @name dtypes2signatures
 * @memberof ns
@@ -153,6 +247,42 @@ setReadOnly( ns, 'dtypeChar', require( '@stdlib/ndarray-base-dtype-char' ) );
 */
 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
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/expand-dimensions}
+*/
+setReadOnly( ns, 'expandDimensions', require( '@stdlib/ndarray-base-expand-dimensions' ) );
+
+/**
+* @name scalar2ndarray
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/from-scalar}
+*/
+setReadOnly( ns, 'scalar2ndarray', require( '@stdlib/ndarray-base-from-scalar' ) );
+
 /**
 * @name ind
 * @memberof ns
@@ -189,6 +319,24 @@ setReadOnly( ns, 'iterationOrder', require( '@stdlib/ndarray-base-iteration-orde
 */
 setReadOnly( ns, 'maxViewBufferIndex', require( '@stdlib/ndarray-base-max-view-buffer-index' ) );
 
+/**
+* @name maybeBroadcastArray
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/maybe-broadcast-array}
+*/
+setReadOnly( ns, 'maybeBroadcastArray', require( '@stdlib/ndarray-base-maybe-broadcast-array' ) );
+
+/**
+* @name metaDataProps
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/meta-data-props}
+*/
+setReadOnly( ns, 'metaDataProps', require( '@stdlib/ndarray-base-meta-data-props' ) );
+
 /**
 * @name minViewBufferIndex
 * @memberof ns
@@ -207,6 +355,15 @@ setReadOnly( ns, 'minViewBufferIndex', require( '@stdlib/ndarray-base-min-view-b
 */
 setReadOnly( ns, 'minmaxViewBufferIndex', require( '@stdlib/ndarray-base-minmax-view-buffer-index' ) );
 
+/**
+* @name ndarraylike2object
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/ndarraylike2object}
+*/
+setReadOnly( ns, 'ndarraylike2object', require( '@stdlib/ndarray-base-ndarraylike2object' ) );
+
 /**
 * @name nonsingletonDimensions
 * @memberof ns
@@ -216,6 +373,33 @@ setReadOnly( ns, 'minmaxViewBufferIndex', require( '@stdlib/ndarray-base-minmax-
 */
 setReadOnly( ns, 'nonsingletonDimensions', require( '@stdlib/ndarray-base-nonsingleton-dimensions' ) );
 
+/**
+* @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
@@ -225,6 +409,60 @@ setReadOnly( ns, 'nonsingletonDimensions', require( '@stdlib/ndarray-base-nonsin
 */
 setReadOnly( ns, 'numel', require( '@stdlib/ndarray-base-numel' ) );
 
+/**
+* @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
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/prepend-singleton-dimensions}
+*/
+setReadOnly( ns, 'prependSingletonDimensions', require( '@stdlib/ndarray-base-prepend-singleton-dimensions' ) );
+
+/**
+* @name removeSingletonDimensions
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/remove-singleton-dimensions}
+*/
+setReadOnly( ns, 'removeSingletonDimensions', require( '@stdlib/ndarray-base-remove-singleton-dimensions' ) );
+
 /**
 * @name serializeMetaData
 * @memberof ns
@@ -288,6 +526,60 @@ setReadOnly( ns, 'sub2ind', require( '@stdlib/ndarray-base-sub2ind' ) );
 */
 setReadOnly( ns, 'ndarray2array', require( '@stdlib/ndarray-base-to-array' ) );
 
+/**
+* @name transpose
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/transpose}
+*/
+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
@@ -306,6 +598,24 @@ setReadOnly( ns, 'vind2bind', require( '@stdlib/ndarray-base-vind2bind' ) );
 */
 setReadOnly( ns, 'wrapIndex', require( '@stdlib/ndarray-base-wrap-index' ) );
 
+/**
+* @name zeros
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/zeros}
+*/
+setReadOnly( ns, 'zeros', require( '@stdlib/ndarray-base-zeros' ) );
+
+/**
+* @name zerosLike
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/ndarray/base/zeros-like}
+*/
+setReadOnly( ns, 'zerosLike', require( '@stdlib/ndarray-base-zeros-like' ) );
+
 
 // EXPORTS //