time-to-botec

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

main.js (1544B)

      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 inverse = require( './cinv.js' );
     24 
     25 
     26 // MAIN //
     27 
     28 /**
     29 * Computes the inverse of a complex number.
     30 *
     31 * ## References
     32 *
     33 * -   Baudin, Michael, and Robert L. Smith. 2012. "A Robust Complex Division in Scilab." _arXiv_ abs/1210.4539 \[cs.MS\] (October): 1–25. <https://arxiv.org/abs/1210.4539>.
     34 *
     35 *
     36 * @param {(Array|TypedArray|Object)} [out] - output array
     37 * @param {number} re - real component
     38 * @param {number} im - imaginary component
     39 * @returns {(Array|TypedArray|Object)} output array
     40 *
     41 * @example
     42 * var v = cinv( 2.0, 4.0 );
     43 * // returns [ 0.1, -0.2 ]
     44 *
     45 * @example
     46 * var out = new Array( 2 );
     47 *
     48 * var v = cinv( out, 2.0, 4.0 );
     49 * // returns [ 0.1, -0.2 ]
     50 *
     51 * var bool = ( v === out );
     52 * // returns true
     53 */
     54 function cinv( out, re, im ) {
     55 	if ( arguments.length === 2 ) {
     56 		return inverse( [ 0.0, 0.0 ], out, re );
     57 	}
     58 	return inverse( out, re, im );
     59 }
     60 
     61 
     62 // EXPORTS //
     63 
     64 module.exports = cinv;