Revision 871879 of SIMD.Int32x4

<div>{{JSRef}} {{es7}}</div>

<p>The <strong><code>SIMD.Int32x4</code></strong> data type is a 128-bit vector divided into 4 lanes storing 32-bit signed integer values.</p>

<div><img alt="SIMD.Int32x4" src="https://mdn.mozillademos.org/files/11257/int32x4.png" />
<p>Figure 1: SIMD.Int32x4 in a 128-bit SIMD register.</p>
</div>

<h2 id="Syntax">Syntax</h2>

<pre class="syntaxbox">
SIMD.Int32x4(x, y, z, w);</pre>

<h3 id="Parameters">Parameters</h3>

<dl>
 <dt><code>x</code> {{optional_inline}}</dt>
 <dd>An integer specifying the value of the first lane. Defaults to 0.</dd>
 <dt><code>y</code> {{optional_inline}}</dt>
 <dd>An integer specifying the value of the second lane. Defaults to 0.</dd>
 <dt><code>z</code> {{optional_inline}}</dt>
 <dd>An integer specifying the value of the third lane. Defaults to 0.</dd>
 <dt><code>w</code> {{optional_inline}}</dt>
 <dd>An integer specifying the value of the fourth lane. Defaults to 0.</dd>
</dl>

<h2 id="Constructor_functions">Constructor functions</h2>

<p>In addition to the simple creator functions, the SIMD API provides the following constructor functions.</p>

<dl>
 <dt>{{jsxref("SIMD.splat", "SIMD.Int32x4.splat()")}}</dt>
 <dd>Creates an Int32x4 with all lanes set to a given value.</dd>
 <dt>{{jsxref("SIMD.bool", "SIMD.Int32x4.bool()")}}</dt>
 <dd>Creates an Int32x4 with boolean parameters, allowing you to create an explicit selection mask.</dd>
</dl>

<p>You can also <a href="#Data_conversions">convert from another SIMD data type to Int32x4</a>.</p>

<div class="note">
<p><strong>Note:</strong> SIMD types don't work with <code>new</code>, as SIMD values are no "boxed" objects (comparable to <code>String(s)</code> vs. <code>new String(s)</code>, which creates a String object).</p>

<pre class="brush: js example-bad">
var v = new SIMD.Int32x4(1,2,3,4); 
// TypeError: SIMD.Int32x4 is not a constructor</pre>

<p>Instead, you just write:</p>

<pre class="brush: js example-good">
var v = SIMD.Int16x4(1,2,3,4);</pre>
</div>

<h2 id="Operations">Operations</h2>

<p>To actually do something with SIMD types, SIMD operations are needed that work on SIMD data types.</p>

<h3 id="Checking_SIMD_types">Checking SIMD types</h3>

<dl>
 <dt>{{jsxref("SIMD.check", "SIMD.Int32x4.check()")}}</dt>
 <dd>Returns a new Int32x4 if the parameter is a valid Int32x4 data type. Throws a {{jsxref("TypeError")}} otherwise.</dd>
</dl>

<h3 id="Accessing_and_mutating_lanes">Accessing and mutating lanes</h3>

<dl>
 <dt>{{jsxref("SIMD.extractLane", "SIMD.%type%.extractLane()")}}</dt>
 <dd>Returns the value of the given lane.</dd>
 <dt>{{jsxref("SIMD.replaceLane", "SIMD.%type%.replaceLane()")}}</dt>
 <dd>Returns a new instance with the given lane value replaced.</dd>
</dl>

<h3 id="Loading_from_and_storing_into_typed_arrays">Loading from and storing into typed arrays</h3>

<dl>
 <dt>{{jsxref("SIMD.load", "SIMD.Int32x4.load()")}}</dt>
 <dd>Returns a new Int32x4 with the lane values loaded from a <a href="/en-US/docs/Web/JavaScript/Typed_arrays">typed array</a>.</dd>
 <dt>{{jsxref("SIMD.store", "SIMD.Int32x4.store()")}}</dt>
 <dd>Stores an Int32x4 into a <a href="/en-US/docs/Web/JavaScript/Typed_arrays">typed array</a>.</dd>
</dl>

<h3 id="Arithmetic_operations">Arithmetic operations</h3>

