mirror of
https://github.com/PhasicFlow/phasicFlow.git
synced 2025-06-12 16:26:23 +00:00
first commit of documentation
This commit is contained in:
199
doc/code-documentation/html/namespacepFlow_1_1algorithms.html
Normal file
199
doc/code-documentation/html/namespacepFlow_1_1algorithms.html
Normal file
@ -0,0 +1,199 @@
|
||||
<!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.17"/>
|
||||
<title>PhasicFlow: pFlow::algorithms Namespace 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="navtreedata.js"></script>
|
||||
<script type="text/javascript" src="navtree.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>
|
||||
<script type="text/javascript">
|
||||
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
||||
$(document).ready(function() { init_search(); });
|
||||
/* @license-end */
|
||||
</script>
|
||||
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||
<link href="customdoxygen.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"><a href="https://cemf.ir">PhasicFlow</a>
|
||||
 <span id="projectnumber"><a href="https://cemf.ir">v0.1</a></span>
|
||||
</div>
|
||||
<div id="projectbrief"><a href="www.github.com/PhasicFlow">www.cemf.ir</a></div>
|
||||
</td>
|
||||
<td> <div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
alt=""/>
|
||||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||
</span>
|
||||
</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>
|
||||
</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">
|
||||
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
||||
$(document).ready(function(){initNavTree('namespacepFlow_1_1algorithms.html',''); initResizable(); });
|
||||
/* @license-end */
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- 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 class="header">
|
||||
<div class="summary">
|
||||
<a href="#namespaces">Namespaces</a> |
|
||||
<a href="#nested-classes">Classes</a> |
|
||||
<a href="#func-members">Functions</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">pFlow::algorithms Namespace Reference</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
<table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
|
||||
Namespaces</h2></td></tr>
|
||||
<tr class="memitem:namespacepFlow_1_1algorithms_1_1KOKKOS"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepFlow_1_1algorithms_1_1KOKKOS.html">KOKKOS</a></td></tr>
|
||||
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:namespacepFlow_1_1algorithms_1_1STD"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepFlow_1_1algorithms_1_1STD.html">STD</a></td></tr>
|
||||
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table><table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
||||
Classes</h2></td></tr>
|
||||
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structpFlow_1_1algorithms_1_1greater.html">greater</a></td></tr>
|
||||
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structpFlow_1_1algorithms_1_1less.html">less</a></td></tr>
|
||||
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structpFlow_1_1algorithms_1_1maximum.html">maximum</a></td></tr>
|
||||
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structpFlow_1_1algorithms_1_1minimum.html">minimum</a></td></tr>
|
||||
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table><table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
||||
Functions</h2></td></tr>
|
||||
<tr class="memitem:aac8c2b3b7bb9575b6f566e414e61b58d"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
||||
<tr class="memitem:aac8c2b3b7bb9575b6f566e414e61b58d"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="pFlowMacros_8hpp.html#a8e2f73fa5c113f21c9c9edb67a974f5e">INLINE_FUNCTION_HD</a> int </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacepFlow_1_1algorithms.html#aac8c2b3b7bb9575b6f566e414e61b58d">binarySearch</a> (const T *array, int <a class="el" href="tripleFwd_8hpp.html#ae1449f1d56abab2ec4d0f00b685fc478">length</a>, const T &val)</td></tr>
|
||||
<tr class="separator:aac8c2b3b7bb9575b6f566e414e61b58d"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<h2 class="groupheader">Function Documentation</h2>
|
||||
<a id="aac8c2b3b7bb9575b6f566e414e61b58d"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#aac8c2b3b7bb9575b6f566e414e61b58d">◆ </a></span>binarySearch()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname"><a class="el" href="pFlowMacros_8hpp.html#a8e2f73fa5c113f21c9c9edb67a974f5e">INLINE_FUNCTION_HD</a> int pFlow::algorithms::binarySearch </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const T * </td>
|
||||
<td class="paramname"><em>array</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">int </td>
|
||||
<td class="paramname"><em>length</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">const T & </td>
|
||||
<td class="paramname"><em>val</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="algorithmFunctions_8hpp_source.html#l00066">66</a> of file <a class="el" href="algorithmFunctions_8hpp_source.html">algorithmFunctions.hpp</a>.</p>
|
||||
|
||||
<p class="reference">References <a class="el" href="tripleFwd_8hpp.html#ae1449f1d56abab2ec4d0f00b685fc478">length()</a>.</p>
|
||||
|
||||
<p class="reference">Referenced by <a class="el" href="ViewAlgorithms_8hpp_source.html#l00495">pFlow::binarySearch()</a>.</p>
|
||||
<div class="dynheader">
|
||||
Here is the call graph for this function:</div>
|
||||
<div class="dyncontent">
|
||||
<div class="center"><img src="namespacepFlow_1_1algorithms_aac8c2b3b7bb9575b6f566e414e61b58d_cgraph.png" border="0" usemap="#namespacepFlow_1_1algorithms_aac8c2b3b7bb9575b6f566e414e61b58d_cgraph" alt=""/></div>
|
||||
<map name="namespacepFlow_1_1algorithms_aac8c2b3b7bb9575b6f566e414e61b58d_cgraph" id="namespacepFlow_1_1algorithms_aac8c2b3b7bb9575b6f566e414e61b58d_cgraph">
|
||||
<area shape="rect" title=" " alt="" coords="5,5,112,32"/>
|
||||
<area shape="rect" href="tripleFwd_8hpp.html#ae1449f1d56abab2ec4d0f00b685fc478" title=" " alt="" coords="160,5,223,32"/>
|
||||
</map>
|
||||
</div>
|
||||
<div class="dynheader">
|
||||
Here is the caller graph for this function:</div>
|
||||
<div class="dyncontent">
|
||||
<div class="center"><img src="namespacepFlow_1_1algorithms_aac8c2b3b7bb9575b6f566e414e61b58d_icgraph.png" border="0" usemap="#namespacepFlow_1_1algorithms_aac8c2b3b7bb9575b6f566e414e61b58d_icgraph" alt=""/></div>
|
||||
<map name="namespacepFlow_1_1algorithms_aac8c2b3b7bb9575b6f566e414e61b58d_icgraph" id="namespacepFlow_1_1algorithms_aac8c2b3b7bb9575b6f566e414e61b58d_icgraph">
|
||||
<area shape="rect" title=" " alt="" coords="207,5,313,32"/>
|
||||
<area shape="rect" href="namespacepFlow.html#a3bd64e8adc68abe4a5cb3f2b42413c6e" title=" " alt="" coords="5,5,159,32"/>
|
||||
</map>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="navelem"><a class="el" href="namespacepFlow.html">pFlow</a></li><li class="navelem"><a class="el" href="namespacepFlow_1_1algorithms.html">algorithms</a></li>
|
||||
<li class="footer">Generated by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
Reference in New Issue
Block a user