Skip to content

Commit a110323

Browse files
Erennn7Sachinn-64stdlib-bot
authored
feat: add C implementation for stats/base/ndarray/smaxsorted
PR-URL: #10172 Reviewed-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com> Co-authored-by: Sachin Pangal <sachinprogramming62@gmail.com> Co-authored-by: stdlib-bot <noreply@stdlib.io>
1 parent b05fe40 commit a110323

File tree

20 files changed

+1812
-135
lines changed

20 files changed

+1812
-135
lines changed

lib/node_modules/@stdlib/stats/base/ndarray/smaxsorted/README.md

Lines changed: 147 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,153 @@ console.log( v );
9696

9797
<!-- /.examples -->
9898

99+
<!-- C interface documentation. -->
100+
101+
* * *
102+
103+
<section class="c">
104+
105+
## C APIs
106+
107+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
108+
109+
<section class="intro">
110+
111+
</section>
112+
113+
<!-- /.intro -->
114+
115+
<!-- C usage documentation. -->
116+
117+
<section class="usage">
118+
119+
### Usage
120+
121+
```c
122+
#include "stdlib/stats/base/ndarray/smaxsorted.h"
123+
```
124+
125+
#### stdlib_stats_smaxsorted( arrays )
126+
127+
Computes the maximum value of a sorted one-dimensional single-precision floating-point ndarray.
128+
129+
```c
130+
#include "stdlib/ndarray/ctor.h"
131+
#include "stdlib/ndarray/dtypes.h"
132+
#include "stdlib/ndarray/index_modes.h"
133+
#include "stdlib/ndarray/orders.h"
134+
#include "stdlib/ndarray/base/bytes_per_element.h"
135+
#include <stdint.h>
136+
137+
// Create an ndarray:
138+
const float data[] = { 1.0f, 2.0f, 3.0f, 4.0f };
139+
int64_t shape[] = { 4 };
140+
int64_t strides[] = { STDLIB_NDARRAY_FLOAT32_BYTES_PER_ELEMENT };
141+
int8_t submodes[] = { STDLIB_NDARRAY_INDEX_ERROR };
142+
143+
struct ndarray *x = stdlib_ndarray_allocate( STDLIB_NDARRAY_FLOAT32, (uint8_t *)data, 1, shape, strides, 0, STDLIB_NDARRAY_ROW_MAJOR, STDLIB_NDARRAY_INDEX_ERROR, 1, submodes );
144+
145+
// Compute the maximum value:
146+
const struct ndarray *arrays[] = { x };
147+
float v = stdlib_stats_smaxsorted( arrays );
148+
// returns 4.0f
149+
150+
// Free allocated memory:
151+
stdlib_ndarray_free( x );
152+
```
153+
154+
The function accepts the following arguments:
155+
156+
- **arrays**: `[in] struct ndarray**` list containing a one-dimensional input ndarray.
157+
158+
```c
159+
float stdlib_stats_smaxsorted( const struct ndarray *arrays[] );
160+
```
161+
162+
</section>
163+
164+
<!-- /.usage -->
165+
166+
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
167+
168+
<section class="notes">
169+
170+
</section>
171+
172+
<!-- /.notes -->
173+
174+
<!-- C API usage examples. -->
175+
176+
<section class="examples">
177+
178+
### Examples
179+
180+
```c
181+
#include "stdlib/stats/base/ndarray/smaxsorted.h"
182+
#include "stdlib/ndarray/ctor.h"
183+
#include "stdlib/ndarray/dtypes.h"
184+
#include "stdlib/ndarray/index_modes.h"
185+
#include "stdlib/ndarray/orders.h"
186+
#include "stdlib/ndarray/base/bytes_per_element.h"
187+
#include <stdint.h>
188+
#include <stdlib.h>
189+
#include <stdio.h>
190+
191+
int main( void ) {
192+
// Create a data buffer:
193+
const float data[] = { 1.0f, 2.0f, 3.0f, 4.0f, 5.0f, 6.0f, 7.0f, 8.0f };
194+
195+
// Specify the number of array dimensions:
196+
const int64_t ndims = 1;
197+
198+
// Specify the array shape:
199+
int64_t shape[] = { 4 };
200+
201+
// Specify the array strides:
202+
int64_t strides[] = { 2*STDLIB_NDARRAY_FLOAT32_BYTES_PER_ELEMENT };
203+
204+
// Specify the byte offset:
205+
const int64_t offset = 0;
206+
207+
// Specify the array order:
208+
const enum STDLIB_NDARRAY_ORDER order = STDLIB_NDARRAY_ROW_MAJOR;
209+
210+
// Specify the index mode:
211+
const enum STDLIB_NDARRAY_INDEX_MODE imode = STDLIB_NDARRAY_INDEX_ERROR;
212+
213+
// Specify the subscript index modes:
214+
int8_t submodes[] = { STDLIB_NDARRAY_INDEX_ERROR };
215+
const int64_t nsubmodes = 1;
216+
217+
// Create an ndarray:
218+
struct ndarray *x = stdlib_ndarray_allocate( STDLIB_NDARRAY_FLOAT32, (uint8_t *)data, ndims, shape, strides, offset, order, imode, nsubmodes, submodes );
219+
if ( x == NULL ) {
220+
fprintf( stderr, "Error allocating memory.\n" );
221+
exit( 1 );
222+
}
223+
224+
// Define a list of ndarrays:
225+
const struct ndarray *arrays[] = { x };
226+
227+
// Compute the maximum value:
228+
float v = stdlib_stats_smaxsorted( arrays );
229+
230+
// Print the result:
231+
printf( "max: %f\n", v );
232+
233+
// Free allocated memory:
234+
stdlib_ndarray_free( x );
235+
}
236+
```
237+
238+
</section>
239+
240+
<!-- /.examples -->
241+
242+
</section>
243+
244+
<!-- /.c -->
245+
99246
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
100247
101248
<section class="related">

