This commit is contained in:
CircleCI Docs
2025-02-14 21:44:39 +00:00
parent 3bac79c1d6
commit 5a14f96fb9
748 changed files with 24254 additions and 13906 deletions

View File

@@ -935,6 +935,11 @@ Functions</h2></td></tr>
<tr class="separator:gafa376ad57d38ba87378f0272dc379b23"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga498b61f7e8f056ae00297fa0dc17303a" id="r_ga498b61f7e8f056ae00297fa0dc17303a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmlx_1_1core_1_1array.html">array</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga498b61f7e8f056ae00297fa0dc17303a">mlx::core::operator&gt;&gt;</a> (const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;a, const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;b)</td></tr>
<tr class="separator:ga498b61f7e8f056ae00297fa0dc17303a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf1182ae7c049fbc9ee190f3e0fffbf83" id="r_gaf1182ae7c049fbc9ee190f3e0fffbf83"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmlx_1_1core_1_1array.html">array</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gaf1182ae7c049fbc9ee190f3e0fffbf83">mlx::core::bitwise_invert</a> (const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;a, <a class="el" href="namespacemlx_1_1core.html#a95fc1013cc48fbfee0c54310711a5e58">StreamOrDevice</a> s={})</td></tr>
<tr class="memdesc:gaf1182ae7c049fbc9ee190f3e0fffbf83"><td class="mdescLeft">&#160;</td><td class="mdescRight">Invert the bits. <br /></td></tr>
<tr class="separator:gaf1182ae7c049fbc9ee190f3e0fffbf83"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga849365a62878579a33b3d3ad09bbc7be" id="r_ga849365a62878579a33b3d3ad09bbc7be"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmlx_1_1core_1_1array.html">array</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga849365a62878579a33b3d3ad09bbc7be">mlx::core::operator~</a> (const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;a)</td></tr>
<tr class="separator:ga849365a62878579a33b3d3ad09bbc7be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3602aa91b7b124a0b41ec1b2137a1b02" id="r_ga3602aa91b7b124a0b41ec1b2137a1b02"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmlx_1_1core_1_1array.html">array</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga3602aa91b7b124a0b41ec1b2137a1b02">mlx::core::view</a> (const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;a, const <a class="el" href="structmlx_1_1core_1_1_dtype.html">Dtype</a> &amp;dtype, <a class="el" href="namespacemlx_1_1core.html#a95fc1013cc48fbfee0c54310711a5e58">StreamOrDevice</a> s={})</td></tr>
<tr class="separator:ga3602aa91b7b124a0b41ec1b2137a1b02"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac40e48c69f9c715a767912c30836e75c" id="r_gac40e48c69f9c715a767912c30836e75c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmlx_1_1core_1_1array.html">array</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gac40e48c69f9c715a767912c30836e75c">mlx::core::roll</a> (const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;a, int shift, <a class="el" href="namespacemlx_1_1core.html#a95fc1013cc48fbfee0c54310711a5e58">StreamOrDevice</a> s={})</td></tr>
@@ -2342,6 +2347,29 @@ Functions</h2></td></tr>
<p>Bitwise and. </p>
</div>
</div>
<a id="gaf1182ae7c049fbc9ee190f3e0fffbf83" name="gaf1182ae7c049fbc9ee190f3e0fffbf83"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf1182ae7c049fbc9ee190f3e0fffbf83">&#9670;&#160;</a></span>bitwise_invert()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmlx_1_1core_1_1array.html">array</a> mlx::core::bitwise_invert </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;</td> <td class="paramname"><span class="paramname"><em>a</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacemlx_1_1core.html#a95fc1013cc48fbfee0c54310711a5e58">StreamOrDevice</a></td> <td class="paramname"><span class="paramname"><em>s</em></span><span class="paramdefsep"> = </span><span class="paramdefval">{}</span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Invert the bits. </p>
</div>
</div>
<a id="ga8af4f22c08c11c4ffab7e3d45e0f3cd6" name="ga8af4f22c08c11c4ffab7e3d45e0f3cd6"></a>
@@ -6768,6 +6796,23 @@ template&lt;typename T&gt; </div>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ga849365a62878579a33b3d3ad09bbc7be" name="ga849365a62878579a33b3d3ad09bbc7be"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga849365a62878579a33b3d3ad09bbc7be">&#9670;&#160;</a></span>operator~()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmlx_1_1core_1_1array.html">array</a> mlx::core::operator~ </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;</td> <td class="paramname"><span class="paramname"><em>a</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ga866af24e10db2797e1c5a5986dbf6c0d" name="ga866af24e10db2797e1c5a5986dbf6c0d"></a>
@@ -7852,7 +7897,7 @@ template&lt;typename T&gt; </div>
<div class="ttc" id="agroup__ops_html_gad438be8f90bae9d37c6853b8f4225d61"><div class="ttname"><a href="#gad438be8f90bae9d37c6853b8f4225d61">mlx::core::scatter</a></div><div class="ttdeci">array scatter(const array &amp;a, const std::vector&lt; array &gt; &amp;indices, const array &amp;updates, const std::vector&lt; int &gt; &amp;axes, StreamOrDevice s={})</div><div class="ttdoc">Scatter updates to the given indices.</div></div>
<div class="ttc" id="agroup__ops_html_gae2cace3b388cec4e520659a91879e1c1"><div class="ttname"><a href="#gae2cace3b388cec4e520659a91879e1c1">mlx::core::zeros</a></div><div class="ttdeci">array zeros(const Shape &amp;shape, Dtype dtype, StreamOrDevice s={})</div><div class="ttdoc">Fill an array of the given shape with zeros.</div></div>
<div class="ttc" id="anamespacemlx_1_1core_html_a369aa886219b83cf219e7a7862ce260b"><div class="ttname"><a href="namespacemlx_1_1core.html#a369aa886219b83cf219e7a7862ce260b">mlx::core::arange</a></div><div class="ttdeci">void arange(const std::vector&lt; array &gt; &amp;inputs, array &amp;out, double start, double step)</div><div class="ttdef"><b>Definition</b> arange.h:24</div></div>
<div class="ttc" id="anamespacemlx_1_1core_html_a6894543b340321193dfb8052c438a319"><div class="ttname"><a href="namespacemlx_1_1core.html#a6894543b340321193dfb8052c438a319">mlx::core::float32</a></div><div class="ttdeci">constexpr Dtype float32</div><div class="ttdef"><b>Definition</b> dtype.h:80</div></div>
<div class="ttc" id="anamespacemlx_1_1core_html_a6894543b340321193dfb8052c438a319"><div class="ttname"><a href="namespacemlx_1_1core.html#a6894543b340321193dfb8052c438a319">mlx::core::float32</a></div><div class="ttdeci">constexpr Dtype float32</div><div class="ttdef"><b>Definition</b> dtype.h:81</div></div>
</div><!-- fragment --><p>will produce:</p>
<div class="fragment"><div class="line"><a class="code hl_class" href="classmlx_1_1core_1_1array.html">array</a>([[0, 0, 0, 0],</div>
<div class="line"> [0, 0, 0, 0],</div>