index.js (1350B)
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 * Round a complex number toward negative infinity. 23 * 24 * @module @stdlib/math/base/special/cfloor 25 * 26 * @example 27 * var cfloor = require( '@stdlib/math/base/special/cfloor' ); 28 * 29 * var v = cfloor( -4.2, 5.5 ); 30 * // returns [ -5.0, 5.0 ] 31 * 32 * v = cfloor( 9.99999, 0.1 ); 33 * // returns [ 9.0, 0.0 ] 34 * 35 * v = cfloor( 0.0, 0.0 ); 36 * // returns [ 0.0, 0.0 ] 37 * 38 * v = cfloor( NaN, NaN ); 39 * // returns [ NaN, NaN ] 40 * 41 * @example 42 * var cfloor = require( '@stdlib/math/base/special/cfloor' ); 43 * 44 * var out = new Array( 2 ); 45 * 46 * var v = cfloor( out, -4.2, 5.5 ); 47 * // returns [ -5.0, 5.0 ] 48 * 49 * var bool = ( v === out ); 50 * // returns true 51 */ 52 53 // MODULES // 54 55 var cfloor = require( './main.js' ); 56 57 58 // EXPORTS // 59 60 module.exports = cfloor;