Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stdlib-js/math-strided-special-smskceil

Round each element in a single-precision floating-point strided array toward positive infinity according to a strided mask array.
https://github.com/stdlib-js/math-strided-special-smskceil

array ceil float float32 float32array flt integer javascript math mathematics ndarray nearest node node-js nodejs round single-precision stdlib strided vector

Last synced: 11 days ago
JSON representation

Round each element in a single-precision floating-point strided array toward positive infinity according to a strided mask array.

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!



# smskceil



[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] 



> Round each element in a single-precision floating-point strided array toward positive infinity according to a strided mask array.



## Installation



```bash

npm install @stdlib/math-strided-special-smskceil

```



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 smskceil = require( '@stdlib/math-strided-special-smskceil' );

```



#### smskceil( N, x, sx, m, sm, y, sy )



Rounds each element in a single-precision floating-point strided array `x` toward positive infinity according to a strided mask array and assigns the results to elements in a single-precision floating-point strided array `y`.



```javascript

var Float32Array = require( '@stdlib/array-float32' );

var Uint8Array = require( '@stdlib/array-uint8' );



var x = new Float32Array( [ 1.1, 2.5, -3.5, 4.0, -5.9 ] );

var m = new Uint8Array( [ 0, 0, 1, 0, 1 ] );

var y = new Float32Array( x.length );



smskceil( x.length, x, 1, m, 1, y, 1 );

// y => [ 2.0, 3.0, 0.0, 4.0, 0.0 ]

```



The function accepts the following arguments:



-   **N**: number of indexed elements.

-   **x**: input [`Float32Array`][@stdlib/array/float32].

-   **sx**: index increment for `x`.

-   **m**: mask [`Uint8Array`][@stdlib/array/uint8].

-   **sm**: index increment for `m`.

-   **y**: output [`Float32Array`][@stdlib/array/float32].

-   **sy**: index increment for `y`.



The `N` and stride parameters determine which strided array elements are accessed at runtime. For example, to index every other value in `x` and to index the first `N` elements of `y` in reverse order,



```javascript

var Float32Array = require( '@stdlib/array-float32' );

var Uint8Array = require( '@stdlib/array-uint8' );



var x = new Float32Array( [ 1.1, 2.5, -3.5, 4.0, -5.9, 6.4 ] );

var m = new Uint8Array( [ 0, 0, 1, 0, 1, 1 ] );

var y = new Float32Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );



smskceil( 3, x, 2, m, 2, y, -1 );

// y => [ 0.0, 0.0, 2.0, 0.0, 0.0, 0.0 ]

```



Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][@stdlib/array/float32] views.



```javascript

var Float32Array = require( '@stdlib/array-float32' );

var Uint8Array = require( '@stdlib/array-uint8' );



// Initial arrays...

var x0 = new Float32Array( [ 1.1, 2.5, -3.5, 4.0, -5.9, 6.4 ] );

var m0 = new Uint8Array( [ 0, 0, 1, 0, 1, 1 ] );

var y0 = new Float32Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );



// Create offset views...

var x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element

var m1 = new Uint8Array( m0.buffer, m0.BYTES_PER_ELEMENT*1 ); // start at 2nd element

var y1 = new Float32Array( y0.buffer, y0.BYTES_PER_ELEMENT*3 ); // start at 4th element



smskceil( 3, x1, -2, m1, -2, y1, 1 );

// y0 => [ 0.0, 0.0, 0.0, 0.0, 4.0, 3.0 ]

```



#### smskceil.ndarray( N, x, sx, ox, m, sm, om, y, sy, oy )



Rounds each element in a single-precision floating-point strided array `x` toward positive infinity according to a strided mask array and assigns the results to elements in a single-precision floating-point strided array `y` using alternative indexing semantics.



```javascript

var Float32Array = require( '@stdlib/array-float32' );

var Uint8Array = require( '@stdlib/array-uint8' );



var x = new Float32Array( [ 1.1, 2.5, -3.5, 4.0, -5.9 ] );

var m = new Uint8Array( [ 0, 0, 1, 0, 1 ] );

var y = new Float32Array( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] );



smskceil.ndarray( x.length, x, 1, 0, m, 1, 0, y, 1, 0 );

// y => [ 2.0, 3.0, 0.0, 4.0, 0.0 ]

```



The function accepts the following additional arguments:



-   **ox**: starting index for `x`.

-   **om**: starting index for `m`.

-   **oy**: starting index for `y`.



While [`typed array`][@stdlib/array/float32] views mandate a view offset based on the underlying `buffer`, the offset parameters support indexing semantics based on starting indices. For example, to index every other value in `x` starting from the second value and to index the last `N` elements in `y`,



```javascript

var Float32Array = require( '@stdlib/array-float32' );

var Uint8Array = require( '@stdlib/array-uint8' );



var x = new Float32Array( [ 1.1, 2.5, -3.5, 4.0, -5.9, 6.4 ] );

var m = new Uint8Array( [ 0, 0, 1, 0, 1, 1 ] );

var y = new Float32Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );



smskceil.ndarray( 3, x, 2, 1, m, 2, 1, y, -1, y.length-1 );

// y => [ 0.0, 0.0, 0.0, 0.0, 4.0, 3.0 ]

```



## Examples



```javascript

var uniform = require( '@stdlib/random-base-uniform' );

var Float32Array = require( '@stdlib/array-float32' );

var Uint8Array = require( '@stdlib/array-uint8' );

var smskceil = require( '@stdlib/math-strided-special-smskceil' );



