mirror/Sprout
1
0
Fork 0
mirror of https://github.com/bolero-MURAKAMI/Sprout.git synced 2025-02-19 10:34:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

add doc: min, max, minmax

Browse source
This commit is contained in:
Bolero-MURAKAMI 2013-08-23 23:30:09 +09:00
parent 22cff01bf8
commit e036b54fcb
15 changed files with 1211 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
docs/_sources/libs/sprout/algorithm/index.txt
View file

@ -39,6 +39,9 @@ Sprout.Algorithm
binary_search
is_heap
is_heap_until
min
max
minmax
.. _sprout-algorithm-non_modifying:
*******************************************************************************

85
docs/_sources/libs/sprout/algorithm/max.txt Normal file
View file

@ -0,0 +1,85 @@
.. _sprout-algorithm-max:
###############################################################################
max
###############################################################################
Interface
========================================
.. sourcecode:: c++
template<typename T>
inline SPROUT_CONSTEXPR T const&
max(T const& a, T const& b);
template<typename T, typename Compare>
inline SPROUT_CONSTEXPR T const&
max(T const& a, T const& b, Compare comp);
Requires
========================================
| Type T is LessThanComparable.
Returns
========================================
| The larger value.
Remarks
========================================
| Returns the first argument when the arguments are equivalent.
Examples
========================================
.. sourcecode:: c++
#include <sprout/algorithm/max.hpp>
#include <sprout/array.hpp>
using namespace sprout;
SPROUT_STATIC_CONSTEXPR auto input = array<int, 10>{{-1, 1}};
SPROUT_STATIC_CONSTEXPR auto result = sprout::max(input[0], input[1]);
static_assert(result == 1, "max value is 1.");
-------------------------------------------------------------------------------
Interface
========================================
.. sourcecode:: c++
template<typename T, typename Compare>
inline SPROUT_CONSTEXPR T
max(std::initializer_list<T> t, Compare comp);
template<typename T>
inline SPROUT_CONSTEXPR T
max(std::initializer_list<T> t);
Requires
========================================
| T is LessThanComparable and CopyConstructible and ``t.size() > 0``.
Returns
========================================
| The largest value in the initializer_list.
Remarks
========================================
| Returns a copy of the leftmost argument when several arguments are equivalent to the largest.
| If an implementation not support C++14 initializer_list (SPROUT_NO_CXX14_INITIALIZER_LIST defined), then this function is not specified constexpr.
Complexity
========================================
| Recursive function invocations in *O(logN)* (logarithmic) depth.
Header
========================================
| ``sprout/algorithm/max.hpp``
| Convenience header: ``sprout/algorithm.hpp``

85
docs/_sources/libs/sprout/algorithm/min.txt Normal file
View file

@ -0,0 +1,85 @@
.. _sprout-algorithm-min:
###############################################################################
min
###############################################################################
Interface
========================================
.. sourcecode:: c++
template<typename T>
inline SPROUT_CONSTEXPR T const&
min(T const& a, T const& b);
template<typename T, typename Compare>
inline SPROUT_CONSTEXPR T const&
min(T const& a, T const& b, Compare comp);
Requires
========================================
| Type T is LessThanComparable.
Returns
========================================
| The smaller value.
Remarks
========================================
| Returns the first argument when the arguments are equivalent.
Examples
========================================
.. sourcecode:: c++
#include <sprout/algorithm/min.hpp>
#include <sprout/array.hpp>
using namespace sprout;
SPROUT_STATIC_CONSTEXPR auto input = array<int, 10>{{-1, 1}};
SPROUT_STATIC_CONSTEXPR auto result = sprout::min(input[0], input[1]);
static_assert(result == -1, "min value is -1.");
-------------------------------------------------------------------------------
Interface
========================================
.. sourcecode:: c++
template<typename T, typename Compare>
inline SPROUT_CONSTEXPR T
min(std::initializer_list<T> t, Compare comp);
template<typename T>
inline SPROUT_CONSTEXPR T
min(std::initializer_list<T> t);
Requires
========================================
| T is LessThanComparable and CopyConstructible and ``t.size() > 0``.
Returns
========================================
| The smallest value in the initializer_list.
Remarks
========================================
| Returns a copy of the leftmost argument when several arguments are equivalent to the smallest.
| If an implementation not support C++14 initializer_list (SPROUT_NO_CXX14_INITIALIZER_LIST defined), then this function is not specified constexpr.
Complexity
========================================
| Recursive function invocations in *O(logN)* (logarithmic) depth.
Header
========================================
| ``sprout/algorithm/min.hpp``
| Convenience header: ``sprout/algorithm.hpp``

