README.md

Modulus Function

Modulus function.

The modulus function is defined as

$$z = x%y$$

where x is the dividend and y is the divisor.

Usage

var fmod = require( '@stdlib/math/base/special/fmod' );

fmod( x, y )

Evaluates the modulus function.

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

Examples

var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var logEachMap = require( '@stdlib/console/log-each-map' );
var fmod = require( '@stdlib/math/base/special/fmod' );

var opts = {
    'dtype': 'float64'
};
var x = discreteUniform( 100, 0, 10, opts );
var y = discreteUniform( 100, -5, 5, opts );

logEachMap( '%d%%%d = %d', x, y, fmod );

---

C APIs

Usage

#include "stdlib/math/base/special/fmod.h"

stdlib_base_fmod( x, y )

Evaluates the modulus function.

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.

double stdlib_base_fmod( const double x, const double y );

Examples

#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 );
    }
}