var x = new Float32Array( 10 );

var m = new Uint8Array( 10 );

var y = new Float32Array( 10 );



var i;

for ( i = 0; i < x.length; i++ ) {

    x[ i ] = uniform( -10.0, 10.0 );

    if ( uniform( 0.0, 1.0 ) < 0.5 ) {

        m[ i ] = 1;

    }

}

console.log( x );

console.log( m );

console.log( y );



smskceil.ndarray( x.length, x, 1, 0, m, 1, 0, y, -1, y.length-1 );

console.log( y );

```



* * *



## C APIs



### Usage



```c

#include "stdlib/math/strided/special/smskceil.h"

```



#### stdlib_strided_smskceil( N, \*X, strideX, \*Mask, strideMask, \*Y, strideY )



Rounds each element in a single-precision floating-point strided array `X` toward positive infinity according to a strided mask array and assigns the results to elements in a single-precision floating-point strided array `Y`.



```c

#include 



const float X[] = { 1.1, 2.5, -3.5, 4.0, -5.9, 6.4, -7.0, 8.2 };

const uint8_t Mask[] = { 0, 0, 1, 0, 1, 1, 0, 0 };

float Y[] = { 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 };



const int64_t N = 4;



stdlib_strided_smskceil( N, X, 2, Mask, 2, Y, 2 );

```



The function accepts the following arguments:



-   **N**: `[in] int64_t` number of indexed elements.

-   **X**: `[in] float*` input array.

-   **strideX**: `[in] int64_t` index increment for `X`.

-   **Mask**: `[in] uint8_t*` mask array.

-   **strideMask**: `[in] int64_t` index increment for `Mask`.

-   **Y**: `[out] float*` output array.

-   **strideY**: `[in] int64_t` index increment for `Y`.



```c

void stdlib_strided_smskceil( const int64_t N, const float *X, const int64_t strideX, const uint8_t *Mask, const int64_t strideMask, float *Y, const int64_t strideY );

```



### Examples



```c

#include "stdlib/math/strided/special/smskceil.h"

#include 

#include 



int main( void ) {

    // Create an input strided array:

    const float X[] = { 1.1, 2.5, -3.5, 4.0, -5.9, 6.4, -7.0, 8.2 };



    // Create a mask strided array:

    const uint8_t M[] = { 0, 0, 1, 0, 1, 1, 0, 0 };



    // Create an output strided array:

    float Y[] = { 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 };



    // Specify the number of elements:

    const int64_t N = 4;



    // Specify the stride lengths:

    const int64_t strideX = 2;

    const int64_t strideM = 2;

    const int64_t strideY = 2;



    // Compute the results:

    stdlib_strided_smskceil( N, X, strideX, M, strideM, Y, strideY );



    // Print the results:

    for ( int i = 0; i < 8; i++ ) {

        printf( "Y[ %i ] = %f\n", i, Y[ i ] );

    }

}

```



* * *



## See Also



-   [`@stdlib/math-strided/special/dmskceil`][@stdlib/math/strided/special/dmskceil]: round each element in a double-precision floating-point strided array toward positive infinity according to a strided mask array.

-   [`@stdlib/math-strided/special/sceil`][@stdlib/math/strided/special/sceil]: round each element in a single-precision floating-point strided array toward positive infinity.

-   [`@stdlib/math-strided/special/smskfloor`][@stdlib/math/strided/special/smskfloor]: round each element in a single-precision floating-point strided array toward negative infinity according to a strided mask array.

-   [`@stdlib/math-strided/special/smsktrunc`][@stdlib/math/strided/special/smsktrunc]: round each element in a single-precision floating-point strided array toward zero according to a strided mask 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/math-strided-special-smskceil.svg

[npm-url]: https://npmjs.org/package/@stdlib/math-strided-special-smskceil



[test-image]: https://github.com/stdlib-js/math-strided-special-smskceil/actions/workflows/test.yml/badge.svg?branch=main

[test-url]: https://github.com/stdlib-js/math-strided-special-smskceil/actions/workflows/test.yml?query=branch:main



[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-strided-special-smskceil/main.svg

[coverage-url]: https://codecov.io/github/stdlib-js/math-strided-special-smskceil?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/math-strided-special-smskceil/tree/deno

[deno-readme]: https://github.com/stdlib-js/math-strided-special-smskceil/blob/deno/README.md

[umd-url]: https://github.com/stdlib-js/math-strided-special-smskceil/tree/umd

[umd-readme]: https://github.com/stdlib-js/math-strided-special-smskceil/blob/umd/README.md

[esm-url]: https://github.com/stdlib-js/math-strided-special-smskceil/tree/esm

[esm-readme]: https://github.com/stdlib-js/math-strided-special-smskceil/blob/esm/README.md

[branches-url]: https://github.com/stdlib-js/math-strided-special-smskceil/blob/main/branches.md



[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/math-strided-special-smskceil/main/LICENSE



[@stdlib/array/float32]: https://github.com/stdlib-js/array-float32



[@stdlib/array/uint8]: https://github.com/stdlib-js/array-uint8



[@stdlib/math/strided/special/dmskceil]: https://github.com/stdlib-js/math-strided-special-dmskceil



[@stdlib/math/strided/special/sceil]: https://github.com/stdlib-js/math-strided-special-sceil



[@stdlib/math/strided/special/smskfloor]: https://github.com/stdlib-js/math-strided-special-smskfloor



[@stdlib/math/strided/special/smsktrunc]: https://github.com/stdlib-js/math-strided-special-smsktrunc