<dl>
 <dt>{{jsxref("SIMD.add", "SIMD.Int32x4.add()")}}</dt>
 <dd>Returns a new Int32x4 with the lane values added (<code>a + b</code>).</dd>
 <dt>{{jsxref("SIMD.mul", "SIMD.Int32x4.mul()")}}</dt>
 <dd>Returns a new Int32x4 with the lane values multiplied (<code>a * b</code>).</dd>
 <dt>{{jsxref("SIMD.neg", "SIMD.Int32x4.neg()")}}</dt>
 <dd>Returns a new Int32x4 with the negated lane values.</dd>
 <dt>{{jsxref("SIMD.sub", "SIMD.Int32x4.sub()")}}</dt>
 <dd>Returns a new Int32x4 with the lane values subtracted (<code>a - b</code>).</dd>
 <dt>
 <h3 id="Shuffling_and_swizzling">Shuffling and swizzling</h3>
 </dt>
 <dt>{{jsxref("SIMD.shuffle", "SIMD.Int32x4.shuffle()")}}</dt>
 <dd>Returns a new Int32x4 with the lane values shuffled.</dd>
 <dt>{{jsxref("SIMD.swizzle", "SIMD.Int32x4.swizzle()")}}</dt>
 <dd>Returns a new Int32x4 with the lane values swizzled.</dd>
</dl>

<h3 id="Selections">Selections</h3>

<dl>
 <dt>{{jsxref("SIMD.select", "SIMD.Int32x4.select()")}}</dt>
 <dd>Returns a new Int32x4 with the lane values being a mix of the lanes depending on the selector mask.</dd>
 <dt>{{jsxref("SIMD.selectBits", "SIMD.Int32x4.selectBits()")}}</dt>
 <dd>Returns a new Int32x4 with the lane values being a mix of bits depending on the selector mask.</dd>
</dl>

<h3 id="Comparisons">Comparisons</h3>

<dl>
 <dt>{{jsxref("SIMD.equal", "SIMD.Int32x4.equal()")}}</dt>
 <dd>Returns a selection mask depending on <code>a == b</code>.</dd>
 <dt>{{jsxref("SIMD.notEqual", "SIMD.Int32x4.notEqual()")}}</dt>
 <dd>Returns a&nbsp;selection mask depending on <code>a != b</code>.</dd>
 <dt>{{jsxref("SIMD.lessThan", "SIMD.Int32x4.lessThan()")}}</dt>
 <dd>Returns a selection mask depending on <code>a &lt; b</code>.</dd>
 <dt>{{jsxref("SIMD.lessThanOrEqual", "SIMD.Int32x4.lessThanOrEqual()")}}</dt>
 <dd>Returns a selection mask depending on <code>a &lt;= b</code>.</dd>
 <dt>{{jsxref("SIMD.greaterThan", "SIMD.Int32x4.greaterThan()")}}</dt>
 <dd>Returns a selection mask depending on <code>a &gt; b</code>.</dd>
 <dt>{{jsxref("SIMD.greaterThanOrEqual", "SIMD.Int32x4.greaterThanOrEqual()")}}</dt>
 <dd>Returns a selection mask depending on <code>a &gt;= b</code>.</dd>
</dl>

<h3 id="Bitwise_logical_operations">Bitwise logical operations</h3>

<dl>
 <dt>{{jsxref("SIMD.and", "SIMD.Int32x4.and()")}}</dt>
 <dd>Returns a new Int32x4 with the logical AND of the lane values (<code>a &amp; b</code>).</dd>
 <dt>{{jsxref("SIMD.or", "SIMD.Int32x4.or()")}}</dt>
 <dd>Returns a new Int32x4 with the logical OR of the lane values (<code>a | b</code>).</dd>
 <dt>{{jsxref("SIMD.xor", "SIMD.Int32x4.xor()")}}</dt>
 <dd>Returns a new Int32x4 with the logical XOR of the lane values (<code>a ^ b</code>).</dd>
 <dt>{{jsxref("SIMD.not", "SIMD.Int32x4.not()")}}</dt>
 <dd>Returns a new Int32x4 with lane with the logical NOT of the lane values (<code>~a</code>).</dd>
</dl>

<h3 id="Bitwise_shift_operations">Bitwise shift operations</h3>

<dl>
 <dt>{{jsxref("SIMD.shiftLeftByScalar", "SIMD.Int32x4.shiftLeftByScalar()")}}</dt>
 <dd>Returns a new Int32x4 with the lane values shifted left by a given bit count (<code>a &lt;&lt; bits</code>).</dd>
 <dt>{{jsxref("SIMD.shiftRightArithmeticByScalar", "SIMD.Int32x4.shiftRightArithmeticByScalar()")}}</dt>
 <dd>Returns a new Int32x4 with the lane values shifted right (arithmetic) by a given bit count (<code>a &gt;&gt; bits</code>).</dd>
 <dt>{{jsxref("SIMD.shiftRightLogicalByScalar", "SIMD.Int32x4.shiftRightLogicalByScalar()")}}</dt>
 <dd>Returns a new Int32x4 with the lane values shifted right (logical) by a given bit count (<code>a &gt;&gt;&gt; bits</code>).</dd>
