Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stdlib-js/stats-base-sminsorted
Calculate the minimum value of a sorted single-precision floating-point strided array.
https://github.com/stdlib-js/stats-base-sminsorted
domain extent extremes javascript math mathematics min minimum node node-js nodejs ordered range sorted statistics stats stdlib strided strided-array typed
Last synced: 17 days ago
JSON representation
Calculate the minimum value of a sorted single-precision floating-point strided array.
- Host: GitHub
- URL: https://github.com/stdlib-js/stats-base-sminsorted
- Owner: stdlib-js
- License: apache-2.0
- Created: 2021-06-15T18:09:11.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-01T06:42:03.000Z (about 1 month ago)
- Last Synced: 2024-10-04T22:16:54.259Z (about 1 month ago)
- Topics: domain, extent, extremes, javascript, math, mathematics, min, minimum, node, node-js, nodejs, ordered, range, sorted, statistics, stats, stdlib, strided, strided-array, typed
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 635 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
Awesome Lists containing this project
README
About stdlib...
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
# sminsorted
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Calculate the minimum value of a sorted single-precision floating-point strided array.
## Installation
```bash
npm install @stdlib/stats-base-sminsorted
```
Alternatively,
- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).
The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
## Usage
```javascript
var sminsorted = require( '@stdlib/stats-base-sminsorted' );
```
#### sminsorted( N, x, stride )
Computes the minimum value of a sorted single-precision floating-point strided array `x`.
```javascript
var Float32Array = require( '@stdlib/array-float32' );
var x = new Float32Array( [ 1.0, 2.0, 3.0 ] );
var N = x.length;
var v = sminsorted( N, x, 1 );
// returns 1.0
x = new Float32Array( [ 3.0, 2.0, 1.0 ] );
N = x.length;
v = sminsorted( N, x, 1 );
// returns 1.0
```
The function has the following parameters:
- **N**: number of indexed elements.
- **x**: sorted input [`Float32Array`][@stdlib/array/float32].
- **stride**: index increment for `x`.
The `N` and `stride` parameters determine which elements in `x` are accessed at runtime. For example, to compute the minimum value of every other element in `x`,
```javascript
var Float32Array = require( '@stdlib/array-float32' );
var floor = require( '@stdlib/math-base-special-floor' );
var x = new Float32Array( [ 1.0, 2.0, 2.0, -7.0, 3.0, 3.0, 4.0, 2.0 ] );
var N = floor( x.length / 2 );
var v = sminsorted( N, x, 2 );
// returns 1.0
```
Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
```javascript
var Float32Array = require( '@stdlib/array-float32' );
var floor = require( '@stdlib/math-base-special-floor' );
var x0 = new Float32Array( [ 2.0, 1.0, 2.0, 2.0, -2.0, 2.0, 3.0, 4.0 ] );
var x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
var N = floor( x0.length / 2 );
var v = sminsorted( N, x1, 2 );
// returns 1.0
```
#### sminsorted.ndarray( N, x, stride, offset )
Computes the minimum value of a sorted single-precision floating-point strided array using alternative indexing semantics.
```javascript
var Float32Array = require( '@stdlib/array-float32' );
var x = new Float32Array( [ 1.0, 2.0, 3.0 ] );
var N = x.length;
var v = sminsorted.ndarray( N, x, 1, 0 );
// returns 1.0
```
The function has the following additional parameters:
- **offset**: starting index for `x`.
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying `buffer`, the `offset` parameter supports indexing semantics based on a starting index. For example, to calculate the minimum value for every other value in `x` starting from the second value
```javascript
var Float32Array = require( '@stdlib/array-float32' );
var floor = require( '@stdlib/math-base-special-floor' );
var x = new Float32Array( [ 2.0, 1.0, 2.0, 2.0, -2.0, 2.0, 3.0, 4.0 ] );
var N = floor( x.length / 2 );
var v = sminsorted.ndarray( N, x, 2, 1 );
// returns 1.0
```
## Notes
- If `N <= 0`, both functions return `NaN`.
- The input strided array must be sorted in either **strictly** ascending or descending order.
## Examples
```javascript
var Float32Array = require( '@stdlib/array-float32' );
var sminsorted = require( '@stdlib/stats-base-sminsorted' );
var x;
var i;
x = new Float32Array( 10 );
for ( i = 0; i < x.length; i++ ) {
x[ i ] = i - 5.0;
}
console.log( x );
var v = sminsorted( x.length, x, 1 );
console.log( v );
```
* * *
## See Also
- [`@stdlib/stats-base/dminsorted`][@stdlib/stats/base/dminsorted]: calculate the minimum value of a sorted double-precision floating-point strided array.
- [`@stdlib/stats-base/minsorted`][@stdlib/stats/base/minsorted]: calculate the minimum value of a sorted strided array.
- [`@stdlib/stats-base/smaxsorted`][@stdlib/stats/base/smaxsorted]: calculate the maximum value of a sorted single-precision floating-point strided array.
- [`@stdlib/stats-base/smin`][@stdlib/stats/base/smin]: calculate the minimum value of a single-precision floating-point strided array.
* * *
## Notice
This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
## License
See [LICENSE][stdlib-license].
## Copyright
Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-sminsorted.svg
[npm-url]: https://npmjs.org/package/@stdlib/stats-base-sminsorted
[test-image]: https://github.com/stdlib-js/stats-base-sminsorted/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/stats-base-sminsorted/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-sminsorted/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/stats-base-sminsorted?branch=main
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/stats-base-sminsorted/tree/deno
[deno-readme]: https://github.com/stdlib-js/stats-base-sminsorted/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/stats-base-sminsorted/tree/umd
[umd-readme]: https://github.com/stdlib-js/stats-base-sminsorted/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/stats-base-sminsorted/tree/esm
[esm-readme]: https://github.com/stdlib-js/stats-base-sminsorted/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/stats-base-sminsorted/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stats-base-sminsorted/main/LICENSE
[@stdlib/array/float32]: https://github.com/stdlib-js/array-float32
[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
[@stdlib/stats/base/dminsorted]: https://github.com/stdlib-js/stats-base-dminsorted
[@stdlib/stats/base/minsorted]: https://github.com/stdlib-js/stats-base-minsorted
[@stdlib/stats/base/smaxsorted]: https://github.com/stdlib-js/stats-base-smaxsorted
[@stdlib/stats/base/smin]: https://github.com/stdlib-js/stats-base-smin