diff --git a/lib/node_modules/@stdlib/stats/base/smediansorted/README.md b/lib/node_modules/@stdlib/stats/base/smediansorted/README.md index a1445f4a465a..dcae19495563 100644 --- a/lib/node_modules/@stdlib/stats/base/smediansorted/README.md +++ b/lib/node_modules/@stdlib/stats/base/smediansorted/README.md @@ -36,7 +36,7 @@ limitations under the License. var smediansorted = require( '@stdlib/stats/base/smediansorted' ); ``` -#### smediansorted( N, x, stride ) +#### smediansorted( N, x, strideX ) Computes the median value of a sorted single-precision floating-point strided array `x`. @@ -56,18 +56,16 @@ The function has the following parameters: - **N**: number of indexed elements. - **x**: sorted input [`Float32Array`][@stdlib/array/float32]. -- **stride**: index increment for `x`. +- **strideX**: stride length for `x`. -The `N` and `stride` parameters determine which elements in `x` are accessed at runtime. For example, to compute the median value of every other element in `x`, +The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to compute the median 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 = smediansorted( N, x, 2 ); +var v = smediansorted( 4, x, 2 ); // returns 2.5 ``` @@ -77,18 +75,15 @@ Note that indexing is relative to the first index. To introduce an offset, use [ ```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 = smediansorted( N, x1, 2 ); +var v = smediansorted( 4, x1, 2 ); // returns 2.0 ``` -#### smediansorted.ndarray( N, x, stride, offset ) +#### smediansorted.ndarray( N, x, strideX, offsetX ) Computes the median value of a sorted single-precision floating-point strided array using alternative indexing semantics. @@ -96,9 +91,8 @@ Computes the median value of a sorted single-precision floating-point strided ar var Float32Array = require( '@stdlib/array/float32' ); var x = new Float32Array( [ 1.0, 2.0, 3.0 ] ); -var N = x.length; -var v = smediansorted.ndarray( N, x, 1, 0 ); +var v = smediansorted.ndarray( x.length, x, 1, 0 ); // returns 2.0 ``` @@ -106,16 +100,14 @@ 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 median value for every other value in `x` starting from the second value +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 median value for every other element in `x` starting from the second element ```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 = smediansorted.ndarray( N, x, 2, 1 ); +var v = smediansorted.ndarray( 4, x, 2, 1 ); // returns 2.0 ``` @@ -141,16 +133,13 @@ var v = smediansorted.ndarray( N, x, 2, 1 ); ```javascript -var Float32Array = require( '@stdlib/array/float32' ); +var linspace = require( '@stdlib/array/linspace' ); var smediansorted = require( '@stdlib/stats/base/smediansorted' ); -var x; -var i; - -x = new Float32Array( 10 ); -for ( i = 0; i < x.length; i++ ) { - x[ i ] = i - 5.0; -} +var options = { + 'dtype': 'float32' +}; +var x = linspace( -5.0, 5.0, 10, options ); console.log( x ); var v = smediansorted( x.length, x, 1 ); @@ -161,6 +150,123 @@ console.log( v ); + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/smediansorted.h" +``` + +#### stdlib_strided_smediansorted( N, \*X, strideX ) + +Computes the median value of a sorted single-precision floating-point strided array. + +```c +const float x[] = { 1.0f, 2.0f, 3.0f }; + +float v = stdlib_strided_smediansorted( 3, x, 1 ); +// returns 2.0f +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **X**: `[in] float*` input array. +- **strideX**: `[in] CBLAS_INT` stride length for `X`. + +```c +float stdlib_strided_smediansorted( const CBLAS_INT N, const float *X, const CBLAS_INT strideX ); +``` + +#### stdlib_strided_smediansorted_ndarray( N, \*X, strideX, offsetX ) + +Computes the median value of a sorted single-precision floating-point strided array using alternative indexing semantics. + +```c +const float x[] = { 1.0f, 2.0f, 3.0f }; + +float v = stdlib_strided_smediansorted_ndarray( 3, x, 1, 0 ); +// returns 2.0f +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **X**: `[in] float*` input array. +- **strideX**: `[in] CBLAS_INT` stride length for `X`. +- **offsetX**: `[in] CBLAS_INT` starting index for `X`. + +```c +float stdlib_strided_smediansorted_ndarray( const CBLAS_INT N, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/smediansorted.h" +#include + +int main( void ) { + // Create a strided array: + const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f, 5.0f, 6.0f, 7.0f, 8.0f }; + + // Specify the number of elements: + const int N = 4; + + // Specify the stride length: + const int strideX = 2; + + // Compute the median value: + float v = stdlib_strided_smediansorted( N, x, strideX ); + + // Print the result: + printf( "median: %f\n", v ); +} +``` + +
+ + + +
+ + +