@stdlib/utils
Version:
Standard utilities.
51 lines (44 loc) • 1.08 kB
JavaScript
/**
* @license Apache-2.0
*
* Copyright (c) 2022 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.
*/
;
// MAIN //
/**
* Returns the maximum value.
*
* @private
* @param {NonNegativeInteger} x - first value
* @param {NonNegativeInteger} y - second value
* @returns {NonNegativeInteger} maximum value
*
* @example
* var v = max( 2, 3 );
* // returns 3
*
* @example
* var v = max( 3, 2 );
* // returns 3
*
* @example
* var v = max( 2, 2 );
* // returns 2
*/
function max( x, y ) {
return ( x < y ) ? y : x;
}
// EXPORTS //
module.exports = max;