We're looking for a user researcher to understand the needs of developers and designers. Is this you or someone you know? Check out the post: https://mzl.la/2IGzdXS

SIMD.%type%.subSaturate()

SIMD.js has been taken out of active development in TC39 and removed from Stage 3. It is not being pursued by web browsers for implementation anymore. SIMD operations exposed to the web are under active development within WebAssembly, with operations based on the SIMD.js operations.

The static SIMD.%type%.subSaturate() method returns a new instance with the lane values subtracted (a - b) and saturating behavior on overflow.

Note: This operation is not defined on Uint32x4 and Int32x4, because it is not accelerated by current hardware on those types.

Syntax

SIMD.Int8x16.subSaturate(a, b)
SIMD.Int16x8.subSaturate(a, b)

SIMD.Uint8x16.subSaturate(a, b) 
SIMD.Uint16x8.subSaturate(a, b)

Parameters

a
An instance of a SIMD type.
b
Another instance of a SIMD type.

Return value

A new corresponding SIMD data type with the lane values of a and b subtracted (a - b).

Examples

The following example demonstrates the saturating behavior for Uint16 (maximum value 65535, minimum value 0) and Int16 (maximum value 32767, minimum value -32678). If the subtraction overflows, the lanes will have the minimum/maximum possible value.

var a = SIMD.Uint16x8(5, 1, 1, 1, 1, 1, 1, 1); 
var b = SIMD.Uint16x8(10, 1, 1, 1, 1, 1, 1, 1); 
SIMD.Uint16x8.subSaturate(a, b); 
// Uint16x8[0, 0, 0, 0, 0, 0, 0, 0]

var c = SIMD.Int16x8(-100, 0, 0, 0, 0, 0, 0, 0);
var d = SIMD.Int16x8(32767, 0, 0, 0, 0, 0, 0, 0);
SIMD.Int16x8.subSaturate(c, d);
// Int16x8[-32768, 0, 0, 0, 0, 0, 0, 0, 0]

Specifications

Specification Status Comment
SIMD
The definition of 'SIMDConstructor.subSaturate' in that specification.
Obsolete Initial definition.

Browser compatibility

Experimental SIMD.js has been removed from browsers. It's still available in Firefox Nightly, but will be removed in favor of a SIMD implementation in WebAssembly. See also bug 1416723.

See also

Document Tags and Contributors

Contributors to this page: fscholz, afmenez
Last updated by: fscholz,