wrapf

Wrap a single-precision floating-point value to the half-open interval [min,max).

Installation

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

Usage

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

wrapf( v, min, max )

Wraps a single-precision floating-point value to the half-open interval [min,max).

var v = wrapf( 3.14, 0.0, 5.0 );
// returns ~3.14

v = wrapf( -3.14, 0.0, 5.0 );
// returns ~1.86

v = wrapf( 10.0, 0.0, 5.0 );
// returns 0.0

v = wrapf( -0.0, 0.0, 5.0 );
// returns 0.0

v = wrapf( 0.0, -3.14, -0.0 );
// returns ~-3.14

If provided NaN for any argument, the function returns NaN.

var v = wrapf( NaN, 0.0, 5.0 );
// returns NaN

v = wrapf( 0.0, NaN, 5.0 );
// returns NaN

v = wrapf( 3.14, 0.0, NaN );
// returns NaN

If provided min == max, the function returns NaN.

var v = wrapf( 3.14, 3.0, 3.0 );
// returns NaN

Notes

• The function does not distinguish between positive and negative zero. Where appropriate, the function returns positive zero.

Examples

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

var opts = {
    'dtype': 'float32'
};
var min = uniform( 100, 0.0, 10.0, opts );
var max = uniform( 100, 5.0, 15.0, opts );
var v = uniform( 100, -20.0, 20.0, opts );

logEachMap( 'wrapf(%0.4f,%0.4f,%0.4f) => %0.4f', v, min, max, wrapf );

C APIs

Usage

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

stdlib_base_wrapf( v, min, max )

Wraps a single-precision floating-point value to the half-open interval [min,max).

float v = stdlib_base_wrapf( 3.14f, 0.0f, 5.0f );
// returns ~3.14f

v = stdlib_base_wrapf( -3.14f, 0.0f, 5.0f );
// returns ~1.86f

The function accepts the following arguments:

• v: [in] float input value to wrap.
• min: [in] float minimum value.
• max: [in] float maximum value.

float stdlib_base_wrapf( const float v, const float min, const float max )

Examples

#include "stdlib/math/base/special/wrapf.h"
#include <stdio.h>

int main( void ) {
    const float min[] = { 0.0f, 0.0f, 0.0f, 0.0f, -3.14f };
    const float max[] = { 5.0f, 5.0f, 5.0f, 5.0f, -0.0f };
    const float v[] = { 3.14f, -3.14f, 10.0f, -0.0f, 0.0f };

    float out;
    int i;
    for ( i = 0; i < 5; i++ ) {
        out = stdlib_base_wrapf( v[i], min[i], max[i] );
        printf( "wrapf(%f,%f,%f) => %f\n", v[i], min[i], max[i], 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

License

See LICENSE.

Copyright

Copyright © 2016-2026. The Stdlib Authors.