Modulus Function

Modulus function.

The modulus function is defined as

where x is the dividend and y is the divisor.

Installation

npm install @stdlib/math-base-special-fmod

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

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

Copyright

Copyright © 2016-2024. The Stdlib Authors.