@stdlib/array/lib/index.js

Arrays.

/**
* @license Apache-2.0
*
* Copyright (c) 2018 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

'use strict';

/*
* 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: generic
*/

// MODULES //

var setReadOnly = require( '@stdlib/utils/define-read-only-property' );


// MAIN //

/**
* Top-level namespace.
*
* @namespace ns
*/
var ns = {};

/**
* @name base
* @memberof ns
* @readonly
* @type {Namespace}
* @see {@link module:@stdlib/array/base}
*/
setReadOnly( ns, 'base', require( './../base' ) );

/**
* @name BooleanArray
* @memberof ns
* @readonly
* @constructor
* @see {@link module:@stdlib/array/bool}
*/
setReadOnly( ns, 'BooleanArray', require( './../bool' ) );

/**
* @name ArrayBuffer
* @memberof ns
* @readonly
* @constructor
* @see {@link module:@stdlib/array/buffer}
*/
setReadOnly( ns, 'ArrayBuffer', require( './../buffer' ) );

/**
* @name byteOrders
* @memberof ns
* @readonly
* @constructor
* @see {@link module:@stdlib/array/byte-orders}
*/
setReadOnly( ns, 'byteOrders', require( './../byte-orders' ) );

/**
* @name cartesianPower
* @memberof ns
* @readonly
* @constructor
* @see {@link module:@stdlib/array/cartesian-power}
*/
setReadOnly( ns, 'cartesianPower', require( './../cartesian-power' ) );

/**
* @name cartesianProduct
* @memberof ns
* @readonly
* @constructor
* @see {@link module:@stdlib/array/cartesian-product}
*/
setReadOnly( ns, 'cartesianProduct', require( './../cartesian-product' ) );

/**
* @name cartesianSquare
* @memberof ns
* @readonly
* @constructor
* @see {@link module:@stdlib/array/cartesian-square}
*/
setReadOnly( ns, 'cartesianSquare', require( './../cartesian-square' ) );

/**
* @name Complex64Array
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/complex64}
*/
setReadOnly( ns, 'Complex64Array', require( './../complex64' ) );

/**
* @name Complex128Array
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/complex128}
*/
setReadOnly( ns, 'Complex128Array', require( './../complex128' ) );

/**
* @name convert
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/convert}
*/
setReadOnly( ns, 'convert', require( './../convert' ) );

/**
* @name convertSame
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/convert-same}
*/
setReadOnly( ns, 'convertSame', require( './../convert-same' ) );

/**
* @name ctors
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/ctors}
*/
setReadOnly( ns, 'ctors', require( './../ctors' ) );

/**
* @name DataView
* @memberof ns
* @readonly
* @constructor
* @see {@link module:@stdlib/array/dataview}
*/
setReadOnly( ns, 'DataView', require( './../dataview' ) );

/**
* @name datespace
* @memberof ns
* @readonly
* @constructor
* @see {@link module:@stdlib/array/datespace}
*/
setReadOnly( ns, 'datespace', require( './../datespace' ) );

/**
* @name defaults
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/defaults}
*/
setReadOnly( ns, 'defaults', require( './../defaults' ) );

/**
* @name dtype
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/dtype}
*/
setReadOnly( ns, 'dtype', require( './../dtype' ) );

/**
* @name dtypes
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/dtypes}
*/
setReadOnly( ns, 'dtypes', require( './../dtypes' ) );

/**
* @name empty
* @memberof ns
* @readonly
* @constructor
* @see {@link module:@stdlib/array/empty}
*/
setReadOnly( ns, 'empty', require( './../empty' ) );

/**
* @name emptyLike
* @memberof ns
* @readonly
* @constructor
* @see {@link module:@stdlib/array/empty-like}
*/
setReadOnly( ns, 'emptyLike', require( './../empty-like' ) );

