stdlib-js/math-strided-special-smsktruncPublic

NotificationsYou must be signed in to change notification settings
Fork0
Star2

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

License

Apache-2.0 license

2 stars 0 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 66 Commits
.github		.github
benchmark		benchmark
dist		dist
docs		docs
examples		examples
include/stdlib/math/strided/special		include/stdlib/math/strided/special
lib		lib
src		src
test		test
.editorconfig		.editorconfig
.eslintrc.js		.eslintrc.js
.gitattributes		.gitattributes
.gitignore		.gitignore
.npmignore		.npmignore
.npmrc		.npmrc
CHANGELOG.md		CHANGELOG.md
CITATION.cff		CITATION.cff
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
CONTRIBUTORS		CONTRIBUTORS
LICENSE		LICENSE
Makefile		Makefile
NOTICE		NOTICE
README.md		README.md
SECURITY.md		SECURITY.md
binding.gyp		binding.gyp
branches.md		branches.md
include.gypi		include.gypi
manifest.json		manifest.json
package.json		package.json

Repository files navigation

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 considerfinancially supporting stdlib. We greatly appreciate your continued support!

smsktrunc

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

Installation

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

Alternatively,

To load the package in a website via ascript tag without installation and bundlers, use theES Module available on theesm branch (seeREADME).
If you are using Deno, visit thedeno branch (seeREADME for usage intructions).
For use in Observable, or in browser/node environments, use theUniversal Module Definition (UMD) build available on theumd branch (seeREADME).

Thebranches.md 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

varsmsktrunc=require('@stdlib/math-strided-special-smsktrunc');

smsktrunc( N, x, sx, m, sm, y, sy )

Rounds each element in a single-precision floating-point strided arrayx toward zero according to a strided mask array and assigns the results to elements in a single-precision floating-point strided arrayy.

varFloat32Array=require('@stdlib/array-float32');varUint8Array=require('@stdlib/array-uint8');varx=newFloat32Array([1.1,2.5,-3.5,4.0,-5.9]);varm=newUint8Array([0,0,1,0,1]);vary=newFloat32Array(x.length);smsktrunc(x.length,x,1,m,1,y,1);// y => <Float32Array>[ 1.0, 2.0, 0.0, 4.0, 0.0 ]

The function accepts the following arguments:

N: number of indexed elements.
x: inputFloat32Array.
sx: index increment forx.
m: maskUint8Array.
sm: index increment form.
y: outputFloat32Array.
sy: index increment fory.

TheN and stride parameters determine which strided array elements are accessed at runtime. For example, to index every other value inx and to index the firstN elements ofy in reverse order,

varFloat32Array=require('@stdlib/array-float32');varUint8Array=require('@stdlib/array-uint8');varx=newFloat32Array([1.1,2.5,-3.5,4.0,-5.9,6.4]);varm=newUint8Array([0,0,1,0,1,1]);vary=newFloat32Array([0.0,0.0,0.0,0.0,0.0,0.0]);smsktrunc(3,x,2,m,2,y,-1);// y => <Float32Array>[ 0.0, 0.0, 1.0, 0.0, 0.0, 0.0 ]

Note that indexing is relative to the first index. To introduce an offset, usetyped array views.

varFloat32Array=require('@stdlib/array-float32');varUint8Array=require('@stdlib/array-uint8');// Initial arrays...varx0=newFloat32Array([1.1,2.5,-3.5,4.0,-5.9,6.4]);varm0=newUint8Array([0,0,1,0,1,1]);vary0=newFloat32Array([0.0,0.0,0.0,0.0,0.0,0.0]);// Create offset views...varx1=newFloat32Array(x0.buffer,x0.BYTES_PER_ELEMENT*1);// start at 2nd elementvarm1=newUint8Array(m0.buffer,m0.BYTES_PER_ELEMENT*1);// start at 2nd elementvary1=newFloat32Array(y0.buffer,y0.BYTES_PER_ELEMENT*3);// start at 4th elementsmsktrunc(3,x1,-2,m1,-2,y1,1);// y0 => <Float32Array>[ 0.0, 0.0, 0.0, 0.0, 4.0, 2.0 ]

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

