libs/algorithm/doc/html/boost/algorithm/is_decreasing_idp37698432.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Function template is_decreasing</title>
   5 <link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   7 <link rel="home" href="../../index.html" title="The Boost Algorithm Library">
   8 <link rel="up" href="../../header/boost/algorithm/cxx11/is_sorted_hpp.html" title="Header &lt;boost/algorithm/cxx11/is_sorted.hpp&gt;">
   9 <link rel="prev" href="is_increasing_idp37694000.html" title="Function template is_increasing">
  10 <link rel="next" href="is_decreasing_idp37704016.html" title="Function template is_decreasing">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="is_increasing_idp37694000.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../header/boost/algorithm/cxx11/is_sorted_hpp.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="is_decreasing_idp37704016.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.algorithm.is_decreasing_idp37698432"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Function template is_decreasing</span></h2>
  29 <p>boost::algorithm::is_decreasing</p>
  30 </div>
  31 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  32 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../header/boost/algorithm/cxx11/is_sorted_hpp.html" title="Header &lt;boost/algorithm/cxx11/is_sorted.hpp&gt;">boost/algorithm/cxx11/is_sorted.hpp</a>&gt;
  33
  34 </span>
  35 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ForwardIterator<span class="special">&gt;</span>
  36   <span class="keyword">bool</span> <span class="identifier">is_decreasing</span><span class="special">(</span><span class="identifier">ForwardIterator</span> first<span class="special">,</span> <span class="identifier">ForwardIterator</span> last<span class="special">)</span><span class="special">;</span></pre></div>
  37 <div class="refsect1">
  38 <a name="idp86803808"></a><h2>Description</h2>
  39 <p>
  40
  41 </p>
  42 <div class="note"><table border="0" summary="Note">
  43 <tr>
  44 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../doc/src/images/note.png"></td>
  45 <th align="left">Note</th>
  46 </tr>
  47 <tr><td align="left" valign="top"><p>This function will return true for sequences that contain items that compare equal. If that is not what you intended, you should use is_strictly_decreasing instead. </p></td></tr>
  48 </table></div>
  49 <p>
  50 </p>
  51 <div class="variablelist"><table border="0" class="variablelist compact">
  52 <colgroup>
  53 <col align="left" valign="top">
  54 <col>
  55 </colgroup>
  56 <tbody>
  57 <tr>
  58 <td><p><span class="term">Parameters:</span></p></td>
  59 <td><div class="variablelist"><table border="0" class="variablelist compact">
  60 <colgroup>
  61 <col align="left" valign="top">
  62 <col>
  63 </colgroup>
  64 <tbody>
  65 <tr>
  66 <td><p><span class="term"><code class="computeroutput">first</code></span></p></td>
  67 <td><p>The start of the sequence to be tested. </p></td>
  68 </tr>
  69 <tr>
  70 <td><p><span class="term"><code class="computeroutput">last</code></span></p></td>
  71 <td><p>One past the end of the sequence</p></td>
  72 </tr>
  73 </tbody>
  74 </table></div></td>
  75 </tr>
  76 <tr>
  77 <td><p><span class="term">Returns:</span></p></td>
  78 <td><p>true if the entire sequence is decreasing; i.e, each item is less than or equal to the previous one.</p></td>
  79 </tr>
  80 </tbody>
  81 </table></div>
  82 </div>
  83 </div>
  84 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  85 <td align="left"></td>
  86 <td align="right"><div class="copyright-footer">Copyright &#169; 2010-2012 Marshall Clow<p>
  87         Distributed under the Boost Software License, Version 1.0. (See accompanying
  88         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
  89       </p>
  90 </div></td>
  91 </tr></table>
  92 <hr>
  93 <div class="spirit-nav">
  94 <a accesskey="p" href="is_increasing_idp37694000.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../header/boost/algorithm/cxx11/is_sorted_hpp.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="is_decreasing_idp37704016.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  95 </div>
  96 </body>
  97 </html>