/**
* @name filled
* @memberof ns
* @readonly
* @constructor
* @see {@link module:@stdlib/array/filled}
*/
setReadOnly( ns, 'filled', require( './../filled' ) );

/**
* @name filledBy
* @memberof ns
* @readonly
* @constructor
* @see {@link module:@stdlib/array/filled-by}
*/
setReadOnly( ns, 'filledBy', require( './../filled-by' ) );

/**
* @name fixedEndianFactory
* @memberof ns
* @readonly
* @constructor
* @see {@link module:@stdlib/array/fixed-endian-factory}
*/
setReadOnly( ns, 'fixedEndianFactory', require( './../fixed-endian-factory' ) );

/**
* @name Float32ArrayFE
* @memberof ns
* @readonly
* @constructor
* @see {@link module:@stdlib/array/fixed-endian-float32}
*/
setReadOnly( ns, 'Float32ArrayFE', require( './../fixed-endian-float32' ) );

/**
* @name Float64ArrayFE
* @memberof ns
* @readonly
* @constructor
* @see {@link module:@stdlib/array/fixed-endian-float64}
*/
setReadOnly( ns, 'Float64ArrayFE', require( './../fixed-endian-float64' ) );

/**
* @name Float32Array
* @memberof ns
* @readonly
* @constructor
* @see {@link module:@stdlib/array/float32}
*/
setReadOnly( ns, 'Float32Array', require( './../float32' ) );

/**
* @name Float64Array
* @memberof ns
* @readonly
* @constructor
* @see {@link module:@stdlib/array/float64}
*/
setReadOnly( ns, 'Float64Array', require( './../float64' ) );

/**
* @name iterator2array
* @memberof ns
* @readonly
* @constructor
* @see {@link module:@stdlib/array/from-iterator}
*/
setReadOnly( ns, 'iterator2array', require( './../from-iterator' ) );

/**
* @name scalar2array
* @memberof ns
* @readonly
* @constructor
* @see {@link module:@stdlib/array/from-scalar}
*/
setReadOnly( ns, 'scalar2array', require( './../from-scalar' ) );

/**
* @name full
* @memberof ns
* @readonly
* @constructor
* @see {@link module:@stdlib/array/full}
*/
setReadOnly( ns, 'full', require( './../full' ) );

/**
* @name fullLike
* @memberof ns
* @readonly
* @constructor
* @see {@link module:@stdlib/array/full-like}
*/
setReadOnly( ns, 'fullLike', require( './../full-like' ) );

/**
* @name incrspace
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/incrspace}
*/
setReadOnly( ns, 'incrspace', require( './../incrspace' ) );

/**
* @name ArrayIndex
* @memberof ns
* @readonly
* @constructor
* @see {@link module:@stdlib/array/index}
*/
setReadOnly( ns, 'ArrayIndex', require( './../index' ) );

/**
* @name Int8Array
* @memberof ns
* @readonly
* @constructor
* @see {@link module:@stdlib/array/int8}
*/
setReadOnly( ns, 'Int8Array', require( './../int8' ) );

/**
* @name Int16Array
* @memberof ns
* @readonly
* @constructor
* @see {@link module:@stdlib/array/int16}
*/
setReadOnly( ns, 'Int16Array', require( './../int16' ) );

/**
* @name Int32Array
* @memberof ns
* @readonly
* @constructor
* @see {@link module:@stdlib/array/int32}
*/
setReadOnly( ns, 'Int32Array', require( './../int32' ) );

/**
* @name linspace
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/linspace}
*/
setReadOnly( ns, 'linspace', require( './../linspace' ) );

/**
* @name littleEndianFactory
* @memberof ns
* @readonly
* @constructor
* @see {@link module:@stdlib/array/little-endian-factory}
*/
setReadOnly( ns, 'littleEndianFactory', require( './../little-endian-factory' ) );