</dl>

<h3 id="Data_conversions">Data conversions</h3>

<dl>
 <dt>{{jsxref("SIMD.fromFloat32x4", "SIMD.Int32x4.fromFloat32x4()")}}</dt>
 <dd>Creates a new Int32x4 data type with a float conversion from a float32x4.</dd>
 <dt>{{jsxref("SIMD.fromFloat32x4Bits", "SIMD.Int32x4.fromFloat32x4Bits()")}}</dt>
 <dd>Creates a new Int32x4 data type with a bit-wise copy from a float32x4.</dd>
 <dt>{{jsxref("SIMD.fromFloat64x2", "SIMD.Int32x4.fromFloat64x2()")}}</dt>
 <dd>Creates a new Int32x4 data type with a float conversion from a float64x2.</dd>
 <dt>{{jsxref("SIMD.fromFloat64x2Bits", "SIMD.Int32x4.fromFloat64x2Bits()")}}</dt>
 <dd>Creates a new Int32x4 data type with a bit-wise copy from a float64x2.</dd>
 <dt>{{jsxref("SIMD.fromInt16x8Bits", "SIMD.Int32x4.fromInt16x8Bits()")}}</dt>
 <dd>Creates a new Int32x4 data type with a bit-wise copy from an Int16x8.</dd>
 <dt>{{jsxref("SIMD.fromInt8x16Bits", "SIMD.Int32x4.fromInt8x16Bits()")}}</dt>
 <dd>Creates a new Int32x4 data type with a bit-wise copy from an Int8x16.</dd>
</dl>

<h2 id="Examples">Examples</h2>

<h3 id="Constructing_an_Int32x4">Constructing an Int32x4</h3>

<pre class="brush: js">
SIMD.Int32x4(1, 2, 3, 4); // Int32x4[1,2,3,4]
SIMD.Int32x4(1, 2);       // Int32x4[1,2,0,0]
SIMD.Int32x4();           // Int32x4[0,0,0,0]
</pre>

<h2 id="Specifications">Specifications</h2>

<table class="standard-table">
 <tbody>
  <tr>
   <th scope="col">Specification</th>
   <th scope="col">Status</th>
   <th scope="col">Comment</th>
  </tr>
  <tr>
   <td>{{SpecName('SIMD', '#int32x4', 'Int32x4')}}</td>
   <td>{{Spec2('SIMD')}}</td>
   <td>Initial definition.</td>
  </tr>
 </tbody>
</table>

<h2 id="Browser_compatibility">Browser compatibility</h2>

<p>{{CompatibilityTable}}</p>

<div id="compat-desktop">
<table class="compat-table">
 <tbody>
  <tr>
   <th>Feature</th>
   <th>Chrome</th>
   <th>Firefox (Gecko)</th>
   <th>Internet Explorer</th>
   <th>Opera</th>
   <th>Safari</th>
  </tr>
  <tr>
   <td>Basic support</td>
   <td>{{CompatNo}}</td>
   <td>{{CompatNightly("firefox")}}</td>
   <td>{{CompatNo}}</td>
   <td>{{CompatNo}}</td>
   <td>{{CompatNo}}</td>
  </tr>
 </tbody>
</table>
</div>

<div id="compat-mobile">
<table class="compat-table">
 <tbody>
  <tr>
   <th>Feature</th>
   <th>Android</th>
   <th>Chrome for Android</th>
   <th>Firefox Mobile (Gecko)</th>
   <th>IE Mobile</th>
   <th>Opera Mobile</th>
   <th>Safari Mobile</th>
  </tr>
  <tr>
   <td>Basic support</td>
   <td>{{CompatNo}}</td>
   <td>{{CompatNo}}</td>
   <td>{{CompatNightly("firefox")}}</td>
   <td>{{CompatNo}}</td>
   <td>{{CompatNo}}</td>
   <td>{{CompatNo}}</td>
  </tr>
 </tbody>
</table>
</div>

<h2 id="See_also">See also</h2>

<ul>
 <li>{{jsxref("SIMD")}}</li>
</ul>