mirror of
https://github.com/ml-explore/mlx.git
synced 2025-11-04 10:38:10 +08:00
docs update
This commit is contained in:
Awni Hannun
committed by
CircleCI Docs
CircleCI Docs
parent
3f707545f9
commit
db790ac051
232
docs/build/html/struct_remainder.html
vendored
Normal file
232
docs/build/html/struct_remainder.html
vendored
Normal file
@@ -0,0 +1,232 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
||||
<meta name="generator" content="Doxygen 1.10.0"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>MLX: Remainder Struct Reference</title>
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="jquery.js"></script>
|
||||
<script type="text/javascript" src="dynsections.js"></script>
|
||||
<script type="text/javascript" src="clipboard.js"></script>
|
||||
<script type="text/javascript" src="cookie.js"></script>
|
||||
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="search/searchdata.js"></script>
|
||||
<script type="text/javascript" src="search/search.js"></script>
|
||||
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||
<div id="titlearea">
|
||||
<table cellspacing="0" cellpadding="0">
|
||||
<tbody>
|
||||
<tr id="projectrow">
|
||||
<td id="projectalign">
|
||||
<div id="projectname">MLX
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.10.0 -->
|
||||
<script type="text/javascript">
|
||||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||||
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
||||
/* @license-end */
|
||||
</script>
|
||||
<script type="text/javascript" src="menudata.js"></script>
|
||||
<script type="text/javascript" src="menu.js"></script>
|
||||
<script type="text/javascript">
|
||||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||||
$(function() {
|
||||
initMenu('',true,false,'search.php','Search');
|
||||
$(function() { init_search(); });
|
||||
});
|
||||
/* @license-end */
|
||||
</script>
|
||||
<div id="main-nav"></div>
|
||||
<!-- window showing the filter options -->
|
||||
<div id="MSearchSelectWindow"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||||
</div>
|
||||
|
||||
<!-- iframe showing the search results (closed by default) -->
|
||||
<div id="MSearchResultsWindow">
|
||||
<div id="MSearchResults">
|
||||
<div class="SRPage">
|
||||
<div id="SRIndex">
|
||||
<div id="SRResults"></div>
|
||||
<div class="SRStatus" id="Loading">Loading...</div>
|
||||
<div class="SRStatus" id="Searching">Searching...</div>
|
||||
<div class="SRStatus" id="NoMatches">No Matches</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div><!-- top -->
|
||||
<div class="header">
|
||||
<div class="summary">
|
||||
<a href="#pub-methods">Public Member Functions</a> |
|
||||
<a href="struct_remainder-members.html">List of all members</a> </div>
|
||||
<div class="headertitle"><div class="title">Remainder Struct Reference</div></div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p><code>#include <<a class="el" href="metal_2kernels_2binary_8h_source.html">binary.h</a>></code></p>
|
||||
<table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
||||
Public Member Functions</h2></td></tr>
|
||||
<tr class="memitem:ab7875512ff4341c580c6dc372e64fc58" id="r_ab7875512ff4341c580c6dc372e64fc58"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
||||
<tr class="memitem:ab7875512ff4341c580c6dc372e64fc58"><td class="memTemplItemLeft" align="right" valign="top">metal::enable_if_t< metal::is_integral_v< T > &!metal::is_signed_v< T >, T > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#ab7875512ff4341c580c6dc372e64fc58">operator()</a> (T x, T y)</td></tr>
|
||||
<tr class="separator:ab7875512ff4341c580c6dc372e64fc58"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a18150b5f4425e30b95ffabc6bb25cede" id="r_a18150b5f4425e30b95ffabc6bb25cede"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
||||
<tr class="memitem:a18150b5f4425e30b95ffabc6bb25cede"><td class="memTemplItemLeft" align="right" valign="top">metal::enable_if_t< metal::is_integral_v< T > &metal::is_signed_v< T >, T > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a18150b5f4425e30b95ffabc6bb25cede">operator()</a> (T x, T y)</td></tr>
|
||||
<tr class="separator:a18150b5f4425e30b95ffabc6bb25cede"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ab3b75f54b56fd357c9755daadb2cafc2" id="r_ab3b75f54b56fd357c9755daadb2cafc2"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
||||
<tr class="memitem:ab3b75f54b56fd357c9755daadb2cafc2"><td class="memTemplItemLeft" align="right" valign="top">metal::enable_if_t<!metal::is_integral_v< T >, T > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#ab3b75f54b56fd357c9755daadb2cafc2">operator()</a> (T x, T y)</td></tr>
|
||||
<tr class="separator:ab3b75f54b56fd357c9755daadb2cafc2"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ae918ce0e246937d4fe04e2ea36e4b2c1" id="r_ae918ce0e246937d4fe04e2ea36e4b2c1"><td class="memItemLeft" align="right" valign="top">template<> </td></tr>
|
||||
<tr class="memitem:ae918ce0e246937d4fe04e2ea36e4b2c1"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structcomplex64__t.html">complex64_t</a> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#ae918ce0e246937d4fe04e2ea36e4b2c1">operator()</a> (<a class="el" href="structcomplex64__t.html">complex64_t</a> x, <a class="el" href="structcomplex64__t.html">complex64_t</a> y)</td></tr>
|
||||
<tr class="separator:ae918ce0e246937d4fe04e2ea36e4b2c1"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<h2 class="groupheader">Member Function Documentation</h2>
|
||||
<a id="ae918ce0e246937d4fe04e2ea36e4b2c1" name="ae918ce0e246937d4fe04e2ea36e4b2c1"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#ae918ce0e246937d4fe04e2ea36e4b2c1">◆ </a></span>operator()() <span class="overload">[1/4]</span></h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<div class="memtemplate">
|
||||
template<> </div>
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname"><a class="el" href="structcomplex64__t.html">complex64_t</a> Remainder::operator() </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="structcomplex64__t.html">complex64_t</a></td> <td class="paramname"><span class="paramname"><em>x</em>, </span></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"><a class="el" href="structcomplex64__t.html">complex64_t</a></td> <td class="paramname"><span class="paramname"><em>y</em></span> )</td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="ab7875512ff4341c580c6dc372e64fc58" name="ab7875512ff4341c580c6dc372e64fc58"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#ab7875512ff4341c580c6dc372e64fc58">◆ </a></span>operator()() <span class="overload">[2/4]</span></h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<div class="memtemplate">
|
||||
template<typename T > </div>
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">metal::enable_if_t< metal::is_integral_v< T > &!metal::is_signed_v< T >, T > Remainder::operator() </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>x</em>, </span></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>y</em></span> )</td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a18150b5f4425e30b95ffabc6bb25cede" name="a18150b5f4425e30b95ffabc6bb25cede"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a18150b5f4425e30b95ffabc6bb25cede">◆ </a></span>operator()() <span class="overload">[3/4]</span></h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<div class="memtemplate">
|
||||
template<typename T > </div>
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">metal::enable_if_t< metal::is_integral_v< T > &metal::is_signed_v< T >, T > Remainder::operator() </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>x</em>, </span></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>y</em></span> )</td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="ab3b75f54b56fd357c9755daadb2cafc2" name="ab3b75f54b56fd357c9755daadb2cafc2"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#ab3b75f54b56fd357c9755daadb2cafc2">◆ </a></span>operator()() <span class="overload">[4/4]</span></h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<div class="memtemplate">
|
||||
template<typename T > </div>
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">metal::enable_if_t<!metal::is_integral_v< T >, T > Remainder::operator() </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>x</em>, </span></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>y</em></span> )</td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<hr/>The documentation for this struct was generated from the following file:<ul>
|
||||
<li>mlx/backend/metal/kernels/<a class="el" href="metal_2kernels_2binary_8h_source.html">binary.h</a></li>
|
||||
</ul>
|
||||
</div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0
|
||||
</small></address>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user