96
docs/_sources/libs/sprout/algorithm/minmax.txt Normal file
View file

@ -0,0 +1,96 @@
.. _sprout-algorithm-minmax:
###############################################################################
minmax
###############################################################################
Interface
========================================
.. sourcecode:: c++
template<typename T>
inline SPROUT_CONSTEXPR sprout::pair<T const&, T const&>
minmax(T const& a, T const& b);
template<typename T, typename Compare>
inline SPROUT_CONSTEXPR sprout::pair<T const&, T const&>
minmax(T const& a, T const& b, Compare comp);
Requires
========================================
| Type T shall be LessThanComparable.
Returns
========================================
| ``pair<T, T>(x, y)``, where x has the smallest and y has the largest value in the initializer list.
Remarks
========================================
| Returns ``pair<const T&, const T&>(a, b)`` when the arguments are equivalent.
Remarks
========================================
Examples
========================================
.. sourcecode:: c++
#include <sprout/algorithm/minmax.hpp>
#include <sprout/array.hpp>
using namespace sprout;
SPROUT_STATIC_CONSTEXPR auto input = array<int, 10>{{-1, 1}};
SPROUT_STATIC_CONSTEXPR auto result = sprout::minmax(input[0], input[1]);
static_assert(result.first == -1, "min value is -1.");
static_assert(result.second == 1, "max value is 1.");
Complexity
========================================
| Exactly one comparison.
-------------------------------------------------------------------------------
Interface
========================================
.. sourcecode:: c++
template<typename T, typename Compare>
inline SPROUT_CONSTEXPR sprout::pair<T, T>
minmax(std::initializer_list<T> t, Compare comp);
template<typename T>
inline SPROUT_CONSTEXPR sprout::pair<T, T>
minmax(std::initializer_list<T> t);
Requires
========================================
| T is LessThanComparable and CopyConstructible and ``t.size() > 0``.
Returns
========================================
| ``pair<T, T>(x, y)``, where x has the smallest and y has the largest value in the initializer list.
Remarks
========================================
| x is a copy of the leftmost argument when several arguments are equivalent to the smallest.
| y is a copy of the rightmost argument when several arguments are equivalent to the largest.
| If an implementation not support C++14 initializer_list (SPROUT_NO_CXX14_INITIALIZER_LIST defined), then this function is not specified constexpr.
Complexity
========================================
| At most ``(3/2) * t.size()`` applications of the corresponding predicate.
| Recursive function invocations in *O(logN)* (logarithmic) depth.
Header
========================================
| ``sprout/algorithm/minmax.hpp``
| Convenience header: ``sprout/algorithm.hpp``

6
docs/libs/sprout/algorithm/index.html
View file

@ -105,9 +105,9 @@
<div class="section" id="minimum-and-maximum">
<h3>Minimum and maximum<a class="headerlink" href="#minimum-and-maximum" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><tt class="xref docutils literal"><span class="pre">min</span></tt></li>
<li><tt class="xref docutils literal"><span class="pre">max</span></tt></li>
<li><tt class="xref docutils literal"><span class="pre">minmax</span></tt></li>
<li><a class="reference external" href="min.html"><em>min</em></a></li>
<li><a class="reference external" href="max.html"><em>max</em></a></li>
<li><a class="reference external" href="minmax.html"><em>minmax</em></a></li>
<li><tt class="xref docutils literal"><span class="pre">min_element</span></tt></li>
<li><tt class="xref docutils literal"><span class="pre">max_element</span></tt></li>
<li><tt class="xref docutils literal"><span class="pre">minmax_element</span></tt></li>