lib/node_modules/@stdlib/stats/base/ndarray/smaxsorted/benchmark/benchmark.js

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,9 @@ var linspace = require( '@stdlib/array/linspace' );
2525
var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
2626
var pow = require( '@stdlib/math/base/special/pow' );
2727
var ndarray = require( '@stdlib/ndarray/base/ctor' );
28+
var format = require( '@stdlib/string/format' );
2829
var pkg = require( './../package.json' ).name;
29-
var smaxsorted = require( './../lib' );
30+
var smaxsorted = require( './../lib/main.js' );
3031

3132

3233
// VARIABLES //
@@ -101,7 +102,7 @@ function main() {
101102
for ( i = min; i <= max; i++ ) {
102103
len = pow( 10, i );
103104
f = createBenchmark( len );
104-
bench( pkg+':len='+len, f );
105+
bench( format( '%s:len=%d', pkg, len ), f );
105106
}
106107
}
107108

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2026 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 resolve = require( 'path' ).resolve;
24+
var bench = require( '@stdlib/bench' );
25+
var linspace = require( '@stdlib/array/linspace' );
26+
var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
27+
var pow = require( '@stdlib/math/base/special/pow' );
28+
var ndarray = require( '@stdlib/ndarray/base/ctor' );
29+
var format = require( '@stdlib/string/format' );
30+
var tryRequire = require( '@stdlib/utils/try-require' );
31+
var pkg = require( './../package.json' ).name;
32+
33+
34+
// VARIABLES //
35+
36+
var smaxsorted = tryRequire( resolve( __dirname, './../lib/native.js' ) );
37+
var opts = {
38+
'skip': ( smaxsorted instanceof Error )
39+
};
40+
var options = {
41+
'dtype': 'float32'
42+
};
43+
44+
45+
// FUNCTIONS //
46+
47+
/**
48+
* Creates a benchmark function.
49+
*
50+
* @private
51+
* @param {PositiveInteger} len - array length
52+
* @returns {Function} benchmark function
53+
*/
54+
function createBenchmark( len ) {
55+
var xbuf;
56+
var x;
57+
58+
xbuf = linspace( -len/2, len/2, len, options );
59+
x = new ndarray( options.dtype, xbuf, [ len ], [ 1 ], 0, 'row-major' );
60+
61+
return benchmark;
62+
63+
/**
64+
* Benchmark function.
65+
*
66+
* @private
67+
* @param {Benchmark} b - benchmark instance
68+
*/
69+
function benchmark( b ) {
70+
var v;
71+
var i;
72+
73+
b.tic();
74+
for ( i = 0; i < b.iterations; i++ ) {
75+
v = smaxsorted( [ x ] );
76+
if ( isnanf( v ) ) {
77+
b.fail( 'should not return NaN' );
78+
}
79+
}
80+
b.toc();
81+
if ( isnanf( v ) ) {
82+
b.fail( 'should not return NaN' );
83+
}
84+
b.pass( 'benchmark finished' );
85+
b.end();
86+
}
87+
}
88+
89+
90+
// MAIN //
91+
92+
/**
93+
* Main execution sequence.
94+
*
95+
* @private
96+
*/
97+
function main() {
98+
var len;
99+
var min;
100+
var max;
101+
var f;
102+
var i;
103+
104+
min = 1; // 10^min
105+
max = 6; // 10^max
106+
107+
for ( i = min; i <= max; i++ ) {
108+
len = pow( 10, i );
109+
f = createBenchmark( len );
110+
bench( format( '%s::native:len=%d', pkg, len ), opts, f );
111+
}
112+
}
113+
114+
main();

0 commit comments

Comments
 (0)