Revision 987755 of SIMD.Bool32x4

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

<p>The <strong><code>SIMD.Bool32x4</code></strong> data type is a 128-bit vector divided into 4 lanes storing boolean values.</p>

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

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

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

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

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

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

<dl>
 <dt>{{jsxref("SIMD.splat", "SIMD.Bool32x4.splat()")}}</dt>
 <dd>Creates an Bool32x4 with all lanes set to a given value.</dd>
</dl>

<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.Bool32x4(true,false,true,false); 
// TypeError: SIMD.Bool32x4 is not a constructor
var w = new SIMD.Bool32x4.splat(true); 
// TypeError: SIMD.Bool32x4.splat is not a constructor</pre>

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

<pre class="brush: js example-good">
var v = SIMD.Bool32x4(true, false, true, false);
var w = SIMD.Bool32x4.splat(true);</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.Bool32x4.check()")}}</dt>
 <dd>Returns a new Bool32x4 if the parameter is a valid Bool32x4 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.Bool32x4.extractLane()")}}</dt>
 <dd>Returns the value of the given lane.</dd>
 <dt>{{jsxref("SIMD.replaceLane", "SIMD.Bool32x4.replaceLane()")}}</dt>
 <dd>Returns a new Bool16x8 with the given lane value replaced.</dd>
</dl>

<dl>
 <dt>
 <h3 id="Boolean_operations">Boolean operations</h3>
 </dt>
 <dt>{{jsxref("SIMD.allTrue", "SIMD.Bool32x4.allTrue()")}}</dt>
 <dd>Checks if all lanes hold a <code>true</code> value.</dd>
 <dt>{{jsxref("SIMD.anyTrue", "SIMD.Bool32x4.anyTrue()")}}</dt>
 <dd>Checks if any of the lanes hold a <code>true</code> value.</dd>
</dl>

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

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

<h2 id="SIMD_prototype">SIMD prototype</h2>

<p>The following methods and properties are installed on the <code>SIMD.Bool32x4.prototype</code>.</p>

<dl>
 <dt><code>SIMD.Bool32x4.prototype.constructor</code></dt>
 <dd>Specifies the function that creates a SIMD object's prototype.</dd>
 <dt>{{jsxref("SIMD.toLocaleString", "SIMD.Bool32x4.prototype.toLocaleString()")}}</dt>
 <dd>Returns a localized string representing the SIMD type and its elements. Overrides the {{jsxref("Object.prototype.toLocaleString()")}} method.</dd>
 <dt>{{jsxref("SIMD.toString", "SIMD.Bool32x4.prototype.toString()")}}</dt>
 <dd>Returns a string representing the SIMD type and its elements. Overrides the {{jsxref("Object.prototype.toString()")}} method.</dd>
 <dt>{{jsxref("SIMD.valueOf", "SIMD.Bool32x4.prototype.valueOf()")}}</dt>
 <dd>Returns the primitive value of a SIMD object.</dd>
 <dt>{{jsxref("SIMD.toSource", "SIMD.Bool32x4.prototype.toSource()")}} {{non-standard_inline}}</dt>
 <dd>Returns a string representing the source code of the object. Overrides the {{jsxref("Object.prototype.toSource()")}} method.</dd>
</dl>

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

<h3 id="Constructing_a_Bool32x4">Constructing a Bool32x4</h3>

<pre class="brush: js">
SIMD.Bool32x4(true, false, true, false); // Bool32x4[true,false,true,false]
SIMD.Bool32x4(true, false);              // Bool32x4[true,false,false,false]
SIMD.Bool32x4();                         // Bool32x4[false,false,false,false]
</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', '#bool32x4', 'Bool32x4')}}</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>