2013-08-30 02:14:14 +00:00
2013-08-23 14:30:09 +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
2013-08-23 14:30:09 +00:00
< html xmlns = "http://www.w3.org/1999/xhtml" >
< head >
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" / >
2013-08-30 02:14:14 +00:00
< title > max — 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
2013-08-23 14:30:09 +00:00
< script type = "text/javascript" >
var DOCUMENTATION_OPTIONS = {
2013-08-30 05:02:02 +00:00
URL_ROOT: '../../',
2013-08-23 14:30:09 +00:00
VERSION: '1.0',
2013-08-30 02:14:14 +00:00
COLLAPSE_INDEX: false,
2013-08-23 14:30:09 +00:00
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" / >
2013-08-23 14:30:09 +00:00
< link rel = "up" title = "Sprout.Algorithm" href = "index.html" / >
< link rel = "next" title = "minmax" href = "minmax.html" / >
< link rel = "prev" title = "min" href = "min.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"
2013-08-23 14:30:09 +00:00
accesskey="I">index< / a > < / li >
< li class = "right" >
< a href = "minmax.html" title = "minmax"
accesskey="N">next< / a > |< / li >
< li class = "right" >
< a href = "min.html" title = "min"
accesskey="P">previous< / a > |< / li >
2013-08-30 05:02:02 +00:00
< li > < a href = "../../index.html" > Sprout 1.0 documentation< / a > » < / li >
< li > < a href = "../index.html" > Libraries< / a > » < / li >
2013-08-23 14:30:09 +00:00
< li > < a href = "index.html" accesskey = "U" > Sprout.Algorithm< / a > » < / 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< / a > < ul >
< li > < a class = "reference internal" href = "#interface" > Interface< / a > < / li >
< li > < a class = "reference internal" href = "#requires" > Requires< / a > < / li >
< li > < a class = "reference internal" href = "#returns" > Returns< / a > < / li >
< li > < a class = "reference internal" href = "#remarks" > Remarks< / a > < / li >
< li > < a class = "reference internal" href = "#examples" > Examples< / a > < / li >
< li > < a class = "reference internal" href = "#id1" > Interface< / a > < / li >
< li > < a class = "reference internal" href = "#id2" > Requires< / a > < / li >
< li > < a class = "reference internal" href = "#id3" > Returns< / a > < / li >
< li > < a class = "reference internal" href = "#id4" > Remarks< / 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.html"
title="previous chapter">min< / a > < / p >
< h4 > Next topic< / h4 >
< p class = "topless" > < a href = "minmax.html"
title="next chapter">minmax< / 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.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 >
2013-08-23 14:30:09 +00:00
< div class = "document" >
< div class = "documentwrapper" >
< div class = "bodywrapper" >
< div class = "body" >
< div class = "section" id = "max" >
< h1 > max< a class = "headerlink" href = "#max" 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" > < < / span > < span class = "k" > typename< / span > < span class = "n" > T< / span > < span class = "o" > > < / span >
< span class = "kr" > inline< / span > < span class = "n" > SPROUT_CONSTEXPR< / span > < span class = "n" > T< / span > < span class = "k" > const< / span > < span class = "o" > & < / span >
< span class = "n" > max< / span > < span class = "p" > (< / span > < span class = "n" > T< / span > < span class = "k" > const< / span > < span class = "o" > & < / span > < span class = "n" > a< / span > < span class = "p" > ,< / span > < span class = "n" > T< / span > < span class = "k" > const< / span > < span class = "o" > & < / span > < span class = "n" > b< / span > < span class = "p" > );< / span >
< span class = "k" > template< / span > < span class = "o" > < < / span > < span class = "k" > typename< / span > < span class = "n" > T< / span > < span class = "p" > ,< / span > < span class = "k" > typename< / span > < span class = "n" > Compare< / span > < span class = "o" > > < / span >
< span class = "kr" > inline< / span > < span class = "n" > SPROUT_CONSTEXPR< / span > < span class = "n" > T< / span > < span class = "k" > const< / span > < span class = "o" > & < / span >
< span class = "n" > max< / span > < span class = "p" > (< / span > < span class = "n" > T< / span > < span class = "k" > const< / span > < span class = "o" > & < / span > < span class = "n" > a< / span > < span class = "p" > ,< / span > < span class = "n" > T< / span > < span class = "k" > const< / span > < span class = "o" > & < / span > < span class = "n" > b< / 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 = "requires" >
< h2 > Requires< a class = "headerlink" href = "#requires" title = "Permalink to this headline" > ¶< / a > < / h2 >
< div class = "line-block" >
< div class = "line" > Type T is LessThanComparable.< / 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 larger value.< / div >
< / div >
< / div >
< div class = "section" id = "remarks" >
< h2 > Remarks< a class = "headerlink" href = "#remarks" title = "Permalink to this headline" > ¶< / a > < / h2 >
< div class = "line-block" >
< div class = "line" > Returns the first argument when the arguments are equivalent.< / 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 < sprout/algorithm/max.hpp> < / span >
< span class = "cp" > #include < sprout/array.hpp> < / 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" > < < / span > < span class = "kt" > int< / span > < span class = "p" > ,< / span > < span class = "mi" > 10< / span > < span class = "o" > > < / span > < span class = "p" > {{< / span > < span class = "o" > -< / span > < span class = "mi" > 1< / span > < span class = "p" > ,< / span > < span class = "mi" > 1< / 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< / span > < span class = "p" > (< / span > < span class = "n" > input< / span > < span class = "p" > [< / span > < span class = "mi" > 0< / span > < span class = "p" > ],< / span > < span class = "n" > input< / span > < span class = "p" > [< / span > < span class = "mi" > 1< / 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 = "mi" > 1< / span > < span class = "p" > ,< / span > < span class = "s" > " max value is 1." < / span > < span class = "p" > );< / span >
< / pre > < / div >
< / div >
< / div >
< hr class = "docutils" / >
< div class = "section" id = "id1" >
< h2 > Interface< a class = "headerlink" href = "#id1" title = "Permalink to this headline" > ¶< / a > < / h2 >
< div class = "highlight-c++" > < div class = "highlight" > < pre > < span class = "k" > template< / span > < span class = "o" > < < / span > < span class = "k" > typename< / span > < span class = "n" > T< / span > < span class = "p" > ,< / span > < span class = "k" > typename< / span > < span class = "n" > Compare< / span > < span class = "o" > > < / span >
< span class = "kr" > inline< / span > < span class = "n" > SPROUT_CONSTEXPR< / span > < span class = "n" > T< / span >
< span class = "n" > max< / span > < span class = "p" > (< / span > < span class = "n" > std< / span > < span class = "o" > ::< / span > < span class = "n" > initializer_list< / span > < span class = "o" > < < / span > < span class = "n" > T< / span > < span class = "o" > > < / span > < span class = "n" > t< / span > < span class = "p" > ,< / span > < span class = "n" > Compare< / span > < span class = "n" > comp< / span > < span class = "p" > );< / span >
< span class = "k" > template< / span > < span class = "o" > < < / span > < span class = "k" > typename< / span > < span class = "n" > T< / span > < span class = "o" > > < / span >
< span class = "kr" > inline< / span > < span class = "n" > SPROUT_CONSTEXPR< / span > < span class = "n" > T< / span >
< span class = "n" > max< / span > < span class = "p" > (< / span > < span class = "n" > std< / span > < span class = "o" > ::< / span > < span class = "n" > initializer_list< / span > < span class = "o" > < < / span > < span class = "n" > T< / span > < span class = "o" > > < / span > < span class = "n" > t< / span > < span class = "p" > );< / span >
< / pre > < / div >
< / div >
< / div >
< div class = "section" id = "id2" >
< h2 > Requires< a class = "headerlink" href = "#id2" title = "Permalink to this headline" > ¶< / a > < / h2 >
< div class = "line-block" >
< div class = "line" > T is LessThanComparable and CopyConstructible and < tt class = "docutils literal" > < span class = "pre" > t.size()< / span > < span class = "pre" > > < / span > < span class = "pre" > 0< / span > < / tt > .< / div >
< / div >
< / div >
< div class = "section" id = "id3" >
< h2 > Returns< a class = "headerlink" href = "#id3" title = "Permalink to this headline" > ¶< / a > < / h2 >
< div class = "line-block" >
< div class = "line" > The largest value in the initializer_list.< / div >
< / div >
< / div >
< div class = "section" id = "id4" >
< h2 > Remarks< a class = "headerlink" href = "#id4" title = "Permalink to this headline" > ¶< / a > < / h2 >
< div class = "line-block" >
< div class = "line" > Returns a copy of the leftmost argument when several arguments are equivalent to the largest.< / div >
2013-08-24 04:14:37 +00:00
< div class = "line" > If an implementation not support C++14 initializer_list (< tt class = "docutils literal" > < span class = "pre" > SPROUT_NO_CXX14_INITIALIZER_LIST< / span > < / tt > defined), then this function is not specified constexpr.< / div >
2013-08-23 14:30:09 +00:00
< / 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" > 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.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"
2013-08-23 14:30:09 +00:00
>index< / a > < / li >
< li class = "right" >
< a href = "minmax.html" title = "minmax"
>next< / a > |< / li >
< li class = "right" >
< a href = "min.html" title = "min"
>previous< / a > |< / li >
2013-08-30 05:02:02 +00:00
< li > < a href = "../../index.html" > Sprout 1.0 documentation< / a > » < / li >
< li > < a href = "../index.html" > Libraries< / a > » < / li >
2013-08-23 14:30:09 +00:00
< li > < a href = "index.html" > Sprout.Algorithm< / a > » < / li >
< / ul >
< / div >
< div class = "footer" >
2013-08-30 02:14:14 +00:00
© Copyright 2013, Bolero MURAKAMI.
Created using < a href = "http://sphinx.pocoo.org/" > Sphinx< / a > 1.1.3.
2013-08-23 14:30:09 +00:00
< / div >
< / body >
< / html >
