index.js (1348B)
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 /** 22 * Typed array pool. 23 * 24 * @module @stdlib/array/pool 25 * 26 * @example 27 * var typedarraypool = require( '@stdlib/array/pool' ); 28 * 29 * // Allocate an array of doubles: 30 * var arr = typedarraypool( 5, 'float64' ); 31 * // returns <Float64Array>[ 0.0, 0.0, 0.0, 0.0, 0.0 ] 32 * 33 * arr[ 0 ] = 3.14; 34 * arr[ 1 ] = 3.14; 35 * 36 * // ... 37 * 38 * // Free the allocated memory to be used in a future allocation: 39 * typedarraypool.free( arr ); 40 */ 41 42 // MODULES // 43 44 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); 45 var typedarraypool = require( './main.js' ); 46 var factory = require( './factory.js' ); 47 48 49 // MAIN // 50 51 setReadOnly( typedarraypool, 'factory', factory ); 52 53 54 // EXPORTS // 55 56 module.exports = typedarraypool;