43 lines
1003 B
JavaScript
43 lines
1003 B
JavaScript
|
/**
|
||
|
|
* @license Apache-2.0
|
||
|
|
*
|
||
|
|
* Copyright (c) 2018 The Stdlib Authors.
|
||
|
|
*
|
||
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||
|
|
* you may not use this file except in compliance with the License.
|
||
|
|
* You may obtain a copy of the License at
|
||
|
|
*
|
||
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||
|
|
*
|
||
|
|
* Unless required by applicable law or agreed to in writing, software
|
||
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
|
|
* See the License for the specific language governing permissions and
|
||
|
|
* limitations under the License.
|
||
|
|
*/
|
||
|
|
|
||
|
|
'use strict';
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns the imaginary component of a complex number.
|
||
|
|
*
|
||
|
|
* @param {Complex} z - complex number
|
||
|
|
* @returns {number} imaginary component
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* var Complex128 = require( '@stdlib/complex/float64' );
|
||
|
|
*
|
||
|
|
* var z = new Complex128( 5.0, 3.0 );
|
||
|
|
*
|
||
|
|
* var im = imag( z );
|
||
|
|
* // returns 3.0
|
||
|
|
*/
|
||
|
|
function imag( z ) {
|
||
|
|
return z.im;
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
// EXPORTS //
|
||
|
|
|
||
|
|
module.exports = imag;
|