-
Notifications
You must be signed in to change notification settings - Fork 1
/
class_b_w_a_p_i_1_1_best_filter.html
1 lines (1 loc) · 8.78 KB
/
class_b_w_a_p_i_1_1_best_filter.html
1
<!DOCTYPE html><html><head><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1"><title>BWAPI: BWAPI::BestFilter< _PARAM > Class Template Reference</title><link rel="shortcut icon" href="favicon.ico" type="image/x-icon"><link rel="icon" href="favicon.ico" type="image/x-icon"><script>if(window.location.protocol!="file:"){(function(d,e,j,h,f,c,b){d.GoogleAnalyticsObject=f;d[f]=d[f]||function(){(d[f].q=d[f].q||[]).push(arguments)},d[f].l=1*new Date();c=e.createElement(j),b=e.getElementsByTagName(j)[0];c.async=1;c.src=h;b.parentNode.insertBefore(c,b)})(window,document,"script","//www.google-analytics.com/analytics.js","ga");ga("create","UA-11415685-4","auto");ga("send","pageview")};</script><link href="doxygen.css" rel="stylesheet"><script src="search/search.js"></script></head><body><div id="top"><div id="titlearea"><table><tbody><tr style="height: 56px;"><td id="projectlogo"><img style="width:110px;height:55px;" alt="Logo" src="logo.png"></td><td style="padding-left: 0.5em;"><div id="projectname">BWAPI <span id="projectnumber">4.2.0</span></div><div id="projectbrief">An API for interacting with Starcraft: Broodwar (1.16.1)</div></td></tr></tbody></table><div class="ribbon"><a href="//github.com/bwapi/bwapi">Fork me on GitHub</a></div></div><script>var searchBox=new SearchBox("searchBox","search",false,"Search");</script><div id="navrow1" class="tabs"><ul class="tablist"><li><a href="index.html"><span>Main Page</span></a></li><li><a href="modules.html"><span>Modules</span></a></li><li><a href="namespaces.html"><span>Namespaces</span></a></li><li class="current"><a href="annotated.html"><span>Classes</span></a></li><li><a href="//github.com/bwapi/bwapi/issues"><span>Issues</span></a></li><li><a href="//github.com/bwapi/bwapi/wiki"><span>Wiki</span></a></li><li><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 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" src="search/close.png" alt=""></a></span></div></li></ul></div><div id="navrow2" class="tabs2"><ul class="tablist"><li><a href="annotated.html"><span>Class List</span></a></li><li><a href="classes.html"><span>Class Index</span></a></li><li><a href="inherits.html"><span>Class Hierarchy</span></a></li><li><a href="functions.html"><span>Class Members</span></a></li></ul></div><div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"></div><div id="MSearchResultsWindow"><iframe src="javascript:void(0)" name="MSearchResults" id="MSearchResults"></iframe></div><div id="nav-path" class="navpath"><ul><li class="navelem"><a class="el" href="namespace_b_w_a_p_i.html">BWAPI</a></li><li class="navelem"><a class="el" href="class_b_w_a_p_i_1_1_best_filter.html">BestFilter</a></li></ul></div></div><div class="header"><div class="summary"><a href="#pub-methods">Public Member Functions</a> | <a href="class_b_w_a_p_i_1_1_best_filter-members.html">List of all members</a></div><div class="headertitle"><div class="title">BWAPI::BestFilter< _PARAM > Class Template Reference</div></div></div><div class="contents"><table class="memberdecls"><tbody><tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods"></a> Public Member Functions</h2></td></tr><tr><td class="memTemplParams" colspan="2">template<typename _T > </td></tr><tr><td class="memTemplItemLeft" align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_b_w_a_p_i_1_1_best_filter.html#ae34bdf1c00a51f106627c3d126555393">BestFilter</a> (const _T &predicate)</td></tr><tr><td class="memTemplParams" colspan="2">template<typename _T > </td></tr><tr><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="class_b_w_a_p_i_1_1_best_filter.html">BestFilter</a>< _PARAM > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_b_w_a_p_i_1_1_best_filter.html#a6018ad1f9ee8449c1e8798d6bbb25863">operator&&</a> (const _T &other) const </td></tr><tr><td class="memItemLeft">_PARAM </td><td class="memItemRight"><a class="el" href="class_b_w_a_p_i_1_1_best_filter.html#a0b33c9cb1a14c056d840003a0aa3e6d1">operator()</a> (const _PARAM &p1, const _PARAM &p2) const </td></tr><tr><td class="memTemplParams" colspan="2">template<typename _T > </td></tr><tr><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="class_b_w_a_p_i_1_1_best_filter.html">BestFilter</a>< _PARAM > & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_b_w_a_p_i_1_1_best_filter.html#ae3227a5647919f80fc5199828991fbf6">operator=</a> (const _T &other)</td></tr></tbody></table><a id="details"></a><h2 class="groupheader">Detailed Description</h2><div class="textblock"><h3>template<typename _PARAM><br> class BWAPI::BestFilter< _PARAM ></h3><p>The <a class="el" href="class_b_w_a_p_i_1_1_best_filter.html" title="The BestFilter is used to compare two objects with each other. ">BestFilter</a> is used to compare two objects with each other. </p><p>Each function object compares two of the same object and returns the most desirable one.</p><dl class="section note"><dt>Note</dt><dd>: A function object should return one of the two given parameters, never nullptr. Both parameters being given should never be nullptr. </dd></dl></div><h2 class="groupheader">Constructor & Destructor Documentation</h2><a class="anchor" id="ae34bdf1c00a51f106627c3d126555393"></a><div class="memitem"><div class="memproto"><a class="el" href="class_b_w_a_p_i_1_1_best_filter.html">BWAPI::BestFilter</a>< _PARAM >::<a class="el" href="class_b_w_a_p_i_1_1_best_filter.html">BestFilter</a> (const _T & <span class="paramname"><em>predicate</em></span>)</div><div class="memdoc"></div></div><h2 class="groupheader">Member Function Documentation</h2><a class="anchor" id="ae3227a5647919f80fc5199828991fbf6"></a><div class="memitem"><div class="memproto"><a class="el" href="class_b_w_a_p_i_1_1_best_filter.html">BestFilter</a><_PARAM>& <a class="el" href="class_b_w_a_p_i_1_1_best_filter.html">BWAPI::BestFilter</a>< _PARAM >::operator= (const _T & <span class="paramname"><em>other</em></span>)</div><div class="memdoc"></div></div><a class="anchor" id="a6018ad1f9ee8449c1e8798d6bbb25863"></a><div class="memitem"><div class="memproto"><a class="el" href="class_b_w_a_p_i_1_1_best_filter.html">BestFilter</a><_PARAM> <a class="el" href="class_b_w_a_p_i_1_1_best_filter.html">BWAPI::BestFilter</a>< _PARAM >::operator&& (const _T & <span class="paramname"><em>other</em></span>) const</div><div class="memdoc"></div></div><a class="anchor" id="a0b33c9cb1a14c056d840003a0aa3e6d1"></a><div class="memitem"><div class="memproto">_PARAM <a class="el" href="class_b_w_a_p_i_1_1_best_filter.html">BWAPI::BestFilter</a>< _PARAM >::operator() (const _PARAM & <span class="paramname"><em>p1</em>, </span>const _PARAM & <span class="paramname"><em>p2</em> </span>) const</div><div class="memdoc"></div></div></div><hr class="footer"><address class="footer"><div style="float:left;" id="google_translate_element"></div><script>if(window.location.protocol!="file:"){function googleTranslateElementInit(){new google.translate.TranslateElement({pageLanguage:"en",layout:google.translate.TranslateElement.InlineLayout.HORIZONTAL},"google_translate_element")}var js=document.createElement("script");js.type="text/javascript";js.src="//translate.google.com/translate_a/element.js?cb=googleTranslateElementInit";document.body.appendChild(js)};</script><small> Generated on Wed Apr 19 2017 09:26:58 for BWAPI by <a href="//www.doxygen.org/index.html"><img style="width:104px;height:31px;" class="footer" src="doxygen.png" alt="doxygen"></a> 1.8.11 </small></address><script src="jquery.js"></script><script src="dynsections.js"></script><script>$(document).ready(function(){searchBox.OnSelectItem(0);$(".memberdecls, .memname, .memproto, .paramname, .fieldname, .entry, .fragment").addClass("notranslate");$("#MSearchResultsWindow").addClass("notranslate");$(".qindex, .qindex + table").addClass("notranslate");$(".contents > ul").addClass("notranslate");$(".contents > h3").addClass("notranslate");$("#navrow4 > .tablist > li > a").addClass("notranslate");$("a.el, a.elRef").addClass("notranslate")});</script></body></html>