/*
* @license Apache-2.0
*
* Copyright (c) 2024 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.
*/

// TypeScript Version: 4.1

/**
* Evaluates the modulus function.
*
* @param x - dividend
* @param y - divisor
* @returns remainder
*
* @example
* var v = fmod( 8.0, 3.0 );
* // returns 2.0
*
* @example
* var v = fmod( 9.0, 3.0 );
* // returns 0.0
*
* @example
* var v = fmod( 8.9, 3.0 );
* // returns 2.9
*
* @example
* var v = fmod( NaN, 3.0 );
* // returns NaN
*
* @example
* var v = fmod( 5.0, NaN );
* // returns NaN
*
* @example
* var v = fmod( NaN, NaN );
* // returns NaN
*/
declare function fmod( x: number, y: number ): number;


// EXPORTS //

export = fmod;