| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Apache Singa: singa::CppCPU Class 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">Apache Singa |
| </div> |
| <div id="projectbrief">A General Distributed Deep Learning Library</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.13 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| </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="namespacesinga.html">singa</a></li><li class="navelem"><a class="el" href="classsinga_1_1CppCPU.html">CppCPU</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="classsinga_1_1CppCPU-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">singa::CppCPU Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Represent a CPU device which may have multiple threads/executors. |
| <a href="classsinga_1_1CppCPU.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="device_8h_source.html">device.h</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for singa::CppCPU:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classsinga_1_1CppCPU__inherit__graph.png" border="0" usemap="#singa_1_1CppCPU_inherit__map" alt="Inheritance graph"/></div> |
| <!-- MAP 0 --> |
| <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> |
| <div class="dynheader"> |
| Collaboration diagram for singa::CppCPU:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classsinga_1_1CppCPU__coll__graph.png" border="0" usemap="#singa_1_1CppCPU_coll__map" alt="Collaboration graph"/></div> |
| <!-- MAP 1 --> |
| <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></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:af6ae766acde41ea0953b7847d583d4ea"><td class="memItemLeft" align="right" valign="top"><a id="af6ae766acde41ea0953b7847d583d4ea"></a> |
| std::shared_ptr< <a class="el" href="classsinga_1_1Device.html">Device</a> > </td><td class="memItemRight" valign="bottom"><b>host</b> () const override</td></tr> |
| <tr class="separator:af6ae766acde41ea0953b7847d583d4ea"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4a5f8f8ef7f12533e0a24d074efc5389"><td class="memItemLeft" align="right" valign="top"><a id="a4a5f8f8ef7f12533e0a24d074efc5389"></a> |
| void </td><td class="memItemRight" valign="bottom"><b>SetRandSeed</b> (unsigned seed) override</td></tr> |
| <tr class="separator:a4a5f8f8ef7f12533e0a24d074efc5389"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_classsinga_1_1Device"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classsinga_1_1Device')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classsinga_1_1Device.html">singa::Device</a></td></tr> |
| <tr class="memitem:a6f74eb06d4d5df8ac6ea542a49cd28ce inherit pub_methods_classsinga_1_1Device"><td class="memItemLeft" align="right" valign="top"><a id="a6f74eb06d4d5df8ac6ea542a49cd28ce"></a> |
|  </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Device.html#a6f74eb06d4d5df8ac6ea542a49cd28ce">Device</a> (int id, int num_executors)</td></tr> |
| <tr class="memdesc:a6f74eb06d4d5df8ac6ea542a49cd28ce inherit pub_methods_classsinga_1_1Device"><td class="mdescLeft"> </td><td class="mdescRight">Constructor with device ID, num of executors (e.g., cuda streams), max mem size to use (in MB) <br /></td></tr> |
| <tr class="separator:a6f74eb06d4d5df8ac6ea542a49cd28ce inherit pub_methods_classsinga_1_1Device"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acdcaf51aa6aa3cd574531b309688dd99 inherit pub_methods_classsinga_1_1Device"><td class="memItemLeft" align="right" valign="top"><a id="acdcaf51aa6aa3cd574531b309688dd99"></a> |
| <a class="el" href="classsinga_1_1Block.html">Block</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Device.html#acdcaf51aa6aa3cd574531b309688dd99">NewBlock</a> (int size)</td></tr> |
| <tr class="memdesc:acdcaf51aa6aa3cd574531b309688dd99 inherit pub_methods_classsinga_1_1Device"><td class="mdescLeft"> </td><td class="mdescRight">Called by <a class="el" href="classsinga_1_1Tensor.html" title="A Tensor instance is a multi-dimensional array resident on a Device (default device is the host CPU)...">Tensor</a>. <br /></td></tr> |
| <tr class="separator:acdcaf51aa6aa3cd574531b309688dd99 inherit pub_methods_classsinga_1_1Device"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad2a3aaebf33c373739fcf77124332bfc inherit pub_methods_classsinga_1_1Device"><td class="memItemLeft" align="right" valign="top"><a id="ad2a3aaebf33c373739fcf77124332bfc"></a> |
| void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Device.html#ad2a3aaebf33c373739fcf77124332bfc">FreeBlock</a> (<a class="el" href="classsinga_1_1Block.html">Block</a> *block)</td></tr> |
| <tr class="memdesc:ad2a3aaebf33c373739fcf77124332bfc inherit pub_methods_classsinga_1_1Device"><td class="mdescLeft"> </td><td class="mdescRight">Called by <a class="el" href="classsinga_1_1Tensor.html" title="A Tensor instance is a multi-dimensional array resident on a Device (default device is the host CPU)...">Tensor</a>. <br /></td></tr> |
| <tr class="separator:ad2a3aaebf33c373739fcf77124332bfc inherit pub_methods_classsinga_1_1Device"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acf3169a7059287389466a408f9d68dc1 inherit pub_methods_classsinga_1_1Device"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Device.html#acf3169a7059287389466a408f9d68dc1">GetAllocatedMem</a> ()</td></tr> |
| <tr class="memdesc:acf3169a7059287389466a408f9d68dc1 inherit pub_methods_classsinga_1_1Device"><td class="mdescLeft"> </td><td class="mdescRight">Return the size (bytes) of memory in use TODO(wangwei) override this function for all devices. <a href="classsinga_1_1Device.html#acf3169a7059287389466a408f9d68dc1">More...</a><br /></td></tr> |
| <tr class="separator:acf3169a7059287389466a408f9d68dc1 inherit pub_methods_classsinga_1_1Device"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a84f17d9301ae2ad082322cdc0ad265f7 inherit pub_methods_classsinga_1_1Device"><td class="memItemLeft" align="right" valign="top"><a id="a84f17d9301ae2ad082322cdc0ad265f7"></a> |
| virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Device.html#a84f17d9301ae2ad082322cdc0ad265f7">CopyDataToFrom</a> (<a class="el" href="classsinga_1_1Block.html">Block</a> *dst, <a class="el" href="classsinga_1_1Block.html">Block</a> *src, size_t nBytes, CopyDirection direction, int dst_offset, int src_offset)</td></tr> |
| <tr class="memdesc:a84f17d9301ae2ad082322cdc0ad265f7 inherit pub_methods_classsinga_1_1Device"><td class="mdescLeft"> </td><td class="mdescRight">Copy data within or across devices. <br /></td></tr> |
| <tr class="separator:a84f17d9301ae2ad082322cdc0ad265f7 inherit pub_methods_classsinga_1_1Device"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad0245c7145d9ea642e071178aabffb10 inherit pub_methods_classsinga_1_1Device"><td class="memItemLeft" align="right" valign="top"><a id="ad0245c7145d9ea642e071178aabffb10"></a> |
| void </td><td class="memItemRight" valign="bottom"><b>CopyDataFromHostPtr</b> (<a class="el" href="classsinga_1_1Block.html">Block</a> *dst, const void *src, size_t nBytes, size_t dst_offset=0)</td></tr> |
| <tr class="separator:ad0245c7145d9ea642e071178aabffb10 inherit pub_methods_classsinga_1_1Device"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a13db259bad7b0b92ffeb7f661dcd9144 inherit pub_methods_classsinga_1_1Device"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Device.html#a13db259bad7b0b92ffeb7f661dcd9144">Exec</a> (function< void(<a class="el" href="structsinga_1_1__Context.html">Context</a> *)> &&fn, const vector< <a class="el" href="classsinga_1_1Block.html">Block</a> *> read_blocks, const vector< <a class="el" href="classsinga_1_1Block.html">Block</a> *> write_blocks, bool use_rand_generator=false)</td></tr> |
| <tr class="memdesc:a13db259bad7b0b92ffeb7f661dcd9144 inherit pub_methods_classsinga_1_1Device"><td class="mdescLeft"> </td><td class="mdescRight">Submit the operation to the device, which may execute it right now or delay it depending on the scheduler. <a href="classsinga_1_1Device.html#a13db259bad7b0b92ffeb7f661dcd9144">More...</a><br /></td></tr> |
| <tr class="separator:a13db259bad7b0b92ffeb7f661dcd9144 inherit pub_methods_classsinga_1_1Device"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a61744e09ab97eeeb8b822bd9adc930db inherit pub_methods_classsinga_1_1Device"><td class="memItemLeft" align="right" valign="top"><a id="a61744e09ab97eeeb8b822bd9adc930db"></a> |
| void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Device.html#a61744e09ab97eeeb8b822bd9adc930db">Sync</a> ()</td></tr> |
| <tr class="memdesc:a61744e09ab97eeeb8b822bd9adc930db inherit pub_methods_classsinga_1_1Device"><td class="mdescLeft"> </td><td class="mdescRight">wait for all operations submitted to this device. <br /></td></tr> |
| <tr class="separator:a61744e09ab97eeeb8b822bd9adc930db inherit pub_methods_classsinga_1_1Device"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6db2e92a308783e243eed58bc106edb9 inherit pub_methods_classsinga_1_1Device"><td class="memItemLeft" align="right" valign="top"><a id="a6db2e92a308783e243eed58bc106edb9"></a> |
| LangType </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Device.html#a6db2e92a308783e243eed58bc106edb9">lang</a> () const</td></tr> |
| <tr class="memdesc:a6db2e92a308783e243eed58bc106edb9 inherit pub_methods_classsinga_1_1Device"><td class="mdescLeft"> </td><td class="mdescRight">Return the programming language for this device. <br /></td></tr> |
| <tr class="separator:a6db2e92a308783e243eed58bc106edb9 inherit pub_methods_classsinga_1_1Device"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afdfbec14803559287bf443d0cf66caf1 inherit pub_methods_classsinga_1_1Device"><td class="memItemLeft" align="right" valign="top"><a id="afdfbec14803559287bf443d0cf66caf1"></a> |
| <a class="el" href="structsinga_1_1__Context.html">Context</a> * </td><td class="memItemRight" valign="bottom"><b>context</b> (int k)</td></tr> |
| <tr class="separator:afdfbec14803559287bf443d0cf66caf1 inherit pub_methods_classsinga_1_1Device"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aab575f6e99426ed98ae9563a047e6ae5 inherit pub_methods_classsinga_1_1Device"><td class="memItemLeft" align="right" valign="top"><a id="aab575f6e99426ed98ae9563a047e6ae5"></a> |
| int </td><td class="memItemRight" valign="bottom"><b>id</b> () const</td></tr> |
| <tr class="separator:aab575f6e99426ed98ae9563a047e6ae5 inherit pub_methods_classsinga_1_1Device"><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:a46216ccff1738d8856ae2b9fd917b531"><td class="memItemLeft" align="right" valign="top"><a id="a46216ccff1738d8856ae2b9fd917b531"></a> |
| void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1CppCPU.html#a46216ccff1738d8856ae2b9fd917b531">DoExec</a> (function< void(<a class="el" href="structsinga_1_1__Context.html">Context</a> *)> &&fn, int executor) override</td></tr> |
| <tr class="memdesc:a46216ccff1738d8856ae2b9fd917b531"><td class="mdescLeft"> </td><td class="mdescRight">Execute one operation on one executor. <br /></td></tr> |
| <tr class="separator:a46216ccff1738d8856ae2b9fd917b531"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af69e1f26500f9a9a23555a6b4f004a39"><td class="memItemLeft" align="right" valign="top"><a id="af69e1f26500f9a9a23555a6b4f004a39"></a> |
| void </td><td class="memItemRight" valign="bottom"><b>CopyToFrom</b> (void *dst, const void *src, size_t nBytes, CopyDirection direction, <a class="el" href="structsinga_1_1__Context.html">Context</a> *ctx) override</td></tr> |
| <tr class="separator:af69e1f26500f9a9a23555a6b4f004a39"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad10f9b2bca5b37dedb76de5597657e43"><td class="memItemLeft" align="right" valign="top"><a id="ad10f9b2bca5b37dedb76de5597657e43"></a> |
| void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1CppCPU.html#ad10f9b2bca5b37dedb76de5597657e43">Malloc</a> (int size) override</td></tr> |
| <tr class="memdesc:ad10f9b2bca5b37dedb76de5597657e43"><td class="mdescLeft"> </td><td class="mdescRight">Allocate cpu memory. <br /></td></tr> |
| <tr class="separator:ad10f9b2bca5b37dedb76de5597657e43"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac43f2d6818fe6f10d74d4377c7ee2b27"><td class="memItemLeft" align="right" valign="top"><a id="ac43f2d6818fe6f10d74d4377c7ee2b27"></a> |
| void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1CppCPU.html#ac43f2d6818fe6f10d74d4377c7ee2b27">Free</a> (void *ptr) override</td></tr> |
| <tr class="memdesc:ac43f2d6818fe6f10d74d4377c7ee2b27"><td class="mdescLeft"> </td><td class="mdescRight">Free cpu memory. <br /></td></tr> |
| <tr class="separator:ac43f2d6818fe6f10d74d4377c7ee2b27"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a> |
| Additional Inherited Members</h2></td></tr> |
| <tr class="inherit_header pro_attribs_classsinga_1_1Device"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classsinga_1_1Device')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classsinga_1_1Device.html">singa::Device</a></td></tr> |
| <tr class="memitem:a13eec194e2950564a617e2a90117f4d4 inherit pro_attribs_classsinga_1_1Device"><td class="memItemLeft" align="right" valign="top"><a id="a13eec194e2950564a617e2a90117f4d4"></a> |
| int </td><td class="memItemRight" valign="bottom"><b>id_</b> = 0</td></tr> |
| <tr class="separator:a13eec194e2950564a617e2a90117f4d4 inherit pro_attribs_classsinga_1_1Device"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab5e132c43017d391300a13363a008e48 inherit pro_attribs_classsinga_1_1Device"><td class="memItemLeft" align="right" valign="top"><a id="ab5e132c43017d391300a13363a008e48"></a> |
| int </td><td class="memItemRight" valign="bottom"><b>num_executors_</b> = 0</td></tr> |
| <tr class="separator:ab5e132c43017d391300a13363a008e48 inherit pro_attribs_classsinga_1_1Device"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2919065d27373e4b6234a244760f151c inherit pro_attribs_classsinga_1_1Device"><td class="memItemLeft" align="right" valign="top"><a id="a2919065d27373e4b6234a244760f151c"></a> |
| unsigned </td><td class="memItemRight" valign="bottom"><b>seed_</b> = 0</td></tr> |
| <tr class="separator:a2919065d27373e4b6234a244760f151c inherit pro_attribs_classsinga_1_1Device"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6401c02a3f4a96994f37ed3312cacb45 inherit pro_attribs_classsinga_1_1Device"><td class="memItemLeft" align="right" valign="top"><a id="a6401c02a3f4a96994f37ed3312cacb45"></a> |
| LangType </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Device.html#a6401c02a3f4a96994f37ed3312cacb45">lang_</a></td></tr> |
| <tr class="memdesc:a6401c02a3f4a96994f37ed3312cacb45 inherit pro_attribs_classsinga_1_1Device"><td class="mdescLeft"> </td><td class="mdescRight">Programming language type, could be kCpp, kCuda, kOpencl. <br /></td></tr> |
| <tr class="separator:a6401c02a3f4a96994f37ed3312cacb45 inherit pro_attribs_classsinga_1_1Device"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3d27f7538aabe42e9eea3f10cf702148 inherit pro_attribs_classsinga_1_1Device"><td class="memItemLeft" align="right" valign="top"><a id="a3d27f7538aabe42e9eea3f10cf702148"></a> |
| std::shared_ptr< <a class="el" href="classsinga_1_1Device.html">Device</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Device.html#a3d27f7538aabe42e9eea3f10cf702148">host_</a></td></tr> |
| <tr class="memdesc:a3d27f7538aabe42e9eea3f10cf702148 inherit pro_attribs_classsinga_1_1Device"><td class="mdescLeft"> </td><td class="mdescRight">The host device. <br /></td></tr> |
| <tr class="separator:a3d27f7538aabe42e9eea3f10cf702148 inherit pro_attribs_classsinga_1_1Device"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af1bdf617ae8f45c24cfabf32e66c82fc inherit pro_attribs_classsinga_1_1Device"><td class="memItemLeft" align="right" valign="top"><a id="af1bdf617ae8f45c24cfabf32e66c82fc"></a> |
| <a class="el" href="structsinga_1_1__Context.html">Context</a> </td><td class="memItemRight" valign="bottom"><b>ctx_</b></td></tr> |
| <tr class="separator:af1bdf617ae8f45c24cfabf32e66c82fc inherit pro_attribs_classsinga_1_1Device"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Represent a CPU device which may have multiple threads/executors. </p> |
| <p>It runs cpp code. </p> |
| </div><hr/>The documentation for this class was generated from the following file:<ul> |
| <li>/home/moaz/incubator-singa/include/singa/core/<a class="el" href="device_8h_source.html">device.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Mon Apr 22 2019 12:27:05 for Apache Singa by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.13 |
| </small></address> |
| </body> |
| </html> |
