We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
Modulus Function
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
[Modulus function][modulus-function].
x
is the dividend and y
is the divisor.
bash
npm install @stdlib/math-base-special-fmod
javascript
var fmod = require( '@stdlib/math-base-special-fmod' );
#### fmod( x, y )
Evaluates the [modulus function][modulus-function].
javascript
var v = fmod( 8.0, 3.0 );
// returns 2.0
v = fmod( 9.0, 3.0 );
// returns 0.0
v = fmod( 8.9, 3.0 );
// returns 2.9
v = fmod( NaN, 3.0 );
// returns NaN
v = fmod( 5.0, NaN );
// returns NaN
v = fmod( NaN, NaN );
// returns NaN
javascript
var randu = require( '@stdlib/random-base-randu' );
var round = require( '@stdlib/math-base-special-round' );
var fmod = require( '@stdlib/math-base-special-fmod' );
var x;
var y;
var i;
for ( i = 0; i < 100; i++ ) {
x = round( randu() * 10.0 );
y = round( randu() * 10.0 ) - 5.0;
console.log( '%d^%d = %d', x, y, fmod( x, y ) );
}
c
#include "stdlib/math/base/special/fmod.h"
#### stdlib_base_fmod( x, y )
Evaluates the modulus function.
c
double out = stdlib_base_fmod( 8.9, 3.0 );
// returns 2.9
out = stdlib_base_fmod( 4.0, 2.0 );
// returns 0.0
The function accepts the following arguments:
- x: [in] double
dividend.
- y: [in] double
divisor.
c
double stdlib_base_fmod( const double x, const double y );
c
#include "stdlib/math/base/special/fmod.h"
#include <stdlib.h>
#include <stdio.h>
int main( void ) {
double out;
double x;
double y;
int i;
for ( i = 0; i < 100; i++ ) {
x = ( ( (double)rand() / (double)RAND_MAX ) * 10.0 );
y = ( ( (double)rand() / (double)RAND_MAX ) * 10.0 ) - 5.0;
out = stdlib_base_fmod( x, y );
printf( "fmod(%lf, %lf) = %lf\n", x, y, out );
}
}