varFloat32Array=require('@stdlib/array-float32');varUint8Array=require('@stdlib/array-uint8');varx=newFloat32Array([1.1,2.5,-3.5,4.0,-5.9]);varm=newUint8Array([0,0,1,0,1]);vary=newFloat32Array([0.0,0.0,0.0,0.0,0.0]);smsktrunc.ndarray(x.length,x,1,0,m,1,0,y,1,0);// y => <Float32Array>[ 1.0, 2.0, 0.0, 4.0, 0.0 ]

The function accepts the following additional arguments:

ox: starting index forx.
om: starting index form.
oy: starting index fory.

Whiletyped array views mandate a view offset based on the underlyingbuffer, the offset parameters support indexing semantics based on starting indices. For example, to index every other value inx starting from the second value and to index the lastN elements iny,

varFloat32Array=require('@stdlib/array-float32');varUint8Array=require('@stdlib/array-uint8');varx=newFloat32Array([1.1,2.5,-3.5,4.0,-5.9,6.4]);varm=newUint8Array([0,0,1,0,1,1]);vary=newFloat32Array([0.0,0.0,0.0,0.0,0.0,0.0]);smsktrunc.ndarray(3,x,2,1,m,2,1,y,-1,y.length-1);// y => <Float32Array>[ 0.0, 0.0, 0.0, 0.0, 4.0, 2.0 ]

Examples

varuniform=require('@stdlib/random-base-uniform');varFloat32Array=require('@stdlib/array-float32');varUint8Array=require('@stdlib/array-uint8');varsmsktrunc=require('@stdlib/math-strided-special-smsktrunc');varx=newFloat32Array(10);varm=newUint8Array(10);vary=newFloat32Array(10);vari;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);smsktrunc.ndarray(x.length,x,1,0,m,1,0,y,-1,y.length-1);console.log(y);

C APIs

Usage

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

stdlib_strided_smsktrunc( N, X, strideX, Mask, strideMask, *Y, strideY )

Rounds each element in a single-precision floating-point strided arrayX toward zero according to a strided mask array and assigns the results to elements in a single-precision floating-point strided arrayY.

#include<stdint.h>constfloatX[]= {1.1,2.5,-3.5,4.0,-5.9,6.4,-7.0,8.2 };constuint8_tMask[]= {0,0,1,0,1,1,0,0 };floatY[]= {0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0 };constint64_tN=4;stdlib_strided_smsktrunc(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 forX.
Mask:[in] uint8_t* mask array.
strideMask:[in] int64_t index increment forMask.
Y:[out] float* output array.
strideY:[in] int64_t index increment forY.

voidstdlib_strided_smsktrunc(constint64_tN,constfloat*X,constint64_tstrideX,constuint8_t*Mask,constint64_tstrideMask,float*Y,constint64_tstrideY );

Examples

#include"stdlib/math/strided/special/smsktrunc.h"#include<stdint.h>#include<stdio.h>intmain(void ) {// Create an input strided array:constfloatX[]= {1.1,2.5,-3.5,4.0,-5.9,6.4,-7.0,8.2 };// Create a mask strided array:constuint8_tM[]= {0,0,1,0,1,1,0,0 };// Create an output strided array:floatY[]= {0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0 };// Specify the number of elements:constint64_tN=4;// Specify the stride lengths:constint64_tstrideX=2;constint64_tstrideM=2;constint64_tstrideY=2;// Compute the results:stdlib_strided_smsktrunc(N,X,strideX,M,strideM,Y,strideY );// Print the results:for (inti=0;i<8;i++ ) {printf("Y[ %i ] = %f\n",i,Y[i ] );    }}

Notice

This package is part ofstdlib, 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 developstdlib, see the main projectrepository.