time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

main.js (1409B)


      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 add = require( './cadd.js' );
     24 
     25 
     26 // MAIN //
     27 
     28 /**
     29 * Adds two complex numbers.
     30 *
     31 * @param {(Array|TypedArray|Object)} [out] - output array
     32 * @param {number} re1 - real component
     33 * @param {number} im1 - imaginary component
     34 * @param {number} re2 - real component
     35 * @param {number} im2 - imaginary component
     36 * @returns {(Array|TypedArray|Object)} output array
     37 *
     38 * @example
     39 * var Float64Array = require( '@stdlib/array/float64' );
     40 * var out = new Float64Array( 2 );
     41 * var v = cadd( out, 5.0, 3.0, -2.0, 1.0 );
     42 * // returns <Float64Array>[ 3.0, 4.0 ]
     43 */
     44 function cadd( out, re1, im1, re2, im2 ) {
     45 	if ( arguments.length === 4 ) {
     46 		return add( [ 0.0, 0.0 ], out, re1, im1, re2 );
     47 	}
     48 	return add( out, re1, im1, re2, im2 );
     49 }
     50 
     51 
     52 // EXPORTS //
     53 
     54 module.exports = cadd;