index.js (2216B)
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 * 64-bit complex number array. 23 * 24 * @module @stdlib/array/complex64 25 * 26 * @example 27 * var Complex64Array = require( '@stdlib/array/complex64' ); 28 * 29 * var arr = new Complex64Array(); 30 * // returns <Complex64Array> 31 * 32 * var len = arr.length; 33 * // returns 0 34 * 35 * @example 36 * var Complex64Array = require( '@stdlib/array/complex64' ); 37 * 38 * var arr = new Complex64Array( 2 ); 39 * // returns <Complex64Array> 40 * 41 * var len = arr.length; 42 * // returns 2 43 * 44 * @example 45 * var Complex64Array = require( '@stdlib/array/complex64' ); 46 * 47 * var arr = new Complex64Array( [ 1.0, -1.0 ] ); 48 * // returns <Complex64Array> 49 * 50 * var len = arr.length; 51 * // returns 1 52 * 53 * @example 54 * var ArrayBuffer = require( '@stdlib/array/buffer' ); 55 * var Complex64Array = require( '@stdlib/array/complex64' ); 56 * 57 * var buf = new ArrayBuffer( 16 ); 58 * var arr = new Complex64Array( buf ); 59 * // returns <Complex64Array> 60 * 61 * var len = arr.length; 62 * // returns 2 63 * 64 * @example 65 * var ArrayBuffer = require( '@stdlib/array/buffer' ); 66 * var Complex64Array = require( '@stdlib/array/complex64' ); 67 * 68 * var buf = new ArrayBuffer( 16 ); 69 * var arr = new Complex64Array( buf, 8 ); 70 * // returns <Complex64Array> 71 * 72 * var len = arr.length; 73 * // returns 2 74 * 75 * @example 76 * var ArrayBuffer = require( '@stdlib/array/buffer' ); 77 * var Complex64Array = require( '@stdlib/array/complex64' ); 78 * 79 * var buf = new ArrayBuffer( 32 ); 80 * var arr = new Complex64Array( buf, 8, 2 ); 81 * // returns <Complex64Array> 82 * 83 * var len = arr.length; 84 * // returns 2 85 */ 86 87 // MODULES // 88 89 var Complex64Array = require( './main.js' ); 90 91 92 // EXPORTS // 93 94 module.exports = Complex64Array;