All files / math/base/special/wrapf/lib index.js

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
 
/**
* @license Apache-2.0
*
* Copyright (c) 2025 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.
*/
 
'use strict';
 
/**
* Wrap a value on the half-open interval `[min,max)` for single-precision floating-point numbers.
*
* @module @stdlib/math/base/special/wrapf
*
* @example
* var wrapf = require( '@stdlib/math/base/special/wrapf' );
*
* 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, -0.0, 5.0 );
* // returns 0.0
*
* 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
*
* v = wrapf( 3.14, 5.0, 0.0 );
* // returns NaN
*/
 
// MODULES //
 
var main = require( './main.js' );
 
 
// EXPORTS //
 
module.exports = main;