main.js (1757B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2018 The Stdlib Authors. 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 'use strict'; 20 21 // MODULES // 22 23 var factory = require( './factory.js' ); 24 25 26 // MAIN // 27 28 /** 29 * Returns an uninitialized typed array. 30 * 31 * ## Notes 32 * 33 * - Memory is **not** initialized. 34 * - Memory is lazily allocated. 35 * - If the function returns `null`, the function was unable to allocate a new typed array from the typed array pool (most likely due to insufficient memory). 36 * 37 * @name typedarraypool 38 * @type {Function} 39 * @param {(NonNegativeInteger|ArrayLikeObject)} [arg] - an array length or an array-like object 40 * @param {string} [dtype="float64"] - data type 41 * @throws {TypeError} must provide a valid array length or an array-like object 42 * @throws {TypeError} must provide a recognized data type 43 * @returns {(TypedArray|null)} typed array or null 44 * 45 * @example 46 * // Allocate an array of doubles: 47 * var arr = typedarraypool( 5, 'float64' ); 48 * // e.g., returns <Float64Array>[ 0.0, 0.0, 0.0, 0.0, 0.0 ] 49 * 50 * arr[ 0 ] = 3.14; 51 * arr[ 1 ] = 3.14; 52 * 53 * // ... 54 * 55 * // Free the allocated memory to be used in a future allocation: 56 * typedarraypool.free( arr ); 57 */ 58 var typedarraypool = factory(); 59 60 61 // EXPORTS // 62 63 module.exports = typedarraypool;