10
docs/libs/sprout/algorithm/is_heap_until.html
View file

@ -21,6 +21,7 @@
<script type="text/javascript" src="../../../_static/doctools.js"></script>
<link rel="top" title="Sprout v1.0 documentation" href="../../../index.html" />
<link rel="up" title="Sprout.Algorithm" href="index.html" />
<link rel="next" title="min" href="min.html" />
<link rel="prev" title="is_heap" href="is_heap.html" />
</head>
<body>
@ -30,6 +31,9 @@
<li class="right" style="margin-right: 10px">
<a href="../../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="min.html" title="min"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="is_heap.html" title="is_heap"
accesskey="P">previous</a> |</li>
@ -116,6 +120,9 @@
<h4>Previous topic</h4>
<p class="topless"><a href="is_heap.html"
title="previous chapter">is_heap</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="min.html"
title="next chapter">min</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../../_sources/libs/sprout/algorithm/is_heap_until.txt"
@ -144,6 +151,9 @@
<li class="right" style="margin-right: 10px">
<a href="../../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="min.html" title="min"
>next</a> |</li>
<li class="right" >
<a href="is_heap.html" title="is_heap"
>previous</a> |</li>

218
docs/libs/sprout/algorithm/max.html Normal file
View file

@ -0,0 +1,218 @@
<!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/html; charset=utf-8" />
<title>max &mdash; Sprout v1.0 documentation</title>
<link rel="stylesheet" href="../../../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../../',
VERSION: '1.0',
COLLAPSE_MODINDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../_static/doctools.js"></script>
<link rel="top" title="Sprout v1.0 documentation" href="../../../index.html" />
<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">
<a href="../../../genindex.html" title="General Index"
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>
<li><a href="../../../index.html">Sprout v1.0 documentation</a> &raquo;</li>
<li><a href="../../index.html" >Sprout C++ Libraries</a> &raquo;</li>
<li><a href="../../libraries.html" >Libraries</a> &raquo;</li>
<li><a href="index.html" accesskey="U">Sprout.Algorithm</a> &raquo;</li>
</ul>
</div>
<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">&lt;</span><span class="k">typename</span> <span class="n">T</span><span class="o">&gt;</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">&amp;</span>
<span class="n">max</span><span class="p">(</span><span class="n">T</span> <span class="k">const</span><span class="o">&amp;</span> <span class="n">a</span><span class="p">,</span> <span class="n">T</span> <span class="k">const</span><span class="o">&amp;</span> <span class="n">b</span><span class="p">);</span>
<span class="k">template</span><span class="o">&lt;</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">&gt;</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">&amp;</span>
<span class="n">max</span><span class="p">(</span><span class="n">T</span> <span class="k">const</span><span class="o">&amp;</span> <span class="n">a</span><span class="p">,</span> <span class="n">T</span> <span class="k">const</span><span class="o">&amp;</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 &lt;sprout/algorithm/max.hpp&gt;</span>
<span class="cp">#include &lt;sprout/array.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="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">&quot;max value is 1.&quot;</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">&lt;</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">&gt;</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">&lt;</span><span class="n">T</span><span class="o">&gt;</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">&lt;</span><span class="k">typename</span> <span class="n">T</span><span class="o">&gt;</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">&lt;</span><span class="n">T</span><span class="o">&gt;</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">&gt;</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>
<div class="line">If an implementation not support C++14 initializer_list (SPROUT_NO_CXX14_INITIALIZER_LIST defined), then this function is not specified constexpr.</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">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="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../../../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference external" href="#">max</a><ul>
<li><a class="reference external" href="#interface">Interface</a></li>
<li><a class="reference external" href="#requires">Requires</a></li>
<li><a class="reference external" href="#returns">Returns</a></li>
<li><a class="reference external" href="#remarks">Remarks</a></li>
<li><a class="reference external" href="#examples">Examples</a></li>
<li><a class="reference external" href="#id1">Interface</a></li>
<li><a class="reference external" href="#id2">Requires</a></li>
<li><a class="reference external" href="#id3">Returns</a></li>
<li><a class="reference external" href="#id4">Remarks</a></li>
<li><a class="reference external" href="#complexity">Complexity</a></li>
<li><a class="reference external" href="#header">Header</a></li>
</ul>
</li>
</ul>
<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">
<li><a href="../../../_sources/libs/sprout/algorithm/max.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../../../search.html" method="get">
<input type="text" name="q" size="18" />
<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>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../../genindex.html" title="General Index"
>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>
<li><a href="../../../index.html">Sprout v1.0 documentation</a> &raquo;</li>
<li><a href="../../index.html" >Sprout C++ Libraries</a> &raquo;</li>
<li><a href="../../libraries.html" >Libraries</a> &raquo;</li>
<li><a href="index.html" >Sprout.Algorithm</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2013, Bolero MURAKAMI.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.4.
</div>
</body>
</html>

218
docs/libs/sprout/algorithm/min.html Normal file
View file

@ -0,0 +1,218 @@
<!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/html; charset=utf-8" />
<title>min &mdash; Sprout v1.0 documentation</title>
<link rel="stylesheet" href="../../../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../../',
VERSION: '1.0',
COLLAPSE_MODINDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../_static/doctools.js"></script>
<link rel="top" title="Sprout v1.0 documentation" href="../../../index.html" />
<link rel="up" title="Sprout.Algorithm" href="index.html" />
<link rel="next" title="max" href="max.html" />
<link rel="prev" title="is_heap_until" href="is_heap_until.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="max.html" title="max"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="is_heap_until.html" title="is_heap_until"
accesskey="P">previous</a> |</li>
<li><a href="../../../index.html">Sprout v1.0 documentation</a> &raquo;</li>
<li><a href="../../index.html" >Sprout C++ Libraries</a> &raquo;</li>
<li><a href="../../libraries.html" >Libraries</a> &raquo;</li>
<li><a href="index.html" accesskey="U">Sprout.Algorithm</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="min">
<h1>min<a class="headerlink" href="#min" 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">T</span><span class="o">&gt;</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">&amp;</span>
<span class="n">min</span><span class="p">(</span><span class="n">T</span> <span class="k">const</span><span class="o">&amp;</span> <span class="n">a</span><span class="p">,</span> <span class="n">T</span> <span class="k">const</span><span class="o">&amp;</span> <span class="n">b</span><span class="p">);</span>
<span class="k">template</span><span class="o">&lt;</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">&gt;</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">&amp;</span>
<span class="n">min</span><span class="p">(</span><span class="n">T</span> <span class="k">const</span><span class="o">&amp;</span> <span class="n">a</span><span class="p">,</span> <span class="n">T</span> <span class="k">const</span><span class="o">&amp;</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 smaller 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 &lt;sprout/algorithm/min.hpp&gt;</span>
<span class="cp">#include &lt;sprout/array.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="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">min</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="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="s">&quot;min value is -1.&quot;</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">&lt;</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">&gt;</span>
<span class="kr">inline</span> <span class="n">SPROUT_CONSTEXPR</span> <span class="n">T</span>
<span class="n">min</span><span class="p">(</span><span class="n">std</span><span class="o">::</span><span class="n">initializer_list</span><span class="o">&lt;</span><span class="n">T</span><span class="o">&gt;</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">&lt;</span><span class="k">typename</span> <span class="n">T</span><span class="o">&gt;</span>
<span class="kr">inline</span> <span class="n">SPROUT_CONSTEXPR</span> <span class="n">T</span>
<span class="n">min</span><span class="p">(</span><span class="n">std</span><span class="o">::</span><span class="n">initializer_list</span><span class="o">&lt;</span><span class="n">T</span><span class="o">&gt;</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">&gt;</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 smallest 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 smallest.</div>
<div class="line">If an implementation not support C++14 initializer_list (SPROUT_NO_CXX14_INITIALIZER_LIST defined), then this function is not specified constexpr.</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">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/min.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="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../../../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference external" href="#">min</a><ul>
<li><a class="reference external" href="#interface">Interface</a></li>
<li><a class="reference external" href="#requires">Requires</a></li>
<li><a class="reference external" href="#returns">Returns</a></li>
<li><a class="reference external" href="#remarks">Remarks</a></li>
<li><a class="reference external" href="#examples">Examples</a></li>
<li><a class="reference external" href="#id1">Interface</a></li>
<li><a class="reference external" href="#id2">Requires</a></li>
<li><a class="reference external" href="#id3">Returns</a></li>
<li><a class="reference external" href="#id4">Remarks</a></li>
<li><a class="reference external" href="#complexity">Complexity</a></li>
<li><a class="reference external" href="#header">Header</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="is_heap_until.html"
title="previous chapter">is_heap_until</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="max.html"
title="next chapter">max</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../../_sources/libs/sprout/algorithm/min.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../../../search.html" method="get">
<input type="text" name="q" size="18" />
<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>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="max.html" title="max"
>next</a> |</li>
<li class="right" >
<a href="is_heap_until.html" title="is_heap_until"
>previous</a> |</li>
<li><a href="../../../index.html">Sprout v1.0 documentation</a> &raquo;</li>
<li><a href="../../index.html" >Sprout C++ Libraries</a> &raquo;</li>
<li><a href="../../libraries.html" >Libraries</a> &raquo;</li>
<li><a href="index.html" >Sprout.Algorithm</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2013, Bolero MURAKAMI.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.4.
</div>
</body>
</html>

222
docs/libs/sprout/algorithm/minmax.html Normal file
View file

@ -0,0 +1,222 @@
<!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/html; charset=utf-8" />
<title>minmax &mdash; Sprout v1.0 documentation</title>
<link rel="stylesheet" href="../../../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../../',
VERSION: '1.0',
COLLAPSE_MODINDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../_static/doctools.js"></script>
<link rel="top" title="Sprout v1.0 documentation" href="../../../index.html" />
<link rel="up" title="Sprout.Algorithm" href="index.html" />
<link rel="prev" title="max" href="max.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="max.html" title="max"
accesskey="P">previous</a> |</li>
<li><a href="../../../index.html">Sprout v1.0 documentation</a> &raquo;</li>
<li><a href="../../index.html" >Sprout C++ Libraries</a> &raquo;</li>
<li><a href="../../libraries.html" >Libraries</a> &raquo;</li>
<li><a href="index.html" accesskey="U">Sprout.Algorithm</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="minmax">
<h1>minmax<a class="headerlink" href="#minmax" 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">T</span><span class="o">&gt;</span>
<span class="kr">inline</span> <span class="n">SPROUT_CONSTEXPR</span> <span class="n">sprout</span><span class="o">::</span><span class="n">pair</span><span class="o">&lt;</span><span class="n">T</span> <span class="k">const</span><span class="o">&amp;</span><span class="p">,</span> <span class="n">T</span> <span class="k">const</span><span class="o">&amp;&gt;</span>
<span class="n">minmax</span><span class="p">(</span><span class="n">T</span> <span class="k">const</span><span class="o">&amp;</span> <span class="n">a</span><span class="p">,</span> <span class="n">T</span> <span class="k">const</span><span class="o">&amp;</span> <span class="n">b</span><span class="p">);</span>
<span class="k">template</span><span class="o">&lt;</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">&gt;</span>
<span class="kr">inline</span> <span class="n">SPROUT_CONSTEXPR</span> <span class="n">sprout</span><span class="o">::</span><span class="n">pair</span><span class="o">&lt;</span><span class="n">T</span> <span class="k">const</span><span class="o">&amp;</span><span class="p">,</span> <span class="n">T</span> <span class="k">const</span><span class="o">&amp;&gt;</span>
<span class="n">minmax</span><span class="p">(</span><span class="n">T</span> <span class="k">const</span><span class="o">&amp;</span> <span class="n">a</span><span class="p">,</span> <span class="n">T</span> <span class="k">const</span><span class="o">&amp;</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 shall be 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"><tt class="docutils literal"><span class="pre">pair&lt;T,</span> <span class="pre">T&gt;(x,</span> <span class="pre">y)</span></tt>, where x has the smallest and y has the largest value in the initializer list.</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 <tt class="docutils literal"><span class="pre">pair&lt;const</span> <span class="pre">T&amp;,</span> <span class="pre">const</span> <span class="pre">T&amp;&gt;(a,</span> <span class="pre">b)</span></tt> when the arguments are equivalent.</div>
</div>
</div>
<div class="section" id="id1">
<h2>Remarks<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h2>
</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/minmax.hpp&gt;</span>
<span class="cp">#include &lt;sprout/array.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="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">minmax</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="p">.</span><span class="n">first</span> <span class="o">==</span> <span class="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="s">&quot;min value is -1.&quot;</span><span class="p">);</span>
<span class="n">static_assert</span><span class="p">(</span><span class="n">result</span><span class="p">.</span><span class="n">second</span> <span class="o">==</span> <span class="mi">1</span><span class="p">,</span> <span class="s">&quot;max value is 1.&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 one comparison.</div>
</div>
</div>
<hr class="docutils" />
<div class="section" id="id2">
<h2>Interface<a class="headerlink" href="#id2" 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">T</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">sprout</span><span class="o">::</span><span class="n">pair</span><span class="o">&lt;</span><span class="n">T</span><span class="p">,</span> <span class="n">T</span><span class="o">&gt;</span>
<span class="n">minmax</span><span class="p">(</span><span class="n">std</span><span class="o">::</span><span class="n">initializer_list</span><span class="o">&lt;</span><span class="n">T</span><span class="o">&gt;</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">&lt;</span><span class="k">typename</span> <span class="n">T</span><span class="o">&gt;</span>
<span class="kr">inline</span> <span class="n">SPROUT_CONSTEXPR</span> <span class="n">sprout</span><span class="o">::</span><span class="n">pair</span><span class="o">&lt;</span><span class="n">T</span><span class="p">,</span> <span class="n">T</span><span class="o">&gt;</span>
<span class="n">minmax</span><span class="p">(</span><span class="n">std</span><span class="o">::</span><span class="n">initializer_list</span><span class="o">&lt;</span><span class="n">T</span><span class="o">&gt;</span> <span class="n">t</span><span class="p">);</span>
</pre></div>
</div>
</div>
<div class="section" id="id3">
<h2>Requires<a class="headerlink" href="#id3" 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">&gt;</span> <span class="pre">0</span></tt>.</div>
</div>
</div>
<div class="section" id="id4">
<h2>Returns<a class="headerlink" href="#id4" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line"><tt class="docutils literal"><span class="pre">pair&lt;T,</span> <span class="pre">T&gt;(x,</span> <span class="pre">y)</span></tt>, where x has the smallest and y has the largest value in the initializer list.</div>
</div>
</div>
<div class="section" id="id5">
<h2>Remarks<a class="headerlink" href="#id5" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line">x is a copy of the leftmost argument when several arguments are equivalent to the smallest.</div>
<div class="line">y is a copy of the rightmost argument when several arguments are equivalent to the largest.</div>
<div class="line">If an implementation not support C++14 initializer_list (SPROUT_NO_CXX14_INITIALIZER_LIST defined), then this function is not specified constexpr.</div>
</div>
</div>
<div class="section" id="id6">
<h2>Complexity<a class="headerlink" href="#id6" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line">At most <tt class="docutils literal"><span class="pre">(3/2)</span> <span class="pre">*</span> <span class="pre">t.size()</span></tt> applications of the corresponding predicate.</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/minmax.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="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../../../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference external" href="#">minmax</a><ul>
<li><a class="reference external" href="#interface">Interface</a></li>
<li><a class="reference external" href="#requires">Requires</a></li>
<li><a class="reference external" href="#returns">Returns</a></li>
<li><a class="reference external" href="#remarks">Remarks</a></li>
<li><a class="reference external" href="#id1">Remarks</a></li>
<li><a class="reference external" href="#examples">Examples</a></li>
<li><a class="reference external" href="#complexity">Complexity</a></li>
<li><a class="reference external" href="#id2">Interface</a></li>
<li><a class="reference external" href="#id3">Requires</a></li>
<li><a class="reference external" href="#id4">Returns</a></li>
<li><a class="reference external" href="#id5">Remarks</a></li>
<li><a class="reference external" href="#id6">Complexity</a></li>
<li><a class="reference external" href="#header">Header</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="max.html"
title="previous chapter">max</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../../_sources/libs/sprout/algorithm/minmax.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../../../search.html" method="get">
<input type="text" name="q" size="18" />
<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>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="max.html" title="max"
>previous</a> |</li>
<li><a href="../../../index.html">Sprout v1.0 documentation</a> &raquo;</li>
<li><a href="../../index.html" >Sprout C++ Libraries</a> &raquo;</li>
<li><a href="../../libraries.html" >Libraries</a> &raquo;</li>
<li><a href="index.html" >Sprout.Algorithm</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2013, Bolero MURAKAMI.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.4.
</div>
</body>
</html>

2
docs/searchindex.js
View file

File diff suppressed because one or more lines are too long

2
index.html
View file

@ -23,7 +23,7 @@
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="brand" href="#">Bolero's website</a>
<a class="brand" href="http://bolero-murakami.github.io/">Bolero's website</a>
<div class="nav-collapse collapse">
<ul class="nav">
<li><a href="http://bolero-murakami.github.io/">Home</a></li>

3
source/libs/sprout/algorithm/index.rst
View file

@ -39,6 +39,9 @@ Sprout.Algorithm
binary_search
is_heap
is_heap_until
min
max
minmax
.. _sprout-algorithm-non_modifying:
*******************************************************************************

85
source/libs/sprout/algorithm/max.rst Normal file
View file

@ -0,0 +1,85 @@
.. _sprout-algorithm-max:
###############################################################################
max
###############################################################################
Interface
========================================
.. sourcecode:: c++
template<typename T>
inline SPROUT_CONSTEXPR T const&
max(T const& a, T const& b);
template<typename T, typename Compare>
inline SPROUT_CONSTEXPR T const&
max(T const& a, T const& b, Compare comp);
Requires
========================================
| Type T is LessThanComparable.
Returns
========================================
| The larger value.
Remarks
========================================
| Returns the first argument when the arguments are equivalent.
Examples
========================================
.. sourcecode:: c++
#include <sprout/algorithm/max.hpp>
#include <sprout/array.hpp>
using namespace sprout;
SPROUT_STATIC_CONSTEXPR auto input = array<int, 10>{{-1, 1}};
SPROUT_STATIC_CONSTEXPR auto result = sprout::max(input[0], input[1]);
static_assert(result == 1, "max value is 1.");
-------------------------------------------------------------------------------
Interface
========================================
.. sourcecode:: c++
template<typename T, typename Compare>
inline SPROUT_CONSTEXPR T
max(std::initializer_list<T> t, Compare comp);
template<typename T>
inline SPROUT_CONSTEXPR T
max(std::initializer_list<T> t);
Requires
========================================
| T is LessThanComparable and CopyConstructible and ``t.size() > 0``.
Returns
========================================
| The largest value in the initializer_list.
Remarks
========================================
| Returns a copy of the leftmost argument when several arguments are equivalent to the largest.
| If an implementation not support C++14 initializer_list (SPROUT_NO_CXX14_INITIALIZER_LIST defined), then this function is not specified constexpr.
Complexity
========================================
| Recursive function invocations in *O(logN)* (logarithmic) depth.
Header
========================================
| ``sprout/algorithm/max.hpp``
| Convenience header: ``sprout/algorithm.hpp``

85
source/libs/sprout/algorithm/min.rst Normal file
View file

@ -0,0 +1,85 @@
.. _sprout-algorithm-min:
###############################################################################
min
###############################################################################
Interface
========================================
.. sourcecode:: c++
template<typename T>
inline SPROUT_CONSTEXPR T const&
min(T const& a, T const& b);
template<typename T, typename Compare>
inline SPROUT_CONSTEXPR T const&
min(T const& a, T const& b, Compare comp);
Requires
========================================
| Type T is LessThanComparable.
Returns
========================================
| The smaller value.
Remarks
========================================
| Returns the first argument when the arguments are equivalent.
Examples
========================================
.. sourcecode:: c++
#include <sprout/algorithm/min.hpp>
#include <sprout/array.hpp>
using namespace sprout;
SPROUT_STATIC_CONSTEXPR auto input = array<int, 10>{{-1, 1}};
SPROUT_STATIC_CONSTEXPR auto result = sprout::min(input[0], input[1]);
static_assert(result == -1, "min value is -1.");
-------------------------------------------------------------------------------
Interface
========================================
.. sourcecode:: c++
template<typename T, typename Compare>
inline SPROUT_CONSTEXPR T
min(std::initializer_list<T> t, Compare comp);
template<typename T>
inline SPROUT_CONSTEXPR T
min(std::initializer_list<T> t);
Requires
========================================
| T is LessThanComparable and CopyConstructible and ``t.size() > 0``.
Returns
========================================
| The smallest value in the initializer_list.
Remarks
========================================
| Returns a copy of the leftmost argument when several arguments are equivalent to the smallest.
| If an implementation not support C++14 initializer_list (SPROUT_NO_CXX14_INITIALIZER_LIST defined), then this function is not specified constexpr.
Complexity
========================================
| Recursive function invocations in *O(logN)* (logarithmic) depth.
Header
========================================
| ``sprout/algorithm/min.hpp``
| Convenience header: ``sprout/algorithm.hpp``

96
source/libs/sprout/algorithm/minmax.rst Normal file
View file

@ -0,0 +1,96 @@
.. _sprout-algorithm-minmax:
###############################################################################
minmax
###############################################################################
Interface
========================================
.. sourcecode:: c++
template<typename T>
inline SPROUT_CONSTEXPR sprout::pair<T const&, T const&>
minmax(T const& a, T const& b);
template<typename T, typename Compare>
inline SPROUT_CONSTEXPR sprout::pair<T const&, T const&>
minmax(T const& a, T const& b, Compare comp);
Requires
========================================
| Type T shall be LessThanComparable.
Returns
========================================
| ``pair<T, T>(x, y)``, where x has the smallest and y has the largest value in the initializer list.
Remarks
========================================
| Returns ``pair<const T&, const T&>(a, b)`` when the arguments are equivalent.
Remarks
========================================
Examples
========================================
.. sourcecode:: c++
#include <sprout/algorithm/minmax.hpp>
#include <sprout/array.hpp>
using namespace sprout;
SPROUT_STATIC_CONSTEXPR auto input = array<int, 10>{{-1, 1}};
SPROUT_STATIC_CONSTEXPR auto result = sprout::minmax(input[0], input[1]);
static_assert(result.first == -1, "min value is -1.");
static_assert(result.second == 1, "max value is 1.");
Complexity
========================================
| Exactly one comparison.
-------------------------------------------------------------------------------
Interface
========================================
.. sourcecode:: c++
template<typename T, typename Compare>
inline SPROUT_CONSTEXPR sprout::pair<T, T>
minmax(std::initializer_list<T> t, Compare comp);
template<typename T>
inline SPROUT_CONSTEXPR sprout::pair<T, T>
minmax(std::initializer_list<T> t);
Requires
========================================
| T is LessThanComparable and CopyConstructible and ``t.size() > 0``.
Returns
========================================
| ``pair<T, T>(x, y)``, where x has the smallest and y has the largest value in the initializer list.
Remarks
========================================
| x is a copy of the leftmost argument when several arguments are equivalent to the smallest.
| y is a copy of the rightmost argument when several arguments are equivalent to the largest.
| If an implementation not support C++14 initializer_list (SPROUT_NO_CXX14_INITIALIZER_LIST defined), then this function is not specified constexpr.
Complexity
========================================
| At most ``(3/2) * t.size()`` applications of the corresponding predicate.
| Recursive function invocations in *O(logN)* (logarithmic) depth.
Header
========================================
| ``sprout/algorithm/minmax.hpp``
| Convenience header: ``sprout/algorithm.hpp``