/**
* @name Float32ArrayLE
* @memberof ns
* @readonly
* @constructor
* @see {@link module:@stdlib/array/little-endian-float32}
*/
setReadOnly( ns, 'Float32ArrayLE', require( './../little-endian-float32' ) );

/**
* @name Float64ArrayLE
* @memberof ns
* @readonly
* @constructor
* @see {@link module:@stdlib/array/little-endian-float64}
*/
setReadOnly( ns, 'Float64ArrayLE', require( './../little-endian-float64' ) );

/**
* @name logspace
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/logspace}
*/
setReadOnly( ns, 'logspace', require( './../logspace' ) );

/**
* @name minDataType
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/min-dtype}
*/
setReadOnly( ns, 'minDataType', require( './../min-dtype' ) );

/**
* @name mostlySafeCasts
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/mostly-safe-casts}
*/
setReadOnly( ns, 'mostlySafeCasts', require( './../mostly-safe-casts' ) );

/**
* @name mskfilter
* @memberof ns
* @readonly
* @constructor
* @see {@link module:@stdlib/array/mskfilter}
*/
setReadOnly( ns, 'mskfilter', require( './../mskfilter' ) );

/**
* @name mskput
* @memberof ns
* @readonly
* @constructor
* @see {@link module:@stdlib/array/mskput}
*/
setReadOnly( ns, 'mskput', require( './../mskput' ) );

/**
* @name mskreject
* @memberof ns
* @readonly
* @constructor
* @see {@link module:@stdlib/array/mskreject}
*/
setReadOnly( ns, 'mskreject', require( './../mskreject' ) );

/**
* @name nans
* @memberof ns
* @readonly
* @constructor
* @see {@link module:@stdlib/array/nans}
*/
setReadOnly( ns, 'nans', require( './../nans' ) );

/**
* @name nansLike
* @memberof ns
* @readonly
* @constructor
* @see {@link module:@stdlib/array/nans-like}
*/
setReadOnly( ns, 'nansLike', require( './../nans-like' ) );

/**
* @name nextDataType
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/next-dtype}
*/
setReadOnly( ns, 'nextDataType', require( './../next-dtype' ) );

/**
* @name oneTo
* @memberof ns
* @readonly
* @constructor
* @see {@link module:@stdlib/array/one-to}
*/
setReadOnly( ns, 'oneTo', require( './../one-to' ) );

/**
* @name oneToLike
* @memberof ns
* @readonly
* @constructor
* @see {@link module:@stdlib/array/one-to-like}
*/
setReadOnly( ns, 'oneToLike', require( './../one-to-like' ) );

/**
* @name ones
* @memberof ns
* @readonly
* @constructor
* @see {@link module:@stdlib/array/ones}
*/
setReadOnly( ns, 'ones', require( './../ones' ) );

/**
* @name onesLike
* @memberof ns
* @readonly
* @constructor
* @see {@link module:@stdlib/array/ones-like}
*/
setReadOnly( ns, 'onesLike', require( './../ones-like' ) );

/**
* @name place
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/place}
*/
setReadOnly( ns, 'place', require( './../place' ) );

/**
* @name typedarraypool
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/pool}
*/
setReadOnly( ns, 'typedarraypool', require( './../pool' ) );

/**
* @name promotionRules
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/promotion-rules}
*/
setReadOnly( ns, 'promotionRules', require( './../promotion-rules' ) );

/**
* @name put
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/put}
*/
setReadOnly( ns, 'put', require( './../put' ) );

/**
* @name typedarrayReviver
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/reviver}
*/
setReadOnly( ns, 'typedarrayReviver', require( './../reviver' ) );

/**
* @name safeCasts
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/safe-casts}
*/
setReadOnly( ns, 'safeCasts', require( './../safe-casts' ) );

/**
* @name sameKindCasts
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/same-kind-casts}
*/
setReadOnly( ns, 'sameKindCasts', require( './../same-kind-casts' ) );

/**
* @name shape
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/shape}
*/
setReadOnly( ns, 'shape', require( './../shape' ) );

