blob: 57c95308efbcd6723a0f54ac19a642d37d7a4219 [file] [log] [blame]
<!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>&nbsp; Apache Ignite C++: ignite::compute::ComputeFunc&lt; R &gt; 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="projectlogo"><img alt="Logo" src="ignite_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">&nbsp; Apache Ignite C++
</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&amp;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&amp;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="namespaceignite.html">ignite</a></li><li class="navelem"><b>compute</b></li><li class="navelem"><a class="el" href="classignite_1_1compute_1_1ComputeFunc.html">ComputeFunc</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classignite_1_1compute_1_1ComputeFunc-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ignite::compute::ComputeFunc&lt; R &gt; Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Interface for a simple compute function that can be serialized and called on the remote nodes.
<a href="classignite_1_1compute_1_1ComputeFunc.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="compute__func_8h_source.html">compute_func.h</a>&gt;</code></p>
<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:a527f72c84854a00e66f007d5cc460e95"><td class="memItemLeft" align="right" valign="top"><a id="a527f72c84854a00e66f007d5cc460e95"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1compute_1_1ComputeFunc.html#a527f72c84854a00e66f007d5cc460e95">ComputeFunc</a> ()</td></tr>
<tr class="memdesc:a527f72c84854a00e66f007d5cc460e95"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
<tr class="separator:a527f72c84854a00e66f007d5cc460e95"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a45e62796fb8dbe708998aba8315f20c5"><td class="memItemLeft" align="right" valign="top"><a id="a45e62796fb8dbe708998aba8315f20c5"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1compute_1_1ComputeFunc.html#a45e62796fb8dbe708998aba8315f20c5">~ComputeFunc</a> ()</td></tr>
<tr class="memdesc:a45e62796fb8dbe708998aba8315f20c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:a45e62796fb8dbe708998aba8315f20c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a28949608551a7b65cc7a803677800cbf"><td class="memItemLeft" align="right" valign="top">virtual R&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1compute_1_1ComputeFunc.html#a28949608551a7b65cc7a803677800cbf">Call</a> ()=0</td></tr>
<tr class="memdesc:a28949608551a7b65cc7a803677800cbf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called upon execution by compute. <a href="classignite_1_1compute_1_1ComputeFunc.html#a28949608551a7b65cc7a803677800cbf">More...</a><br /></td></tr>
<tr class="separator:a28949608551a7b65cc7a803677800cbf"><td class="memSeparator" colspan="2">&#160;</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:a99578980c7abc7e7d0f16cc56cb7c2af"><td class="memItemLeft" align="right" valign="top"><a id="a99578980c7abc7e7d0f16cc56cb7c2af"></a>
<a class="el" href="classignite_1_1Ignite.html">Ignite</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>GetIgnite</b> ()</td></tr>
<tr class="separator:a99578980c7abc7e7d0f16cc56cb7c2af"><td class="memSeparator" colspan="2">&#160;</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:aa34a0be1595210492712ef0e2532afe2"><td class="memTemplParams" colspan="2"><a id="aa34a0be1595210492712ef0e2532afe2"></a>
template&lt;typename TF , typename TR &gt; </td></tr>
<tr class="memitem:aa34a0be1595210492712ef0e2532afe2"><td class="memTemplItemLeft" align="right" valign="top">class&#160;</td><td class="memTemplItemRight" valign="bottom"><b>ignite::impl::compute::ComputeJobHolderImpl</b></td></tr>
<tr class="separator:aa34a0be1595210492712ef0e2532afe2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3c17ed47ba81606c8b517b4dca488c43"><td class="memItemLeft" align="right" valign="top"><a id="a3c17ed47ba81606c8b517b4dca488c43"></a>
class&#160;</td><td class="memItemRight" valign="bottom"><b>ignite::IgniteBinding</b></td></tr>
<tr class="separator:a3c17ed47ba81606c8b517b4dca488c43"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename R&gt;<br />
class ignite::compute::ComputeFunc&lt; R &gt;</h3>
<p>Interface for a simple compute function that can be serialized and called on the remote nodes. </p>
<p><a class="el" href="structignite_1_1binary_1_1BinaryType.html" title="Binary type structure.">ignite::binary::BinaryType</a> class template should be specialized for any class, inheriting from this class.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">R</td><td>Call return type. BinaryType should be specialized for the type if it is not primitive. </td></tr>
</table>
</dd>
</dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a28949608551a7b65cc7a803677800cbf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a28949608551a7b65cc7a803677800cbf">&#9670;&nbsp;</a></span>Call()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename R &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual R <a class="el" href="classignite_1_1compute_1_1ComputeFunc.html">ignite::compute::ComputeFunc</a>&lt; R &gt;::Call </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called upon execution by compute. </p>
<dl class="section return"><dt>Returns</dt><dd>Computation result. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="compute__func_8h_source.html">compute_func.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Jan 10 2022 11:02:04 for &nbsp; Apache Ignite C++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>