time-to-botec/js/node_modules/@stdlib/assert/is-triangular-number/lib/object.js

63 lines
1.5 KiB
JavaScript
Raw Normal View History

/**
* @license Apache-2.0
*
* Copyright (c) 2020 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';
// MODULES //
var isInteger = require( './../../is-integer' ).isObject;
var sqrt = require( '@stdlib/math/base/special/sqrt' );
var floor = require( '@stdlib/math/base/special/floor' );
// MAIN //
/**
* Tests if a value is a number object having a value which is a triangular number.
*
* ## Notes
*
* - Return values are not reliable for numbers greater than `1125899906842624`.
*
* @param {*} value - value to test
* @returns {boolean} boolean indicating if a value is a number object having a value which is a triangular number
*
* @example
* var bool = isTriangularNumber( 36.0 );
* // returns false
*
* @example
* var bool = isTriangularNumber( new Number( 36.0 ) );
* // returns true
*/
function isTriangularNumber( value ) {
var n;
var x;
if ( !isInteger( value ) ) {
return false;
}
x = ( 8.0*value.valueOf() ) + 1.0;
n = floor( sqrt( x ) + 0.5 );
return n*n === x;
}
// EXPORTS //
module.exports = isTriangularNumber;