/**
* @name SharedArrayBuffer
* @memberof ns
* @readonly
* @constructor
* @see {@link module:@stdlib/array/shared-buffer}
*/
setReadOnly( ns, 'SharedArrayBuffer', require( './../shared-buffer' ) );

/**
* @name slice
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/slice}
*/
setReadOnly( ns, 'slice', require( './../slice' ) );

/**
* @name take
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/take}
*/
setReadOnly( ns, 'take', require( './../take' ) );

/**
* @name circarray2iterator
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/to-circular-iterator}
*/
setReadOnly( ns, 'circarray2iterator', require( './../to-circular-iterator' ) );

/**
* @name array2fancy
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/to-fancy}
*/
setReadOnly( ns, 'array2fancy', require( './../to-fancy' ) );

/**
* @name array2iterator
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/to-iterator}
*/
setReadOnly( ns, 'array2iterator', require( './../to-iterator' ) );

/**
* @name array2iteratorRight
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/to-iterator-right}
*/
setReadOnly( ns, 'array2iteratorRight', require( './../to-iterator-right' ) );

/**
* @name typedarray2json
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/to-json}
*/
setReadOnly( ns, 'typedarray2json', require( './../to-json' ) );

/**
* @name sparsearray2iterator
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/to-sparse-iterator}
*/
setReadOnly( ns, 'sparsearray2iterator', require( './../to-sparse-iterator' ) );

/**
* @name sparsearray2iteratorRight
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/to-sparse-iterator-right}
*/
setReadOnly( ns, 'sparsearray2iteratorRight', require( './../to-sparse-iterator-right' ) );

/**
* @name stridedarray2iterator
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/to-strided-iterator}
*/
setReadOnly( ns, 'stridedarray2iterator', require( './../to-strided-iterator' ) );

/**
* @name arrayview2iterator
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/to-view-iterator}
*/
setReadOnly( ns, 'arrayview2iterator', require( './../to-view-iterator' ) );

/**
* @name arrayview2iteratorRight
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/to-view-iterator-right}
*/
setReadOnly( ns, 'arrayview2iteratorRight', require( './../to-view-iterator-right' ) );

/**
* @name typedarray
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/typed}
*/
setReadOnly( ns, 'typedarray', require( './../typed' ) );

/**
* @name complexarray
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/typed-complex}
*/
setReadOnly( ns, 'complexarray', require( './../typed-complex' ) );

/**
* @name complexarrayCtors
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/typed-complex-ctors}
*/
setReadOnly( ns, 'complexarrayCtors', require( './../typed-complex-ctors' ) );

/**
* @name complexarrayDataTypes
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/typed-complex-dtypes}
*/
setReadOnly( ns, 'complexarrayDataTypes', require( './../typed-complex-dtypes' ) );

/**
* @name typedarrayCtors
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/typed-ctors}
*/
setReadOnly( ns, 'typedarrayCtors', require( './../typed-ctors' ) );

/**
* @name typedarrayDataTypes
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/typed-dtypes}
*/
setReadOnly( ns, 'typedarrayDataTypes', require( './../typed-dtypes' ) );

/**
* @name floatarrayCtors
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/typed-float-ctors}
*/
setReadOnly( ns, 'floatarrayCtors', require( './../typed-float-ctors' ) );

/**
* @name floatarrayDataTypes
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/typed-float-dtypes}
*/
setReadOnly( ns, 'floatarrayDataTypes', require( './../typed-float-dtypes' ) );

/**
* @name intarrayCtors
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/typed-integer-ctors}
*/
setReadOnly( ns, 'intarrayCtors', require( './../typed-integer-ctors' ) );

/**
* @name intarrayDataTypes
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/typed-integer-dtypes}
*/
setReadOnly( ns, 'intarrayDataTypes', require( './../typed-integer-dtypes' ) );

