Skip to content

Commit 5625d06

Browse files
anandkaranubcPlaneshifterstdlib-bot
authored
feat: add math/base/special/minmaxf
PR-URL: #7039 Ref: #649 Co-authored-by: Philipp Burckhardt <[email protected]> Co-authored-by: stdlib-bot <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]> Signed-off-by: Karan Anand <[email protected]> Signed-off-by: Philipp Burckhardt <[email protected]>
1 parent b711c6c commit 5625d06

File tree

29 files changed

+2745
-0
lines changed

29 files changed

+2745
-0
lines changed

‎lib/node_modules/@stdlib/math/base/special/minmaxf/README.md

Lines changed: 242 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,242 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2025 The Stdlib Authors.
6+
7+
Licensed under the Apache License, Version 2.0 (the "License");
8+
you may not use this file except in compliance with the License.
9+
You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing, software
14+
distributed under the License is distributed on an "AS IS" BASIS,
15+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
See the License for the specific language governing permissions and
17+
limitations under the License.
18+
19+
-->
20+
21+
# minmaxf
22+
23+
> Return the minimum and maximum of two single-precision floating-point numbers.
24+
25+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
26+
27+
<section class="intro">
28+
29+
</section>
30+
31+
<!-- /.intro -->
32+
33+
<!-- Package usage documentation. -->
34+
35+
<section class="usage">
36+
37+
## Usage
38+
39+
```javascript
40+
var minmaxf = require( '@stdlib/math/base/special/minmaxf' );
41+
```
42+
43+
#### minmaxf( x, y )
44+
45+
Returns the minimum and maximum of two single-precision floating-point numbers in a single pass.
46+
47+
```javascript
48+
var v = minmaxf( 4.2, 3.14 );
49+
// returns [ 3.14, 4.2 ]
50+
51+
v = minmaxf( +0.0, -0.0 );
52+
// returns [ -0.0, +0.0 ]
53+
```
54+
55+
If any argument is `NaN`, the function returns `NaN` for both the minimum value and the maximum value.
56+
57+
```javascript
58+
var v = minmaxf( 4.2, NaN );
59+
// returns [ NaN, NaN ]
60+
61+
v = minmaxf( NaN, 3.14 );
62+
// returns [ NaN, NaN ]
63+
```
64+
65+
#### minmaxf.assign( x, y, out, stride, offset )
66+
67+
Returns the minimum and maximum of two single-precision floating-point numbers in a single pass and assigns results to a provided output array.
68+
69+
```javascript
70+
var Float32Array = require( '@stdlib/array/float32' );
71+
72+
var out = new Float32Array( 2 );
73+
74+
var v = minmaxf.assign( 5.0, -2.0, out, 1, 0 );
75+
// returns <Float32Array>[ -2.0, 5.0 ]
76+
77+
var bool = ( v === out );
78+
// returns true
79+
```
80+
81+
</section>
82+
83+
<!-- /.usage -->
84+
85+
<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
86+
87+
<section class="notes">
88+
89+
</section>
90+
91+
<!-- /.notes -->
92+
93+
<!-- Package usage examples. -->
94+
95+
<section class="examples">
96+
97+
## Examples
98+
99+
<!-- eslint no-undef: "error" -->
100+
101+
```javascript
102+
var minstd = require( '@stdlib/random/base/minstd-shuffle' );
103+
var minmaxf = require( '@stdlib/math/base/special/minmaxf' );
104+
105+
var x;
106+
var y;
107+
var v;
108+
var i;
109+
110+
for ( i = 0; i < 100; i++ ) {
111+
x = minstd();
112+
y = minstd();
113+
v = minmaxf( x, y );
114+
console.log( 'minmaxf(%d,%d) = [%d, %d]', x, y, v[0], v[1] );
115+
}
116+
```
117+
118+
</section>
119+
120+
<!-- /.examples -->
121+
122+
<!-- C interface documentation. -->
123+
124+
* * *
125+
126+
<section class="c">
127+
128+
## C APIs
129+
130+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
131+
132+
<section class="intro">
133+
134+
</section>
135+
136+
<!-- /.intro -->
137+
138+
<!-- C usage documentation. -->
139+
140+
<section class="usage">
141+
142+
### Usage
143+
144+
```c
145+
#include "stdlib/math/base/special/minmaxf.h"
146+
```
147+
148+
#### stdlib_base_minmaxf( x, y, &min, &max )
149+
150+
Evaluates the minimum and maximum of two single-precision floating-point numbers in a single pass.
151+
152+
```c
153+
float x = 3.14f;
154+
float y = 2.71f;
155+
156+
float min;
157+
float max;
158+
stdlib_base_minmaxf( x, y, &min, &max );
159+
```
160+
161+
The function accepts the following arguments:
162+
163+
- **x**: `[in] float` first number.
164+
- **y**: `[in] float` second number.
165+
- **min**: `[out] float` destination for the minimum value.
166+
- **max**: `[out] float` destination for the maximum value.
167+
168+
```c
169+
void stdlib_base_minmaxf( const float x, const float y, float* min, float* max );
170+
```
171+
172+
</section>
173+
174+
<!-- /.usage -->
175+
176+
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
177+
178+
<section class="notes">
179+
180+
</section>
181+
182+
<!-- /.notes -->
183+
184+
<!-- C API usage examples. -->
185+
186+
<section class="examples">
187+
188+
### Examples
189+
190+
```c
191+
#include "stdlib/math/base/special/minmaxf.h"
192+
#include <stdio.h>
193+
194+
int main( void ) {
195+
const float x[] = { 1.0f, 0.45f, -0.89f, 0.0f / 0.0f, -0.78f, -0.22f, 0.66f, 0.11f, -0.55f, 0.0f };
196+
const float y[] = { -0.22f, 0.66f, 0.0f, -0.55f, 0.33f, 1.0f, 0.0f / 0.0f, 0.11f, 0.45f, -0.78f };
197+
198+
float min;
199+
float max;
200+
int i;
201+
for ( i = 0; i < 10; i++ ) {
202+
stdlib_base_minmaxf( x[ i ], y[ i ], &min, &max );
203+
printf( "x: %f, y: %f => min: %f, max: %f\n", x[ i ], y[ i ], min, max );
204+
}
205+
}
206+
```
207+
208+
</section>
209+
210+
<!-- /.examples -->
211+
212+
</section>
213+
214+
<!-- /.c -->
215+
216+
<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
217+
218+
<section class="references">
219+
220+
</section>
221+
222+
<!-- /.references -->
223+
224+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
225+
226+
<section class="related">
227+
228+
</section>
229+
230+
<!-- /.related -->
231+
232+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
233+
234+
<section class="links">
235+
236+
<!-- <related-links> -->
237+
238+
<!-- </related-links> -->
239+
240+
</section>
241+
242+
<!-- /.links -->

