| <!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"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.17"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>mxnet: mxnet::Tuple< ValueType > Class Template 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> |
| <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 style="height: 56px;"> |
| <td id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">mxnet |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.17 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| /* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(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"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="namespacemxnet.html">mxnet</a></li><li class="navelem"><a class="el" href="classmxnet_1_1Tuple.html">Tuple</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pro-methods">Protected Member Functions</a> | |
| <a href="#pro-attribs">Protected Attributes</a> | |
| <a href="#pro-static-attribs">Static Protected Attributes</a> | |
| <a href="#friends">Friends</a> | |
| <a href="classmxnet_1_1Tuple-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">mxnet::Tuple< ValueType > Class Template Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>A dynamic sized array data structure that is optimized for storing small number of elements with same type. |
| <a href="classmxnet_1_1Tuple.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="include_2mxnet_2tuple_8h_source.html">tuple.h</a>></code></p> |
| <div class="dynheader"> |
| Collaboration diagram for mxnet::Tuple< ValueType >:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classmxnet_1_1Tuple__coll__graph.png" border="0" usemap="#mxnet_1_1Tuple_3_01ValueType_01_4_coll__map" alt="Collaboration graph"/></div> |
| <!-- MAP 0 --> |
| </div> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a8ab381de010f2d03638ab65d52c52336"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Tuple.html#a8ab381de010f2d03638ab65d52c52336">Tuple</a> ()=default</td></tr> |
| <tr class="memdesc:a8ab381de010f2d03638ab65d52c52336"><td class="mdescLeft"> </td><td class="mdescRight">default constructor <a href="classmxnet_1_1Tuple.html#a8ab381de010f2d03638ab65d52c52336">More...</a><br /></td></tr> |
| <tr class="separator:a8ab381de010f2d03638ab65d52c52336"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a361c7b85d10b37eeb25de15379081d17"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Tuple.html#a361c7b85d10b37eeb25de15379081d17">~Tuple</a> ()</td></tr> |
| <tr class="memdesc:a361c7b85d10b37eeb25de15379081d17"><td class="mdescLeft"> </td><td class="mdescRight">destructor <a href="classmxnet_1_1Tuple.html#a361c7b85d10b37eeb25de15379081d17">More...</a><br /></td></tr> |
| <tr class="separator:a361c7b85d10b37eeb25de15379081d17"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac8558a3334960cf2721a6f0093a63e00"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Tuple.html#ac8558a3334960cf2721a6f0093a63e00">Tuple</a> (const int <a class="el" href="classmxnet_1_1Tuple.html#a6e0bdfe3f0f34693223f657ef676bef6">ndim</a>, const <a class="el" href="include_2mxnet_2c__api_8h.html#ab15fcfeedbe50ea6db54a98b582d7eaf">dim_t</a> value)</td></tr> |
| <tr class="separator:ac8558a3334960cf2721a6f0093a63e00"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad5a51dab602640f405ed02adcbddae76"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Tuple.html#ad5a51dab602640f405ed02adcbddae76">Tuple</a> (const <a class="el" href="classmxnet_1_1Tuple.html">Tuple</a>< ValueType > &s)</td></tr> |
| <tr class="memdesc:ad5a51dab602640f405ed02adcbddae76"><td class="mdescLeft"> </td><td class="mdescRight">copy constructor from another tuple <a href="classmxnet_1_1Tuple.html#ad5a51dab602640f405ed02adcbddae76">More...</a><br /></td></tr> |
| <tr class="separator:ad5a51dab602640f405ed02adcbddae76"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5088886fed4c9c8a24380e411a3f8896"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Tuple.html#a5088886fed4c9c8a24380e411a3f8896">Tuple</a> (std::initializer_list< ValueType > init)</td></tr> |
| <tr class="memdesc:a5088886fed4c9c8a24380e411a3f8896"><td class="mdescLeft"> </td><td class="mdescRight">constructor from initializer list <a href="classmxnet_1_1Tuple.html#a5088886fed4c9c8a24380e411a3f8896">More...</a><br /></td></tr> |
| <tr class="separator:a5088886fed4c9c8a24380e411a3f8896"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aed240b2029b4a1af42f39ce53a1f3689"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Tuple.html#aed240b2029b4a1af42f39ce53a1f3689">Tuple</a> (std::vector< ValueType > init)</td></tr> |
| <tr class="memdesc:aed240b2029b4a1af42f39ce53a1f3689"><td class="mdescLeft"> </td><td class="mdescRight">constructor from vector <a href="classmxnet_1_1Tuple.html#aed240b2029b4a1af42f39ce53a1f3689">More...</a><br /></td></tr> |
| <tr class="separator:aed240b2029b4a1af42f39ce53a1f3689"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aed8176d7b46457ebe8cc3aba0d88fbb3"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Tuple.html#aed8176d7b46457ebe8cc3aba0d88fbb3">Tuple</a> (<a class="el" href="classmxnet_1_1Tuple.html">Tuple</a>< ValueType > &&src)</td></tr> |
| <tr class="memdesc:aed8176d7b46457ebe8cc3aba0d88fbb3"><td class="mdescLeft"> </td><td class="mdescRight">move constructor from <a class="el" href="classmxnet_1_1Tuple.html" title="A dynamic sized array data structure that is optimized for storing small number of elements with same...">Tuple</a> <a href="classmxnet_1_1Tuple.html#aed8176d7b46457ebe8cc3aba0d88fbb3">More...</a><br /></td></tr> |
| <tr class="separator:aed8176d7b46457ebe8cc3aba0d88fbb3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a13e6f844b1d6d74a6864f2990702811e"><td class="memTemplParams" colspan="2">template<typename RandomAccessIterator > </td></tr> |
| <tr class="memitem:a13e6f844b1d6d74a6864f2990702811e"><td class="memTemplItemLeft" align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Tuple.html#a13e6f844b1d6d74a6864f2990702811e">Tuple</a> (RandomAccessIterator <a class="el" href="classmxnet_1_1Tuple.html#a0c12964770feab5aa1ee3bddb4644e4a">begin</a>, RandomAccessIterator <a class="el" href="classmxnet_1_1Tuple.html#aa44cc7208cd93a52a4de536a66d9377b">end</a>)</td></tr> |
| <tr class="memdesc:a13e6f844b1d6d74a6864f2990702811e"><td class="mdescLeft"> </td><td class="mdescRight">construct the <a class="el" href="classmxnet_1_1Tuple.html" title="A dynamic sized array data structure that is optimized for storing small number of elements with same...">Tuple</a> from content of iterator <a href="classmxnet_1_1Tuple.html#a13e6f844b1d6d74a6864f2990702811e">More...</a><br /></td></tr> |
| <tr class="separator:a13e6f844b1d6d74a6864f2990702811e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a511d5d1f696988cfe2a56c05e6baef84"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Tuple.html#a511d5d1f696988cfe2a56c05e6baef84">Tuple</a> (const <a class="el" href="classmxnet_1_1runtime_1_1ObjectRef.html">runtime::ObjectRef</a> &src)</td></tr> |
| <tr class="separator:a511d5d1f696988cfe2a56c05e6baef84"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2fa519288bdce42447674e78fa4c6fda"><td class="memTemplParams" colspan="2">template<typename RandomAccessIterator > </td></tr> |
| <tr class="memitem:a2fa519288bdce42447674e78fa4c6fda"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Tuple.html#a2fa519288bdce42447674e78fa4c6fda">assign</a> (RandomAccessIterator <a class="el" href="classmxnet_1_1Tuple.html#a0c12964770feab5aa1ee3bddb4644e4a">begin</a>, RandomAccessIterator <a class="el" href="classmxnet_1_1Tuple.html#aa44cc7208cd93a52a4de536a66d9377b">end</a>)</td></tr> |
| <tr class="memdesc:a2fa519288bdce42447674e78fa4c6fda"><td class="mdescLeft"> </td><td class="mdescRight">Assign content to tuple from iterator. <a href="classmxnet_1_1Tuple.html#a2fa519288bdce42447674e78fa4c6fda">More...</a><br /></td></tr> |
| <tr class="separator:a2fa519288bdce42447674e78fa4c6fda"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afa1c967366ffdc49d346b75f005cf970"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Tuple.html#afa1c967366ffdc49d346b75f005cf970">swap</a> (<a class="el" href="classmxnet_1_1Tuple.html">Tuple</a>< ValueType > &other)</td></tr> |
| <tr class="memdesc:afa1c967366ffdc49d346b75f005cf970"><td class="mdescLeft"> </td><td class="mdescRight">Swap current object with other. <a href="classmxnet_1_1Tuple.html#afa1c967366ffdc49d346b75f005cf970">More...</a><br /></td></tr> |
| <tr class="separator:afa1c967366ffdc49d346b75f005cf970"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a31b66af0aa09d7bb21cad939f960b5f1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmxnet_1_1Tuple.html">Tuple</a>< ValueType > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Tuple.html#a31b66af0aa09d7bb21cad939f960b5f1">operator=</a> (const <a class="el" href="classmxnet_1_1Tuple.html">Tuple</a>< ValueType > &src)</td></tr> |
| <tr class="memdesc:a31b66af0aa09d7bb21cad939f960b5f1"><td class="mdescLeft"> </td><td class="mdescRight">assignment from another tuple. <a href="classmxnet_1_1Tuple.html#a31b66af0aa09d7bb21cad939f960b5f1">More...</a><br /></td></tr> |
| <tr class="separator:a31b66af0aa09d7bb21cad939f960b5f1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acb4f823185342cbcb2a3628e01bd9341"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmxnet_1_1Tuple.html">Tuple</a>< ValueType > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Tuple.html#acb4f823185342cbcb2a3628e01bd9341">operator=</a> (<a class="el" href="classmxnet_1_1Tuple.html">Tuple</a>< ValueType > &&src)</td></tr> |
| <tr class="memdesc:acb4f823185342cbcb2a3628e01bd9341"><td class="mdescLeft"> </td><td class="mdescRight">assignment from rvalue of another tuple. <a href="classmxnet_1_1Tuple.html#acb4f823185342cbcb2a3628e01bd9341">More...</a><br /></td></tr> |
| <tr class="separator:acb4f823185342cbcb2a3628e01bd9341"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a328d45068a42cfdd125541c3bc50586b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmxnet_1_1Tuple.html">Tuple</a>< ValueType > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Tuple.html#a328d45068a42cfdd125541c3bc50586b">operator=</a> (std::initializer_list< ValueType > init)</td></tr> |
| <tr class="memdesc:a328d45068a42cfdd125541c3bc50586b"><td class="mdescLeft"> </td><td class="mdescRight">assignment from initializer list <a href="classmxnet_1_1Tuple.html#a328d45068a42cfdd125541c3bc50586b">More...</a><br /></td></tr> |
| <tr class="separator:a328d45068a42cfdd125541c3bc50586b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab04478fcd9565adbe39cd1077a23c02b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Tuple.html#ab04478fcd9565adbe39cd1077a23c02b">operator==</a> (const <a class="el" href="classmxnet_1_1Tuple.html">Tuple</a>< ValueType > &s) const</td></tr> |
| <tr class="separator:ab04478fcd9565adbe39cd1077a23c02b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae98da4439e8342d1a886d73dde2df032"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Tuple.html#ae98da4439e8342d1a886d73dde2df032">operator!=</a> (const <a class="el" href="classmxnet_1_1Tuple.html">Tuple</a>< ValueType > &s) const</td></tr> |
| <tr class="separator:ae98da4439e8342d1a886d73dde2df032"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0c12964770feab5aa1ee3bddb4644e4a"><td class="memItemLeft" align="right" valign="top">const ValueType * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Tuple.html#a0c12964770feab5aa1ee3bddb4644e4a">begin</a> () const</td></tr> |
| <tr class="separator:a0c12964770feab5aa1ee3bddb4644e4a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7a2569df075c59690ab78ed67081b970"><td class="memItemLeft" align="right" valign="top">ValueType * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Tuple.html#a7a2569df075c59690ab78ed67081b970">begin</a> ()</td></tr> |
| <tr class="separator:a7a2569df075c59690ab78ed67081b970"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa44cc7208cd93a52a4de536a66d9377b"><td class="memItemLeft" align="right" valign="top">const ValueType * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Tuple.html#aa44cc7208cd93a52a4de536a66d9377b">end</a> () const</td></tr> |
| <tr class="separator:aa44cc7208cd93a52a4de536a66d9377b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adad594655584ba36e3cab517fb20f492"><td class="memItemLeft" align="right" valign="top">ValueType * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Tuple.html#adad594655584ba36e3cab517fb20f492">end</a> ()</td></tr> |
| <tr class="separator:adad594655584ba36e3cab517fb20f492"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6e0bdfe3f0f34693223f657ef676bef6"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Tuple.html#a6e0bdfe3f0f34693223f657ef676bef6">ndim</a> () const</td></tr> |
| <tr class="separator:a6e0bdfe3f0f34693223f657ef676bef6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af489de3d960f1c29221048e0c04d1280"><td class="memItemLeft" align="right" valign="top">ValueType & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Tuple.html#af489de3d960f1c29221048e0c04d1280">operator[]</a> (int i)</td></tr> |
| <tr class="memdesc:af489de3d960f1c29221048e0c04d1280"><td class="mdescLeft"> </td><td class="mdescRight">get corresponding index <a href="classmxnet_1_1Tuple.html#af489de3d960f1c29221048e0c04d1280">More...</a><br /></td></tr> |
| <tr class="separator:af489de3d960f1c29221048e0c04d1280"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8bad8aa5dd74f738a53d19223c067cd5"><td class="memItemLeft" align="right" valign="top">const ValueType & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Tuple.html#a8bad8aa5dd74f738a53d19223c067cd5">operator[]</a> (int i) const</td></tr> |
| <tr class="memdesc:a8bad8aa5dd74f738a53d19223c067cd5"><td class="mdescLeft"> </td><td class="mdescRight">get corresponding index <a href="classmxnet_1_1Tuple.html#a8bad8aa5dd74f738a53d19223c067cd5">More...</a><br /></td></tr> |
| <tr class="separator:a8bad8aa5dd74f738a53d19223c067cd5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aecc27733d85e5e166a2d9dd04d0607bb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Tuple.html#aecc27733d85e5e166a2d9dd04d0607bb">Save</a> (<a class="el" href="classdmlc_1_1JSONWriter.html">dmlc::JSONWriter</a> *writer) const</td></tr> |
| <tr class="memdesc:aecc27733d85e5e166a2d9dd04d0607bb"><td class="mdescLeft"> </td><td class="mdescRight">Save <a class="el" href="classmxnet_1_1Tuple.html" title="A dynamic sized array data structure that is optimized for storing small number of elements with same...">Tuple</a> to JSON. <a href="classmxnet_1_1Tuple.html#aecc27733d85e5e166a2d9dd04d0607bb">More...</a><br /></td></tr> |
| <tr class="separator:aecc27733d85e5e166a2d9dd04d0607bb"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a73c8f3c2933f17a1fe164a71605d1b8e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Tuple.html#a73c8f3c2933f17a1fe164a71605d1b8e">Load</a> (<a class="el" href="classdmlc_1_1JSONReader.html">dmlc::JSONReader</a> *reader)</td></tr> |
| <tr class="memdesc:a73c8f3c2933f17a1fe164a71605d1b8e"><td class="mdescLeft"> </td><td class="mdescRight">Load <a class="el" href="classmxnet_1_1Tuple.html" title="A dynamic sized array data structure that is optimized for storing small number of elements with same...">Tuple</a> from JSON. <a href="classmxnet_1_1Tuple.html#a73c8f3c2933f17a1fe164a71605d1b8e">More...</a><br /></td></tr> |
| <tr class="separator:a73c8f3c2933f17a1fe164a71605d1b8e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abb0f462a014ddd385e564e80aef500af"><td class="memTemplParams" colspan="2">template<typename DType = ValueType, typename TStream > </td></tr> |
| <tr class="memitem:abb0f462a014ddd385e564e80aef500af"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Tuple.html#abb0f462a014ddd385e564e80aef500af">Save</a> (TStream *strm) const</td></tr> |
| <tr class="memdesc:abb0f462a014ddd385e564e80aef500af"><td class="mdescLeft"> </td><td class="mdescRight">save the content into binary stream <a href="classmxnet_1_1Tuple.html#abb0f462a014ddd385e564e80aef500af">More...</a><br /></td></tr> |
| <tr class="separator:abb0f462a014ddd385e564e80aef500af"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9562fef3891815253867c79bb24316af"><td class="memTemplParams" colspan="2">template<typename DType = ValueType, typename TStream > </td></tr> |
| <tr class="memitem:a9562fef3891815253867c79bb24316af"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Tuple.html#a9562fef3891815253867c79bb24316af">Load</a> (TStream *strm)</td></tr> |
| <tr class="memdesc:a9562fef3891815253867c79bb24316af"><td class="mdescLeft"> </td><td class="mdescRight">load the content from binary stream <a href="classmxnet_1_1Tuple.html#a9562fef3891815253867c79bb24316af">More...</a><br /></td></tr> |
| <tr class="separator:a9562fef3891815253867c79bb24316af"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a> |
| Protected Member Functions</h2></td></tr> |
| <tr class="memitem:a6e95fa68089ea9d465a383d5e32a4758"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Tuple.html#a6e95fa68089ea9d465a383d5e32a4758">SetDim</a> (int <a class="el" href="classmxnet_1_1Tuple.html#a6e0bdfe3f0f34693223f657ef676bef6">ndim</a>)</td></tr> |
| <tr class="separator:a6e95fa68089ea9d465a383d5e32a4758"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a> |
| Protected Attributes</h2></td></tr> |
| <tr class="memitem:a424233ed3bd43df18ae411f18b27a400"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Tuple.html#a424233ed3bd43df18ae411f18b27a400">ndim_</a> {0}</td></tr> |
| <tr class="memdesc:a424233ed3bd43df18ae411f18b27a400"><td class="mdescLeft"> </td><td class="mdescRight">number of dimension of the tuple <a href="classmxnet_1_1Tuple.html#a424233ed3bd43df18ae411f18b27a400">More...</a><br /></td></tr> |
| <tr class="separator:a424233ed3bd43df18ae411f18b27a400"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab2896f3e9701715ac70934b98d31bba2"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Tuple.html#ab2896f3e9701715ac70934b98d31bba2">num_heap_allocated_</a> {0}</td></tr> |
| <tr class="memdesc:ab2896f3e9701715ac70934b98d31bba2"><td class="mdescLeft"> </td><td class="mdescRight">number of cells allocated in data_heap_ <a href="classmxnet_1_1Tuple.html#ab2896f3e9701715ac70934b98d31bba2">More...</a><br /></td></tr> |
| <tr class="separator:ab2896f3e9701715ac70934b98d31bba2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aed4c55d30bdc9e76bfb04895cab2bde1"><td class="memItemLeft" align="right" valign="top">ValueType </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Tuple.html#aed4c55d30bdc9e76bfb04895cab2bde1">data_stack_</a> [<a class="el" href="classmxnet_1_1Tuple.html#a69b5d9b088d983ebc6f975708568d1ae">kStackCache</a>]</td></tr> |
| <tr class="memdesc:aed4c55d30bdc9e76bfb04895cab2bde1"><td class="mdescLeft"> </td><td class="mdescRight">in stack space used to store shape when it is small <a href="classmxnet_1_1Tuple.html#aed4c55d30bdc9e76bfb04895cab2bde1">More...</a><br /></td></tr> |
| <tr class="separator:aed4c55d30bdc9e76bfb04895cab2bde1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a35847de488bef5570c45ac44f572b755"><td class="memItemLeft" align="right" valign="top">ValueType * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Tuple.html#a35847de488bef5570c45ac44f572b755">data_heap_</a> {nullptr}</td></tr> |
| <tr class="memdesc:a35847de488bef5570c45ac44f572b755"><td class="mdescLeft"> </td><td class="mdescRight">space to store shape when dimension is big <a href="classmxnet_1_1Tuple.html#a35847de488bef5570c45ac44f572b755">More...</a><br /></td></tr> |
| <tr class="separator:a35847de488bef5570c45ac44f572b755"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-static-attribs"></a> |
| Static Protected Attributes</h2></td></tr> |
| <tr class="memitem:a69b5d9b088d983ebc6f975708568d1ae"><td class="memItemLeft" align="right" valign="top">static const int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Tuple.html#a69b5d9b088d983ebc6f975708568d1ae">kStackCache</a> = 8</td></tr> |
| <tr class="separator:a69b5d9b088d983ebc6f975708568d1ae"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a> |
| Friends</h2></td></tr> |
| <tr class="memitem:a39bed8c606eefa4faef1088f21e94800"><td class="memItemLeft" align="right" valign="top">std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Tuple.html#a39bed8c606eefa4faef1088f21e94800">operator<<</a> (std::ostream &os, const <a class="el" href="classmxnet_1_1Tuple.html">Tuple</a>< ValueType > &t)</td></tr> |
| <tr class="memdesc:a39bed8c606eefa4faef1088f21e94800"><td class="mdescLeft"> </td><td class="mdescRight">allow output string of tuple to ostream <a href="classmxnet_1_1Tuple.html#a39bed8c606eefa4faef1088f21e94800">More...</a><br /></td></tr> |
| <tr class="separator:a39bed8c606eefa4faef1088f21e94800"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0f33bc2b1cf75b9ef9d738e5fd9ea7ee"><td class="memItemLeft" align="right" valign="top">std::istream & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Tuple.html#a0f33bc2b1cf75b9ef9d738e5fd9ea7ee">operator>></a> (std::istream &is, <a class="el" href="classmxnet_1_1Tuple.html">Tuple</a>< ValueType > &t)</td></tr> |
| <tr class="memdesc:a0f33bc2b1cf75b9ef9d738e5fd9ea7ee"><td class="mdescLeft"> </td><td class="mdescRight">read tuple from the istream <a href="classmxnet_1_1Tuple.html#a0f33bc2b1cf75b9ef9d738e5fd9ea7ee">More...</a><br /></td></tr> |
| <tr class="separator:a0f33bc2b1cf75b9ef9d738e5fd9ea7ee"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><h3>template<typename ValueType><br /> |
| class mxnet::Tuple< ValueType ></h3> |
| |
| <p>A dynamic sized array data structure that is optimized for storing small number of elements with same type. </p> |
| <p>Data will be stored in stack when number of elements is small. It is suitable to hold shape of Tensor.</p> |
| <p>The ndim of a valid tuple is an integer in range [0, inf). ndim = 0 means the tuple is empty.</p> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">ValueType</td><td>The type of data stored inside tuple. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section see"><dt>See also</dt><dd><a class="el" href="classmxnet_1_1TShape.html" title="A Shape class that is used to represent shape of each tensor.">TShape</a> </dd></dl> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a8ab381de010f2d03638ab65d52c52336"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8ab381de010f2d03638ab65d52c52336">◆ </a></span>Tuple() <span class="overload">[1/8]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename ValueType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classmxnet_1_1Tuple.html">mxnet::Tuple</a>< ValueType >::<a class="el" href="classmxnet_1_1Tuple.html">Tuple</a> </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">default</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>default constructor </p> |
| |
| </div> |
| </div> |
| <a id="a361c7b85d10b37eeb25de15379081d17"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a361c7b85d10b37eeb25de15379081d17">◆ </a></span>~Tuple()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename ValueType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classmxnet_1_1Tuple.html">mxnet::Tuple</a>< ValueType >::~<a class="el" href="classmxnet_1_1Tuple.html">Tuple</a> </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>destructor </p> |
| |
| </div> |
| </div> |
| <a id="ac8558a3334960cf2721a6f0093a63e00"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac8558a3334960cf2721a6f0093a63e00">◆ </a></span>Tuple() <span class="overload">[2/8]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename ValueType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classmxnet_1_1Tuple.html">mxnet::Tuple</a>< ValueType >::<a class="el" href="classmxnet_1_1Tuple.html">Tuple</a> </td> |
| <td>(</td> |
| <td class="paramtype">const int </td> |
| <td class="paramname"><em>ndim</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const <a class="el" href="include_2mxnet_2c__api_8h.html#ab15fcfeedbe50ea6db54a98b582d7eaf">dim_t</a> </td> |
| <td class="paramname"><em>value</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>constructor to construct a tuple with all <code>value</code>. </p><dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">ndim</td><td>the number of dimension </td></tr> |
| <tr><td class="paramname">value</td><td>the dimension size for all dims </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="ad5a51dab602640f405ed02adcbddae76"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad5a51dab602640f405ed02adcbddae76">◆ </a></span>Tuple() <span class="overload">[3/8]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename ValueType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classmxnet_1_1Tuple.html">mxnet::Tuple</a>< ValueType >::<a class="el" href="classmxnet_1_1Tuple.html">Tuple</a> </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classmxnet_1_1Tuple.html">Tuple</a>< ValueType > & </td> |
| <td class="paramname"><em>s</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>copy constructor from another tuple </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">s</td><td>the source tuple </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a5088886fed4c9c8a24380e411a3f8896"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5088886fed4c9c8a24380e411a3f8896">◆ </a></span>Tuple() <span class="overload">[4/8]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename ValueType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classmxnet_1_1Tuple.html">mxnet::Tuple</a>< ValueType >::<a class="el" href="classmxnet_1_1Tuple.html">Tuple</a> </td> |
| <td>(</td> |
| <td class="paramtype">std::initializer_list< ValueType > </td> |
| <td class="paramname"><em>init</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>constructor from initializer list </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">init</td><td>the initializer_list </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="aed240b2029b4a1af42f39ce53a1f3689"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aed240b2029b4a1af42f39ce53a1f3689">◆ </a></span>Tuple() <span class="overload">[5/8]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename ValueType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classmxnet_1_1Tuple.html">mxnet::Tuple</a>< ValueType >::<a class="el" href="classmxnet_1_1Tuple.html">Tuple</a> </td> |
| <td>(</td> |
| <td class="paramtype">std::vector< ValueType > </td> |
| <td class="paramname"><em>init</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>constructor from vector </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">init</td><td>the vector </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="aed8176d7b46457ebe8cc3aba0d88fbb3"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aed8176d7b46457ebe8cc3aba0d88fbb3">◆ </a></span>Tuple() <span class="overload">[6/8]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename ValueType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classmxnet_1_1Tuple.html">mxnet::Tuple</a>< ValueType >::<a class="el" href="classmxnet_1_1Tuple.html">Tuple</a> </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classmxnet_1_1Tuple.html">Tuple</a>< ValueType > && </td> |
| <td class="paramname"><em>src</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>move constructor from <a class="el" href="classmxnet_1_1Tuple.html" title="A dynamic sized array data structure that is optimized for storing small number of elements with same...">Tuple</a> </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">src</td><td>the source shape </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a13e6f844b1d6d74a6864f2990702811e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a13e6f844b1d6d74a6864f2990702811e">◆ </a></span>Tuple() <span class="overload">[7/8]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename ValueType > </div> |
| <div class="memtemplate"> |
| template<typename RandomAccessIterator > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classmxnet_1_1Tuple.html">mxnet::Tuple</a>< ValueType >::<a class="el" href="classmxnet_1_1Tuple.html">Tuple</a> </td> |
| <td>(</td> |
| <td class="paramtype">RandomAccessIterator </td> |
| <td class="paramname"><em>begin</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">RandomAccessIterator </td> |
| <td class="paramname"><em>end</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>construct the <a class="el" href="classmxnet_1_1Tuple.html" title="A dynamic sized array data structure that is optimized for storing small number of elements with same...">Tuple</a> from content of iterator </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">begin</td><td>the beginning of iterator </td></tr> |
| <tr><td class="paramname">end</td><td>end the end of the iterator </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">RandomAccessIterator</td><td>iterator type </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a511d5d1f696988cfe2a56c05e6baef84"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a511d5d1f696988cfe2a56c05e6baef84">◆ </a></span>Tuple() <span class="overload">[8/8]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename ValueType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classmxnet_1_1Tuple.html">mxnet::Tuple</a>< ValueType >::<a class="el" href="classmxnet_1_1Tuple.html">Tuple</a> </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classmxnet_1_1runtime_1_1ObjectRef.html">runtime::ObjectRef</a> & </td> |
| <td class="paramname"><em>src</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a2fa519288bdce42447674e78fa4c6fda"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2fa519288bdce42447674e78fa4c6fda">◆ </a></span>assign()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename ValueType > </div> |
| <div class="memtemplate"> |
| template<typename RandomAccessIterator > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void <a class="el" href="classmxnet_1_1Tuple.html">mxnet::Tuple</a>< ValueType >::assign </td> |
| <td>(</td> |
| <td class="paramtype">RandomAccessIterator </td> |
| <td class="paramname"><em>begin</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">RandomAccessIterator </td> |
| <td class="paramname"><em>end</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Assign content to tuple from iterator. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">begin</td><td>the beginning of iterator </td></tr> |
| <tr><td class="paramname">end</td><td>end the end of the iterator </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">RandomAccessIterator</td><td>iterator type </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a7a2569df075c59690ab78ed67081b970"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7a2569df075c59690ab78ed67081b970">◆ </a></span>begin() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename ValueType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">ValueType* <a class="el" href="classmxnet_1_1Tuple.html">mxnet::Tuple</a>< ValueType >::begin </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="section return"><dt>Returns</dt><dd>the begin data pointer to content of the tuple </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a0c12964770feab5aa1ee3bddb4644e4a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0c12964770feab5aa1ee3bddb4644e4a">◆ </a></span>begin() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename ValueType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const ValueType* <a class="el" href="classmxnet_1_1Tuple.html">mxnet::Tuple</a>< ValueType >::begin </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="section return"><dt>Returns</dt><dd>the begin data pointer to content of the tuple </dd></dl> |
| |
| </div> |
| </div> |
| <a id="adad594655584ba36e3cab517fb20f492"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#adad594655584ba36e3cab517fb20f492">◆ </a></span>end() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename ValueType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">ValueType* <a class="el" href="classmxnet_1_1Tuple.html">mxnet::Tuple</a>< ValueType >::end </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="section return"><dt>Returns</dt><dd>the data pointer to end the tuple </dd></dl> |
| |
| </div> |
| </div> |
| <a id="aa44cc7208cd93a52a4de536a66d9377b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa44cc7208cd93a52a4de536a66d9377b">◆ </a></span>end() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename ValueType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const ValueType* <a class="el" href="classmxnet_1_1Tuple.html">mxnet::Tuple</a>< ValueType >::end </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="section return"><dt>Returns</dt><dd>the data pointer to end of the tuple </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a73c8f3c2933f17a1fe164a71605d1b8e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a73c8f3c2933f17a1fe164a71605d1b8e">◆ </a></span>Load() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename ValueType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void <a class="el" href="classmxnet_1_1Tuple.html">mxnet::Tuple</a>< ValueType >::Load </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classdmlc_1_1JSONReader.html">dmlc::JSONReader</a> * </td> |
| <td class="paramname"><em>reader</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Load <a class="el" href="classmxnet_1_1Tuple.html" title="A dynamic sized array data structure that is optimized for storing small number of elements with same...">Tuple</a> from JSON. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">reader</td><td>JSONReader </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a9562fef3891815253867c79bb24316af"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9562fef3891815253867c79bb24316af">◆ </a></span>Load() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename ValueType > </div> |
| <div class="memtemplate"> |
| template<typename DType , typename TStream > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool <a class="el" href="classmxnet_1_1Tuple.html">mxnet::Tuple</a>< ValueType >::Load </td> |
| <td>(</td> |
| <td class="paramtype">TStream * </td> |
| <td class="paramname"><em>strm</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>load the content from binary stream </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">strm</td><td>the output stream </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">DType</td><td>data type that load from </td></tr> |
| <tr><td class="paramname">TStream</td><td>any stream type that have write </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>whether the load is successful</dd></dl> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">ValueType</td><td>The type of data stored inside tuple. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a6e0bdfe3f0f34693223f657ef676bef6"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6e0bdfe3f0f34693223f657ef676bef6">◆ </a></span>ndim()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename ValueType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int <a class="el" href="classmxnet_1_1Tuple.html">mxnet::Tuple</a>< ValueType >::ndim </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="section return"><dt>Returns</dt><dd>number of dimension of the tuple </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ae98da4439e8342d1a886d73dde2df032"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae98da4439e8342d1a886d73dde2df032">◆ </a></span>operator!=()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename ValueType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool <a class="el" href="classmxnet_1_1Tuple.html">mxnet::Tuple</a>< ValueType >::operator!= </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classmxnet_1_1Tuple.html">Tuple</a>< ValueType > & </td> |
| <td class="paramname"><em>s</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="section return"><dt>Returns</dt><dd>whether two tuple not equal </dd></dl> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">s</td><td>the tuple to compare against </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a31b66af0aa09d7bb21cad939f960b5f1"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a31b66af0aa09d7bb21cad939f960b5f1">◆ </a></span>operator=() <span class="overload">[1/3]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename ValueType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classmxnet_1_1Tuple.html">Tuple</a><ValueType>& <a class="el" href="classmxnet_1_1Tuple.html">mxnet::Tuple</a>< ValueType >::operator= </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classmxnet_1_1Tuple.html">Tuple</a>< ValueType > & </td> |
| <td class="paramname"><em>src</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>assignment from another tuple. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">src</td><td>source tuple </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>reference of self </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a328d45068a42cfdd125541c3bc50586b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a328d45068a42cfdd125541c3bc50586b">◆ </a></span>operator=() <span class="overload">[2/3]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename ValueType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classmxnet_1_1Tuple.html">Tuple</a><ValueType>& <a class="el" href="classmxnet_1_1Tuple.html">mxnet::Tuple</a>< ValueType >::operator= </td> |
| <td>(</td> |
| <td class="paramtype">std::initializer_list< ValueType > </td> |
| <td class="paramname"><em>init</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>assignment from initializer list </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">init</td><td>the source initializer list </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>reference of self </dd></dl> |
| |
| </div> |
| </div> |
| <a id="acb4f823185342cbcb2a3628e01bd9341"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#acb4f823185342cbcb2a3628e01bd9341">◆ </a></span>operator=() <span class="overload">[3/3]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename ValueType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classmxnet_1_1Tuple.html">Tuple</a><ValueType>& <a class="el" href="classmxnet_1_1Tuple.html">mxnet::Tuple</a>< ValueType >::operator= </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classmxnet_1_1Tuple.html">Tuple</a>< ValueType > && </td> |
| <td class="paramname"><em>src</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>assignment from rvalue of another tuple. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">src</td><td>source tuple </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>reference of self </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ab04478fcd9565adbe39cd1077a23c02b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab04478fcd9565adbe39cd1077a23c02b">◆ </a></span>operator==()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename ValueType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool <a class="el" href="classmxnet_1_1Tuple.html">mxnet::Tuple</a>< ValueType >::operator== </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classmxnet_1_1Tuple.html">Tuple</a>< ValueType > & </td> |
| <td class="paramname"><em>s</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="section return"><dt>Returns</dt><dd>whether two tuple equals </dd></dl> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">s</td><td>the tuple to compare against </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="af489de3d960f1c29221048e0c04d1280"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af489de3d960f1c29221048e0c04d1280">◆ </a></span>operator[]() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename ValueType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">ValueType& <a class="el" href="classmxnet_1_1Tuple.html">mxnet::Tuple</a>< ValueType >::operator[] </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>i</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>get corresponding index </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">i</td><td>dimension index </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the corresponding dimension size </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a8bad8aa5dd74f738a53d19223c067cd5"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8bad8aa5dd74f738a53d19223c067cd5">◆ </a></span>operator[]() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename ValueType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const ValueType& <a class="el" href="classmxnet_1_1Tuple.html">mxnet::Tuple</a>< ValueType >::operator[] </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>i</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>get corresponding index </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">i</td><td>dimension index </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the corresponding dimension size </dd></dl> |
| |
| </div> |
| </div> |
| <a id="aecc27733d85e5e166a2d9dd04d0607bb"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aecc27733d85e5e166a2d9dd04d0607bb">◆ </a></span>Save() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename ValueType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void <a class="el" href="classmxnet_1_1Tuple.html">mxnet::Tuple</a>< ValueType >::Save </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classdmlc_1_1JSONWriter.html">dmlc::JSONWriter</a> * </td> |
| <td class="paramname"><em>writer</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Save <a class="el" href="classmxnet_1_1Tuple.html" title="A dynamic sized array data structure that is optimized for storing small number of elements with same...">Tuple</a> to JSON. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">writer</td><td>JSONWriter </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="abb0f462a014ddd385e564e80aef500af"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#abb0f462a014ddd385e564e80aef500af">◆ </a></span>Save() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename ValueType > </div> |
| <div class="memtemplate"> |
| template<typename DType , typename TStream > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void <a class="el" href="classmxnet_1_1Tuple.html">mxnet::Tuple</a>< ValueType >::Save </td> |
| <td>(</td> |
| <td class="paramtype">TStream * </td> |
| <td class="paramname"><em>strm</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>save the content into binary stream </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">strm</td><td>the output stream </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">DType</td><td>data type that save to </td></tr> |
| <tr><td class="paramname">TStream</td><td>any stream type that have write</td></tr> |
| <tr><td class="paramname">ValueType</td><td>The type of data stored inside tuple. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a6e95fa68089ea9d465a383d5e32a4758"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6e95fa68089ea9d465a383d5e32a4758">◆ </a></span>SetDim()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename ValueType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void <a class="el" href="classmxnet_1_1Tuple.html">mxnet::Tuple</a>< ValueType >::SetDim </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>ndim</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="afa1c967366ffdc49d346b75f005cf970"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#afa1c967366ffdc49d346b75f005cf970">◆ </a></span>swap()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename ValueType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void <a class="el" href="classmxnet_1_1Tuple.html">mxnet::Tuple</a>< ValueType >::swap </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classmxnet_1_1Tuple.html">Tuple</a>< ValueType > & </td> |
| <td class="paramname"><em>other</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Swap current object with other. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">other</td><td>another object to be swapped. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Friends And Related Function Documentation</h2> |
| <a id="a39bed8c606eefa4faef1088f21e94800"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a39bed8c606eefa4faef1088f21e94800">◆ </a></span>operator<<</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename ValueType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::ostream& operator<< </td> |
| <td>(</td> |
| <td class="paramtype">std::ostream & </td> |
| <td class="paramname"><em>os</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const <a class="el" href="classmxnet_1_1Tuple.html">Tuple</a>< ValueType > & </td> |
| <td class="paramname"><em>t</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">friend</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>allow output string of tuple to ostream </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">os</td><td>the output stream </td></tr> |
| <tr><td class="paramname">t</td><td>the tuple </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the ostream </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a0f33bc2b1cf75b9ef9d738e5fd9ea7ee"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0f33bc2b1cf75b9ef9d738e5fd9ea7ee">◆ </a></span>operator>></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename ValueType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::istream& operator>> </td> |
| <td>(</td> |
| <td class="paramtype">std::istream & </td> |
| <td class="paramname"><em>is</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="classmxnet_1_1Tuple.html">Tuple</a>< ValueType > & </td> |
| <td class="paramname"><em>t</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">friend</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>read tuple from the istream </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">is</td><td>the input stream </td></tr> |
| <tr><td class="paramname">t</td><td>The tuple </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the istream </dd></dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Data Documentation</h2> |
| <a id="a35847de488bef5570c45ac44f572b755"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a35847de488bef5570c45ac44f572b755">◆ </a></span>data_heap_</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename ValueType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">ValueType* <a class="el" href="classmxnet_1_1Tuple.html">mxnet::Tuple</a>< ValueType >::data_heap_ {nullptr}</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">protected</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>space to store shape when dimension is big </p> |
| |
| </div> |
| </div> |
| <a id="aed4c55d30bdc9e76bfb04895cab2bde1"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aed4c55d30bdc9e76bfb04895cab2bde1">◆ </a></span>data_stack_</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename ValueType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">ValueType <a class="el" href="classmxnet_1_1Tuple.html">mxnet::Tuple</a>< ValueType >::data_stack_[<a class="el" href="classmxnet_1_1Tuple.html#a69b5d9b088d983ebc6f975708568d1ae">kStackCache</a>]</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">protected</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>in stack space used to store shape when it is small </p> |
| |
| </div> |
| </div> |
| <a id="a69b5d9b088d983ebc6f975708568d1ae"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a69b5d9b088d983ebc6f975708568d1ae">◆ </a></span>kStackCache</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename ValueType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const int <a class="el" href="classmxnet_1_1Tuple.html">mxnet::Tuple</a>< ValueType >::kStackCache = 8</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="a424233ed3bd43df18ae411f18b27a400"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a424233ed3bd43df18ae411f18b27a400">◆ </a></span>ndim_</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename ValueType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int <a class="el" href="classmxnet_1_1Tuple.html">mxnet::Tuple</a>< ValueType >::ndim_ {0}</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">protected</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>number of dimension of the tuple </p> |
| |
| </div> |
| </div> |
| <a id="ab2896f3e9701715ac70934b98d31bba2"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab2896f3e9701715ac70934b98d31bba2">◆ </a></span>num_heap_allocated_</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename ValueType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int <a class="el" href="classmxnet_1_1Tuple.html">mxnet::Tuple</a>< ValueType >::num_heap_allocated_ {0}</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">protected</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>number of cells allocated in data_heap_ </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>/work/mxnet/include/mxnet/<a class="el" href="include_2mxnet_2tuple_8h_source.html">tuple.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Sat Nov 5 2022 01:16:58 for mxnet by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.17 |
| </small></address> |
| </body> |
| </html> |