/**
* @name realarray
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/typed-real}
*/
setReadOnly( ns, 'realarray', require( './../typed-real' ) );

/**
* @name realarrayCtors
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/typed-real-ctors}
*/
setReadOnly( ns, 'realarrayCtors', require( './../typed-real-ctors' ) );

/**
* @name realarrayDataTypes
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/typed-real-dtypes}
*/
setReadOnly( ns, 'realarrayDataTypes', require( './../typed-real-dtypes' ) );

/**
* @name realarrayFloatCtors
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/typed-real-float-ctors}
*/
setReadOnly( ns, 'realarrayFloatCtors', require( './../typed-real-float-ctors' ) );

/**
* @name realarrayFloatDataTypes
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/typed-real-float-dtypes}
*/
setReadOnly( ns, 'realarrayFloatDataTypes', require( './../typed-real-float-dtypes' ) );

/**
* @name intarraySignedCtors
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/typed-signed-integer-ctors}
*/
setReadOnly( ns, 'intarraySignedCtors', require( './../typed-signed-integer-ctors' ) );

/**
* @name intarraySignedDataTypes
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/typed-signed-integer-dtypes}
*/
setReadOnly( ns, 'intarraySignedDataTypes', require( './../typed-signed-integer-dtypes' ) );

/**
* @name intarrayUnsignedCtors
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/typed-unsigned-integer-ctors}
*/
setReadOnly( ns, 'intarrayUnsignedCtors', require( './../typed-unsigned-integer-ctors' ) );

/**
* @name intarrayUnsignedDataTypes
* @memberof ns
* @readonly
* @type {Function}
* @see {@link module:@stdlib/array/typed-unsigned-integer-dtypes}
*/
setReadOnly( ns, 'intarrayUnsignedDataTypes', require( './../typed-unsigned-integer-dtypes' ) );

/**
* @name Uint8Array
* @memberof ns
* @readonly
* @constructor
* @see {@link module:@stdlib/array/uint8}
*/
setReadOnly( ns, 'Uint8Array', require( './../uint8' ) );

/**
* @name Uint8ClampedArray
* @memberof ns
* @readonly
* @constructor
* @see {@link module:@stdlib/array/uint8c}
*/
setReadOnly( ns, 'Uint8ClampedArray', require( './../uint8c' ) );

/**
* @name Uint16Array
* @memberof ns
* @readonly
* @constructor
* @see {@link module:@stdlib/array/uint16}
*/
setReadOnly( ns, 'Uint16Array', require( './../uint16' ) );

/**
* @name Uint32Array
* @memberof ns
* @readonly
* @constructor
* @see {@link module:@stdlib/array/uint32}
*/
setReadOnly( ns, 'Uint32Array', require( './../uint32' ) );

/**
* @name zeroTo
* @memberof ns
* @readonly
* @constructor
* @see {@link module:@stdlib/array/zero-to}
*/
setReadOnly( ns, 'zeroTo', require( './../zero-to' ) );

/**
* @name zeroToLike
* @memberof ns
* @readonly
* @constructor
* @see {@link module:@stdlib/array/zero-to-like}
*/
setReadOnly( ns, 'zeroToLike', require( './../zero-to-like' ) );

/**
* @name zeros
* @memberof ns
* @readonly
* @constructor
* @see {@link module:@stdlib/array/zeros}
*/
setReadOnly( ns, 'zeros', require( './../zeros' ) );

/**
* @name zerosLike
* @memberof ns
* @readonly
* @constructor
* @see {@link module:@stdlib/array/zeros-like}
*/
setReadOnly( ns, 'zerosLike', require( './../zeros-like' ) );

/**
* @name constants
* @memberof ns
* @readonly
* @type {Namespace}
* @see {@link module:@stdlib/constants/array}
*/
setReadOnly( ns, 'constants', require( '@stdlib/constants/array' ) );


// EXPORTS //

module.exports = ns;