1
0
Fork 0
mirror of https://github.com/bolero-MURAKAMI/Sprout synced 2024-11-12 21:09:01 +00:00
Sprout/docs/libs/algorithm/max_element.html

187 lines
11 KiB
HTML
Raw Normal View History

2013-08-30 02:14:14 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2013-08-30 02:14:14 +00:00
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
2013-09-04 07:06:44 +00:00
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-43764535-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
2013-08-30 02:14:14 +00:00
<title>max_element &mdash; Sprout 1.0 documentation</title>
2013-08-30 05:02:02 +00:00
<link rel="stylesheet" href="../../_static/sphinxdoc.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
2013-08-30 02:14:14 +00:00
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
2013-08-30 05:02:02 +00:00
URL_ROOT: '../../',
VERSION: '1.0',
2013-08-30 02:14:14 +00:00
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
2013-08-30 05:02:02 +00:00
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<link rel="top" title="Sprout 1.0 documentation" href="../../index.html" />
<link rel="up" title="Sprout.Algorithm" href="index.html" />
<link rel="next" title="minmax_element" href="minmax_element.html" />
<link rel="prev" title="min_element" href="min_element.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
2013-08-30 05:02:02 +00:00
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="minmax_element.html" title="minmax_element"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="min_element.html" title="min_element"
accesskey="P">previous</a> |</li>
2013-08-30 05:02:02 +00:00
<li><a href="../../index.html">Sprout 1.0 documentation</a> &raquo;</li>
<li><a href="../index.html" >Libraries</a> &raquo;</li>
<li><a href="index.html" accesskey="U">Sprout.Algorithm</a> &raquo;</li>
</ul>
2013-08-25 15:09:33 +00:00
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
2013-08-30 05:02:02 +00:00
<h3><a href="../../index.html">Table Of Contents</a></h3>
2013-08-30 02:14:14 +00:00
<ul>
<li><a class="reference internal" href="#">max_element</a><ul>
<li><a class="reference internal" href="#interface">Interface</a></li>
<li><a class="reference internal" href="#returns">Returns</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#complexity">Complexity</a></li>
<li><a class="reference internal" href="#header">Header</a></li>
2013-08-25 15:09:33 +00:00
</ul>
</li>
</ul>
2013-08-30 02:14:14 +00:00
<h4>Previous topic</h4>
<p class="topless"><a href="min_element.html"
title="previous chapter">min_element</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="minmax_element.html"
title="next chapter">minmax_element</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
2013-08-30 05:02:02 +00:00
<li><a href="../../_sources/libs/algorithm/max_element.txt"
2013-08-30 02:14:14 +00:00
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
2013-08-30 05:02:02 +00:00
<form class="search" action="../../search.html" method="get">
2013-08-30 02:14:14 +00:00
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
2013-08-25 15:09:33 +00:00
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="max-element">
<h1>max_element<a class="headerlink" href="#max-element" title="Permalink to this headline"></a></h1>
<div class="section" id="interface">
<h2>Interface<a class="headerlink" href="#interface" title="Permalink to this headline"></a></h2>
<div class="highlight-c++"><div class="highlight"><pre><span class="k">template</span><span class="o">&lt;</span><span class="k">typename</span> <span class="n">ForwardIterator</span><span class="o">&gt;</span>
<span class="kr">inline</span> <span class="n">SPROUT_CONSTEXPR</span> <span class="n">ForwardIterator</span>
<span class="n">max_element</span><span class="p">(</span><span class="n">ForwardIterator</span> <span class="n">first</span><span class="p">,</span> <span class="n">ForwardIterator</span> <span class="n">last</span><span class="p">);</span>
<span class="k">template</span><span class="o">&lt;</span><span class="k">typename</span> <span class="n">ForwardIterator</span><span class="p">,</span> <span class="k">typename</span> <span class="n">Compare</span><span class="o">&gt;</span>
<span class="kr">inline</span> <span class="n">SPROUT_CONSTEXPR</span> <span class="n">ForwardIterator</span>
<span class="n">max_element</span><span class="p">(</span><span class="n">ForwardIterator</span> <span class="n">first</span><span class="p">,</span> <span class="n">ForwardIterator</span> <span class="n">last</span><span class="p">,</span> <span class="n">Compare</span> <span class="n">comp</span><span class="p">);</span>
</pre></div>
</div>
</div>
<div class="section" id="returns">
<h2>Returns<a class="headerlink" href="#returns" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line">The first iterator i in the range [first,last) such that for any iterator j in the range [first,last) the following corresponding conditions hold: <tt class="docutils literal"><span class="pre">!(*i</span> <span class="pre">&lt;</span> <span class="pre">*j)</span></tt> or <tt class="docutils literal"><span class="pre">!comp(*i,</span> <span class="pre">*j)</span></tt>.</div>
<div class="line">Returns last if <tt class="docutils literal"><span class="pre">first</span> <span class="pre">==</span> <span class="pre">last</span></tt>.</div>
</div>
</div>
<div class="section" id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-c++"><div class="highlight"><pre><span class="cp">#include &lt;sprout/algorithm/max_element.hpp&gt;</span>
<span class="cp">#include &lt;sprout/array.hpp&gt;</span>
<span class="cp">#include &lt;sprout/container.hpp&gt;</span>
<span class="k">using</span> <span class="k">namespace</span> <span class="n">sprout</span><span class="p">;</span>
<span class="n">SPROUT_STATIC_CONSTEXPR</span> <span class="k">auto</span> <span class="n">input</span> <span class="o">=</span> <span class="n">array</span><span class="o">&lt;</span><span class="kt">int</span><span class="p">,</span> <span class="mi">10</span><span class="o">&gt;</span><span class="p">{{</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">6</span><span class="p">,</span> <span class="mi">7</span><span class="p">,</span> <span class="mi">8</span><span class="p">,</span> <span class="mi">9</span><span class="p">,</span> <span class="mi">10</span><span class="p">}};</span>
<span class="n">SPROUT_STATIC_CONSTEXPR</span> <span class="k">auto</span> <span class="n">result</span> <span class="o">=</span> <span class="n">sprout</span><span class="o">::</span><span class="n">max_element</span><span class="p">(</span><span class="n">begin</span><span class="p">(</span><span class="n">input</span><span class="p">),</span> <span class="n">end</span><span class="p">(</span><span class="n">input</span><span class="p">));</span>
<span class="n">static_assert</span><span class="p">(</span><span class="o">*</span><span class="n">result</span> <span class="o">==</span> <span class="mi">10</span><span class="p">,</span> <span class="s">&quot;a min element is 10.&quot;</span><span class="p">);</span>
<span class="n">static_assert</span><span class="p">(</span><span class="n">result</span> <span class="o">-</span> <span class="n">begin</span><span class="p">(</span><span class="n">input</span><span class="p">)</span> <span class="o">==</span> <span class="mi">9</span><span class="p">,</span> <span class="s">&quot;a min element position is 9.&quot;</span><span class="p">);</span>
</pre></div>
</div>
</div>
<div class="section" id="complexity">
<h2>Complexity<a class="headerlink" href="#complexity" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line">Exactly <tt class="docutils literal"><span class="pre">max((last</span> <span class="pre">-</span> <span class="pre">first)</span> <span class="pre">-</span> <span class="pre">1,</span> <span class="pre">0)</span></tt> applications of the corresponding comparisons.</div>
<div class="line">Recursive function invocations in <em>O(logN)</em> (logarithmic) depth.</div>
</div>
</div>
<div class="section" id="header">
<h2>Header<a class="headerlink" href="#header" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line"><tt class="docutils literal"><span class="pre">sprout/algorithm/max_element.hpp</span></tt></div>
<div class="line">Convenience header: <tt class="docutils literal"><span class="pre">sprout/algorithm.hpp</span></tt></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
2013-08-30 05:02:02 +00:00
<a href="../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="minmax_element.html" title="minmax_element"
>next</a> |</li>
<li class="right" >
<a href="min_element.html" title="min_element"
>previous</a> |</li>
2013-08-30 05:02:02 +00:00
<li><a href="../../index.html">Sprout 1.0 documentation</a> &raquo;</li>
<li><a href="../index.html" >Libraries</a> &raquo;</li>
<li><a href="index.html" >Sprout.Algorithm</a> &raquo;</li>
</ul>
</div>
<div class="footer">
2013-08-30 02:14:14 +00:00
&copy; Copyright 2013, Bolero MURAKAMI.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>