diff options
| author | cathook <b01902109@csie.ntu.edu.tw> | 2014-09-24 13:37:42 +0800 |
|---|---|---|
| committer | cathook <b01902109@csie.ntu.edu.tw> | 2014-09-29 16:55:57 +0800 |
| commit | 8b76fbb408f8eedab24195655c45c891af01eaab (patch) | |
| tree | 414d7fc87885cb77e181a3ab99e334b837621036 /doc/html/classmeow_1_1Operation.html | |
| parent | ef9af0d577c3a6b5d11fdeed7a9149d09973171b (diff) | |
| download | meow-8b76fbb408f8eedab24195655c45c891af01eaab.tar meow-8b76fbb408f8eedab24195655c45c891af01eaab.tar.gz meow-8b76fbb408f8eedab24195655c45c891af01eaab.tar.bz2 meow-8b76fbb408f8eedab24195655c45c891af01eaab.tar.lz meow-8b76fbb408f8eedab24195655c45c891af01eaab.tar.xz meow-8b76fbb408f8eedab24195655c45c891af01eaab.tar.zst meow-8b76fbb408f8eedab24195655c45c891af01eaab.zip | |
Big change, detail see README.
Diffstat (limited to 'doc/html/classmeow_1_1Operation.html')
| -rw-r--r-- | doc/html/classmeow_1_1Operation.html | 318 |
1 files changed, 318 insertions, 0 deletions
diff --git a/doc/html/classmeow_1_1Operation.html b/doc/html/classmeow_1_1Operation.html new file mode 100644 index 0000000..fd8d006 --- /dev/null +++ b/doc/html/classmeow_1_1Operation.html @@ -0,0 +1,318 @@ +<!-- HTML header for doxygen 1.8.3.1--> +<!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.6"/> +<title>Templates -- Meow: meow::Operation 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="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); + $(window).load(resizeHeight); +</script> +<link href="stylesheet.css" rel="stylesheet" type="text/css" /> +<link href="custom.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="logo.png"/></td> + <td style="padding-left: 0.5em;"> + <div id="projectname">Templates -- Meow +  <span id="projectnumber">2.0.-1</span> + </div> + <div id="projectbrief">A C++ template contains kinds of interesting classes and functions</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.6 --> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +$(document).ready(function(){initNavTree('classmeow_1_1Operation.html','');}); +</script> +<div id="doc-content"> +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="#pro-methods">Protected Member Functions</a> | +<a href="classmeow_1_1Operation-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">meow::Operation Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> +</div><!--header--> +<div class="contents"> + +<p>Base class for operations. + <a href="classmeow_1_1Operation.html#details">More...</a></p> + +<p><code>#include "<a class="el" href="operation_8h_source.html">operation.h</a>"</code></p> +<div class="dynheader"> +Inheritance diagram for meow::Operation:</div> +<div class="dyncontent"> + <div class="center"> + <img src="classmeow_1_1Operation.png" usemap="#meow::Operation_map" alt=""/> + <map id="meow::Operation_map" name="meow::Operation_map"> +<area href="classmeow_1_1Object.html" title="The base class. " alt="meow::Object" shape="rect" coords="0,0,106,24"/> +</map> + </div></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:a1d8b43477b96e6e645874cb90cfe3a80"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Operation.html#a1d8b43477b96e6e645874cb90cfe3a80">~Operation</a> ()</td></tr> +<tr class="memdesc:a1d8b43477b96e6e645874cb90cfe3a80"><td class="mdescLeft"> </td><td class="mdescRight">Virtual destructor. <a href="#a1d8b43477b96e6e645874cb90cfe3a80">More...</a><br/></td></tr> +<tr class="separator:a1d8b43477b96e6e645874cb90cfe3a80"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a81bca71581576d842b4c46df0bfafbb8"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classmeow_1_1State.html">State</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Operation.html#a81bca71581576d842b4c46df0bfafbb8">Operate</a> (<a class="el" href="classmeow_1_1Pointer.html">Pointer</a>< <a class="el" href="classmeow_1_1Object.html">Object</a> const > const *inputs_ptr, <a class="el" href="classmeow_1_1Pointer.html">Pointer</a>< <a class="el" href="classmeow_1_1Object.html">Object</a> > const *outputs_ptr) const =0</td></tr> +<tr class="memdesc:a81bca71581576d842b4c46df0bfafbb8"><td class="mdescLeft"> </td><td class="mdescRight">Pure virtual method for running the operation. <a href="#a81bca71581576d842b4c46df0bfafbb8">More...</a><br/></td></tr> +<tr class="separator:a81bca71581576d842b4c46df0bfafbb8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aebe8cd0c6e157119e2601bd2afef6e16"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Operation.html#aebe8cd0c6e157119e2601bd2afef6e16">inputs_size</a> () const </td></tr> +<tr class="memdesc:aebe8cd0c6e157119e2601bd2afef6e16"><td class="mdescLeft"> </td><td class="mdescRight">Gets the number of inputs for the operation. <a href="#aebe8cd0c6e157119e2601bd2afef6e16">More...</a><br/></td></tr> +<tr class="separator:aebe8cd0c6e157119e2601bd2afef6e16"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0c608010ecb2f37f3cce547a898be549"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Operation.html#a0c608010ecb2f37f3cce547a898be549">outputs_size</a> () const </td></tr> +<tr class="memdesc:a0c608010ecb2f37f3cce547a898be549"><td class="mdescLeft"> </td><td class="mdescRight">Gets the number of outputs for the operation. <a href="#a0c608010ecb2f37f3cce547a898be549">More...</a><br/></td></tr> +<tr class="separator:a0c608010ecb2f37f3cce547a898be549"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="inherit_header pub_methods_classmeow_1_1Object"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classmeow_1_1Object')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classmeow_1_1Object.html">meow::Object</a></td></tr> +<tr class="memitem:a5e41ab604d3e387c4293863eace18a75 inherit pub_methods_classmeow_1_1Object"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Object.html#a5e41ab604d3e387c4293863eace18a75">~Object</a> ()</td></tr> +<tr class="memdesc:a5e41ab604d3e387c4293863eace18a75 inherit pub_methods_classmeow_1_1Object"><td class="mdescLeft"> </td><td class="mdescRight">Virtual destructor. <a href="#a5e41ab604d3e387c4293863eace18a75">More...</a><br/></td></tr> +<tr class="separator:a5e41ab604d3e387c4293863eace18a75 inherit pub_methods_classmeow_1_1Object"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a875c9a989fc858fd49dd00a0d059142c inherit pub_methods_classmeow_1_1Object"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classmeow_1_1Object.html">Object</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Object.html#a875c9a989fc858fd49dd00a0d059142c">Copy</a> () const </td></tr> +<tr class="memdesc:a875c9a989fc858fd49dd00a0d059142c inherit pub_methods_classmeow_1_1Object"><td class="mdescLeft"> </td><td class="mdescRight">Creates a copy of itself and return the pointer to it. <a href="#a875c9a989fc858fd49dd00a0d059142c">More...</a><br/></td></tr> +<tr class="separator:a875c9a989fc858fd49dd00a0d059142c inherit pub_methods_classmeow_1_1Object"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9b30b1200154d5f71f99694d835b9a49 inherit pub_methods_classmeow_1_1Object"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classmeow_1_1Object.html">Object</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Object.html#a9b30b1200154d5f71f99694d835b9a49">CopyFrom</a> (<a class="el" href="classmeow_1_1Object.html">Object</a> const *ptr)</td></tr> +<tr class="memdesc:a9b30b1200154d5f71f99694d835b9a49 inherit pub_methods_classmeow_1_1Object"><td class="mdescLeft"> </td><td class="mdescRight">Copies data from another object. <a href="#a9b30b1200154d5f71f99694d835b9a49">More...</a><br/></td></tr> +<tr class="separator:a9b30b1200154d5f71f99694d835b9a49 inherit pub_methods_classmeow_1_1Object"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a59485e5cace45c0711fe86b6b693c10f inherit pub_methods_classmeow_1_1Object"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Object.html#a59485e5cace45c0711fe86b6b693c10f">Equals</a> (<a class="el" href="classmeow_1_1Object.html">Object</a> const *ptr) const </td></tr> +<tr class="memdesc:a59485e5cace45c0711fe86b6b693c10f inherit pub_methods_classmeow_1_1Object"><td class="mdescLeft"> </td><td class="mdescRight">Returns whether it equals to another object or not. <a href="#a59485e5cace45c0711fe86b6b693c10f">More...</a><br/></td></tr> +<tr class="separator:a59485e5cace45c0711fe86b6b693c10f inherit pub_methods_classmeow_1_1Object"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9d22bc97e9a5f11acaade41a1f07bc3b inherit pub_methods_classmeow_1_1Object"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmeow_1_1Object.html">Object</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Object.html#a9d22bc97e9a5f11acaade41a1f07bc3b">operator=</a> (<a class="el" href="classmeow_1_1Object.html">Object</a> const &b)</td></tr> +<tr class="memdesc:a9d22bc97e9a5f11acaade41a1f07bc3b inherit pub_methods_classmeow_1_1Object"><td class="mdescLeft"> </td><td class="mdescRight">Disable the copy operator. <a href="#a9d22bc97e9a5f11acaade41a1f07bc3b">More...</a><br/></td></tr> +<tr class="separator:a9d22bc97e9a5f11acaade41a1f07bc3b inherit pub_methods_classmeow_1_1Object"><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:a08590b8ca7c9c7b566cb757949573648"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Operation.html#a08590b8ca7c9c7b566cb757949573648">Operation</a> (int arg_inputs_size, int arg_outputs_size)</td></tr> +<tr class="memdesc:a08590b8ca7c9c7b566cb757949573648"><td class="mdescLeft"> </td><td class="mdescRight">A protected constructor to prevent developers create an instance of <a class="el" href="classmeow_1_1Operation.html" title="Base class for operations. ">Operation</a> directly. <a href="#a08590b8ca7c9c7b566cb757949573648">More...</a><br/></td></tr> +<tr class="separator:a08590b8ca7c9c7b566cb757949573648"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="inherit_header pro_methods_classmeow_1_1Object"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classmeow_1_1Object')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classmeow_1_1Object.html">meow::Object</a></td></tr> +<tr class="memitem:a8f2e9eec4d103846693a9d0c2b215d23 inherit pro_methods_classmeow_1_1Object"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Object.html#a8f2e9eec4d103846693a9d0c2b215d23">Object</a> ()</td></tr> +<tr class="memdesc:a8f2e9eec4d103846693a9d0c2b215d23 inherit pro_methods_classmeow_1_1Object"><td class="mdescLeft"> </td><td class="mdescRight">A protected constructor to prevent developers create an instance of <a class="el" href="classmeow_1_1Object.html" title="The base class. ">Object</a> directly. <a href="#a8f2e9eec4d103846693a9d0c2b215d23">More...</a><br/></td></tr> +<tr class="separator:a8f2e9eec4d103846693a9d0c2b215d23 inherit pro_methods_classmeow_1_1Object"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a02b219848bde794cd138aa644c9e6147 inherit pro_methods_classmeow_1_1Object"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Object.html#a02b219848bde794cd138aa644c9e6147">Object</a> (<a class="el" href="classmeow_1_1Object.html">Object</a> const &b)</td></tr> +<tr class="memdesc:a02b219848bde794cd138aa644c9e6147 inherit pro_methods_classmeow_1_1Object"><td class="mdescLeft"> </td><td class="mdescRight">Disable the copy operation. <a href="#a02b219848bde794cd138aa644c9e6147">More...</a><br/></td></tr> +<tr class="separator:a02b219848bde794cd138aa644c9e6147 inherit pro_methods_classmeow_1_1Object"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>Base class for operations. </p> + +<p>Definition at line <a class="el" href="operation_8h_source.html#l00022">22</a> of file <a class="el" href="operation_8h_source.html">operation.h</a>.</p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a class="anchor" id="a08590b8ca7c9c7b566cb757949573648"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">meow::Operation::Operation </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"><em>arg_inputs_size</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>arg_outputs_size</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 class="mlabel">protected</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>A protected constructor to prevent developers create an instance of <a class="el" href="classmeow_1_1Operation.html" title="Base class for operations. ">Operation</a> directly. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">arg_inputs_size</td><td>Number of inputs for the operation. </td></tr> + <tr><td class="paramname">arg_outputs_size</td><td>Number of outputs for the operation. </td></tr> + </table> + </dd> +</dl> + +<p>Definition at line <a class="el" href="operation_8h_source.html#l00035">35</a> of file <a class="el" href="operation_8h_source.html">operation.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a1d8b43477b96e6e645874cb90cfe3a80"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual meow::Operation::~Operation </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 class="mlabel">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Virtual destructor. </p> + +<p>Definition at line <a class="el" href="operation_8h_source.html#l00043">43</a> of file <a class="el" href="operation_8h_source.html">operation.h</a>.</p> + +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a class="anchor" id="aebe8cd0c6e157119e2601bd2afef6e16"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">int meow::Operation::inputs_size </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"> + +<p>Gets the number of inputs for the operation. </p> +<dl class="section return"><dt>Returns</dt><dd>Number of inputs. </dd></dl> + +<p>Definition at line <a class="el" href="operation_8h_source.html#l00060">60</a> of file <a class="el" href="operation_8h_source.html">operation.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a81bca71581576d842b4c46df0bfafbb8"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="classmeow_1_1State.html">State</a> meow::Operation::Operate </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classmeow_1_1Pointer.html">Pointer</a>< <a class="el" href="classmeow_1_1Object.html">Object</a> const > const * </td> + <td class="paramname"><em>inputs_ptr</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classmeow_1_1Pointer.html">Pointer</a>< <a class="el" href="classmeow_1_1Object.html">Object</a> > const * </td> + <td class="paramname"><em>outputs_ptr</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</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>Pure virtual method for running the operation. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">inputs_ptr</td><td>An array with each elements being a pointer points to the input elements. </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">outputs_ptr</td><td>An array with each elements being a pointer points to the output elements. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>The state of the operation (ex: fail, success, ...) </dd></dl> + +</div> +</div> +<a class="anchor" id="a0c608010ecb2f37f3cce547a898be549"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">int meow::Operation::outputs_size </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"> + +<p>Gets the number of outputs for the operation. </p> +<dl class="section return"><dt>Returns</dt><dd>Number of outputs. </dd></dl> + +<p>Definition at line <a class="el" href="operation_8h_source.html#l00068">68</a> of file <a class="el" href="operation_8h_source.html">operation.h</a>.</p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>/home/cathook/Projects/template_meow/meowpp/utility/<a class="el" href="operation_8h_source.html">operation.h</a></li> +</ul> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- HTML footer for doxygen 1.8.3.1--> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="navelem"><a class="el" href="namespacemeow.html">meow</a></li><li class="navelem"><a class="el" href="classmeow_1_1Operation.html">Operation</a></li> + <li class="footer">Generated on Mon Sep 29 2014 16:55:35 for Templates -- Meow by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li> + </ul> +</div> +</body> +</html> |