1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>upper_bound</title> 5<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> 8<link rel="up" href="../non_mutating.html" title="Non-mutating algorithms"> 9<link rel="prev" href="search_n.html" title="search_n"> 10<link rel="next" href="../set.html" title="Set algorithms"> 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="search_n.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../non_mutating.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="../set.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h5 class="title"> 27<a name="range.reference.algorithms.non_mutating.upper_bound"></a><a class="link" href="upper_bound.html" title="upper_bound">upper_bound</a> 28</h5></div></div></div> 29<h6> 30<a name="range.reference.algorithms.non_mutating.upper_bound.h0"></a> 31 <span class="phrase"><a name="range.reference.algorithms.non_mutating.upper_bound.prototype"></a></span><a class="link" href="upper_bound.html#range.reference.algorithms.non_mutating.upper_bound.prototype">Prototype</a> 32 </h6> 33<p> 34</p> 35<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> 36 <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> 37 <span class="keyword">class</span> <span class="identifier">Value</span> 38 <span class="special">></span> 39<span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span> 40<span class="identifier">upper_bound</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">Value</span> <span class="identifier">val</span><span class="special">);</span> 41 42<span class="keyword">template</span><span class="special"><</span> 43 <span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span> 44 <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> 45 <span class="keyword">class</span> <span class="identifier">Value</span> 46 <span class="special">></span> 47<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special"><</span><span class="identifier">ForwardRange</span><span class="special">,</span> <span class="identifier">re</span><span class="special">>::</span><span class="identifier">type</span> 48<span class="identifier">upper_bound</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">Value</span> <span class="identifier">val</span><span class="special">);</span> 49 50<span class="keyword">template</span><span class="special"><</span> 51 <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> 52 <span class="keyword">class</span> <span class="identifier">Value</span><span class="special">,</span> 53 <span class="keyword">class</span> <span class="identifier">SortPredicate</span> 54 <span class="special">></span> 55<span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">ForwardRange</span><span class="special">>::</span><span class="identifier">type</span> 56<span class="identifier">upper_bound</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">Value</span> <span class="identifier">val</span><span class="special">,</span> <span class="identifier">SortPredicate</span> <span class="identifier">pred</span><span class="special">);</span> 57 58<span class="keyword">template</span><span class="special"><</span> 59 <span class="identifier">range_return_value</span> <span class="identifier">re</span><span class="special">,</span> 60 <span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">,</span> 61 <span class="keyword">class</span> <span class="identifier">Value</span><span class="special">,</span> 62 <span class="keyword">class</span> <span class="identifier">SortPredicate</span> 63 <span class="special">></span> 64<span class="keyword">typename</span> <span class="identifier">range_return</span><span class="special"><</span><span class="identifier">ForwardRange</span><span class="special">,</span><span class="identifier">re</span><span class="special">>::</span><span class="identifier">type</span> 65<span class="identifier">upper_bound</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">Value</span> <span class="identifier">val</span><span class="special">,</span> <span class="identifier">SortPredicate</span> <span class="identifier">pred</span><span class="special">);</span> 66</pre> 67<p> 68 </p> 69<h6> 70<a name="range.reference.algorithms.non_mutating.upper_bound.h1"></a> 71 <span class="phrase"><a name="range.reference.algorithms.non_mutating.upper_bound.description"></a></span><a class="link" href="upper_bound.html#range.reference.algorithms.non_mutating.upper_bound.description">Description</a> 72 </h6> 73<p> 74 The versions of <code class="computeroutput"><span class="identifier">upper_bound</span></code> 75 that return an iterator, returns the first iterator in the range <code class="computeroutput"><span class="identifier">rng</span></code> such that: without predicate - 76 <code class="computeroutput"><span class="identifier">val</span> <span class="special"><</span> 77 <span class="special">*</span><span class="identifier">i</span></code> 78 is <code class="computeroutput"><span class="keyword">true</span></code>, with predicate 79 - <code class="computeroutput"><span class="identifier">pred</span><span class="special">(</span><span class="identifier">val</span><span class="special">,</span> <span class="special">*</span><span class="identifier">i</span><span class="special">)</span></code> is <code class="computeroutput"><span class="keyword">true</span></code>. 80 </p> 81<p> 82 <code class="computeroutput"><span class="identifier">end</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> 83 is returned if no such iterator exists. 84 </p> 85<p> 86 The versions of <code class="computeroutput"><span class="identifier">upper_bound</span></code> 87 that return a <code class="computeroutput"><span class="identifier">range_return</span></code>, 88 defines <code class="computeroutput"><span class="identifier">found</span></code> in the 89 same manner as the returned iterator described above. 90 </p> 91<h6> 92<a name="range.reference.algorithms.non_mutating.upper_bound.h2"></a> 93 <span class="phrase"><a name="range.reference.algorithms.non_mutating.upper_bound.definition"></a></span><a class="link" href="upper_bound.html#range.reference.algorithms.non_mutating.upper_bound.definition">Definition</a> 94 </h6> 95<p> 96 Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">upper_bound</span><span class="special">.</span><span class="identifier">hpp</span></code> 97 </p> 98<h6> 99<a name="range.reference.algorithms.non_mutating.upper_bound.h3"></a> 100 <span class="phrase"><a name="range.reference.algorithms.non_mutating.upper_bound.requirements"></a></span><a class="link" href="upper_bound.html#range.reference.algorithms.non_mutating.upper_bound.requirements">Requirements</a> 101 </h6> 102<p> 103 <span class="bold"><strong>For the non-predicate versions:</strong></span> 104 </p> 105<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 106<li class="listitem"> 107 <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is a 108 model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward 109 Range</a> Concept. 110 </li> 111<li class="listitem"> 112 <code class="computeroutput"><span class="identifier">Value</span></code> is a model 113 of the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code>. 114 </li> 115<li class="listitem"> 116 The ordering of objects of type <code class="computeroutput"><span class="identifier">Value</span></code> 117 is a <span class="bold"><strong><span class="emphasis"><em>strict weak ordering</em></span></strong></span>, 118 as defined in the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code> 119 requirements. 120 </li> 121<li class="listitem"> 122 <code class="computeroutput"><span class="identifier">ForwardRange</span></code>'s value 123 type is the same type as <code class="computeroutput"><span class="identifier">Value</span></code>. 124 </li> 125</ul></div> 126<p> 127 <span class="bold"><strong>For the predicate versions:</strong></span> 128 </p> 129<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 130<li class="listitem"> 131 <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is a 132 model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward 133 Range</a> Concept. 134 </li> 135<li class="listitem"> 136 <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code> is 137 a model of the <code class="computeroutput"><span class="identifier">StrictWeakOrderingConcept</span></code>. 138 </li> 139<li class="listitem"> 140 <code class="computeroutput"><span class="identifier">ForwardRange</span></code>'s value 141 type is the same type as <code class="computeroutput"><span class="identifier">Value</span></code>. 142 </li> 143<li class="listitem"> 144 <code class="computeroutput"><span class="identifier">ForwardRange</span></code>'s value 145 type is convertible to both of <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s 146 argument types. 147 </li> 148</ul></div> 149<h6> 150<a name="range.reference.algorithms.non_mutating.upper_bound.h4"></a> 151 <span class="phrase"><a name="range.reference.algorithms.non_mutating.upper_bound.precondition_"></a></span><a class="link" href="upper_bound.html#range.reference.algorithms.non_mutating.upper_bound.precondition_">Precondition:</a> 152 </h6> 153<p> 154 <span class="bold"><strong>For the non-predicate versions:</strong></span> 155 </p> 156<p> 157 <code class="computeroutput"><span class="identifier">rng</span></code> is sorted in ascending 158 order according to <code class="computeroutput"><span class="keyword">operator</span><span class="special"><</span></code>. 159 </p> 160<p> 161 <span class="bold"><strong>For the predicate versions:</strong></span> 162 </p> 163<p> 164 <code class="computeroutput"><span class="identifier">rng</span></code> is sorted in ascending 165 order according to <code class="computeroutput"><span class="identifier">pred</span></code>. 166 </p> 167<h6> 168<a name="range.reference.algorithms.non_mutating.upper_bound.h5"></a> 169 <span class="phrase"><a name="range.reference.algorithms.non_mutating.upper_bound.complexity"></a></span><a class="link" href="upper_bound.html#range.reference.algorithms.non_mutating.upper_bound.complexity">Complexity</a> 170 </h6> 171<p> 172 For ranges that model the <a class="link" href="../../../concepts/random_access_range.html" title="Random Access Range">Random 173 Access Range</a> Concept the complexity is <code class="computeroutput"><span class="identifier">O</span><span class="special">(</span><span class="identifier">log</span> <span class="identifier">N</span><span class="special">)</span></code>, 174 where <code class="computeroutput"><span class="identifier">N</span></code> is <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code>. 175 For all other range types the complexity is <code class="computeroutput"><span class="identifier">O</span><span class="special">(</span><span class="identifier">N</span><span class="special">)</span></code>. 176 </p> 177</div> 178<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 179<td align="left"></td> 180<td align="right"><div class="copyright-footer">Copyright © 2003-2010 Thorsten Ottosen, 181 Neil Groves<p> 182 Distributed under the Boost Software License, Version 1.0. (See accompanying 183 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>) 184 </p> 185</div></td> 186</tr></table> 187<hr> 188<div class="spirit-nav"> 189<a accesskey="p" href="search_n.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../non_mutating.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="../set.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 190</div> 191</body> 192</html> 193