‎lib/node_modules/@stdlib/math/base/special/minmaxf/benchmark/benchmark.js

Lines changed: 149 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2025 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
// MODULES //
22+
23+
var bench = require( '@stdlib/bench' );
24+
var uniform = require( '@stdlib/random/array/uniform' );
25+
var isArray = require( '@stdlib/assert/is-array' );
26+
var minf = require( '@stdlib/math/base/special/minf' );
27+
var maxf = require( '@stdlib/math/base/special/maxf' );
28+
var pkg = require( './../package.json' ).name;
29+
var minmaxf = require( './../lib' );
30+
31+
32+
// MAIN //
33+
34+
bench( pkg, function benchmark( b ) {
35+
var x;
36+
var y;
37+
var z;
38+
var i;
39+
40+
x = uniform( 100, -500.0, 500.0, {
41+
'dtype': 'float32'
42+
});
43+
y = uniform( 100, -500.0, 500.0, {
44+
'dtype': 'float32'
45+
});
46+
47+
b.tic();
48+
for ( i = 0; i < b.iterations; i++ ) {
49+
z = minmaxf( x[ i%x.length ], y[ i%y.length ] );
50+
if ( z.length !== 2 ) {
51+
b.fail( 'should have expected length' );
52+
}
53+
}
54+
b.toc();
55+
if ( !isArray( z ) ) {
56+
b.fail( 'should return an array' );
57+
}
58+
b.pass( 'benchmark finished' );
59+
b.end();
60+
});
61+
62+
bench( pkg+':assign', function benchmark( b ) {
63+
var out;
64+
var x;
65+
var y;
66+
var z;
67+
var i;
68+
69+
x = uniform( 100, -500.0, 500.0, {
70+
'dtype': 'float32'
71+
});
72+
y = uniform( 100, -500.0, 500.0, {
73+
'dtype': 'float32'
74+
});
75+
out = [ 0.0, 0.0 ];
76+
77+
b.tic();
78+
for ( i = 0; i < b.iterations; i++ ) {
79+
z = minmaxf.assign( x[ i%x.length ], y[ i%y.length ], out, 1, 0 );
80+
if ( z.length !== 2 ) {
81+
b.fail( 'should have expected length' );
82+
}
83+
}
84+
b.toc();
85+
if ( !isArray( z ) ) {
86+
b.fail( 'should return an array' );
87+
}
88+
b.pass( 'benchmark finished' );
89+
b.end();
90+
});
91+
92+
bench( pkg+'::minf,maxf', function benchmark( b ) {
93+
var x;
94+
var y;
95+
var z;
96+
var i;
97+
98+
x = uniform( 100, -500.0, 500.0, {
99+
'dtype': 'float32'
100+
});
101+
y = uniform( 100, -500.0, 500.0, {
102+
'dtype': 'float32'
103+
});
104+
105+
b.tic();
106+
for ( i = 0; i < b.iterations; i++ ) {
107+
// eslint-disable-next-line max-len
108+
z = [ minf( x[ i%x.length ], y[ i%y.length ] ), maxf( x[ i%x.length ], y[ i%y.length ] ) ];
109+
if ( z.length !== 2 ) {
110+
b.fail( 'should have expected length' );
111+
}
112+
}
113+
b.toc();
114+
if ( !isArray( z ) ) {
115+
b.fail( 'should return an array' );
116+
}
117+
b.pass( 'benchmark finished' );
118+
b.end();
119+
});
120+
121+
bench( pkg+'::minf,maxf,memory_reuse', function benchmark( b ) {
122+
var x;
123+
var y;
124+
var z;
125+
var i;
126+
127+
x = uniform( 100, -500.0, 500.0, {
128+
'dtype': 'float32'
129+
});
130+
y = uniform( 100, -500.0, 500.0, {
131+
'dtype': 'float32'
132+
});
133+
z = [ 0.0, 0.0 ];
134+
135+
b.tic();
136+
for ( i = 0; i < b.iterations; i++ ) {
137+
z[ 0 ] = minf( x[ i%x.length ], y[ i%y.length ] );
138+
z[ 1 ] = maxf( x[ i%x.length ], y[ i%y.length ] );
139+
if ( z.length !== 2 ) {
140+
b.fail( 'should have expected length' );
141+
}
142+
}
143+
b.toc();
144+
if ( !isArray( z ) ) {
145+
b.fail( 'should return an array' );
146+
}
147+
b.pass( 'benchmark finished' );
148+
b.end();
149+
});

0 commit comments

Comments
 (0)