<!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" xml:lang="en"
lang="en" dir="ltr">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
binary_search [C++ Reference]
</title>
<meta name="generator" content="DokuWiki Release 2009-12-25c "Lemming"" />
<meta name="robots" content="noindex,nofollow" />
<meta name="date" content="2010-05-03T18:55:57-0700" />
<meta name="keywords" content="stl,algorithm,binary_search" />
<link rel="search" type="application/opensearchdescription+xml" href="/wiki/lib/exe/opensearch.php" title="C++ Reference" />
<link rel="start" href="/wiki/" />
<link rel="contents" href="/wiki/stl/algorithm/binary_search?do=index" title="Index" />
<link rel="alternate" type="application/rss+xml" title="Recent Changes" href="/wiki/feed.php" />
<link rel="alternate" type="application/rss+xml" title="Current Namespace" href="/wiki/feed.php?mode=list&ns=stl:algorithm" />
<link rel="edit" title="Edit this page" href="/wiki/stl/algorithm/binary_search?do=edit" />
<link rel="alternate" type="text/html" title="Plain HTML" href="/wiki/_export/xhtml/stl/algorithm/binary_search" />
<link rel="alternate" type="text/plain" title="Wiki Markup" href="/wiki/_export/raw/stl/algorithm/binary_search" />
<link rel="canonical" href="http://www.cppreference.com/wiki/stl/algorithm/binary_search" />
<link rel="stylesheet" media="all" type="text/css" href="/wiki/lib/exe/css.php?s=all&t=custom1&tseed=1272971091" />
<link rel="stylesheet" media="screen" type="text/css" href="/wiki/lib/exe/css.php?t=custom1&tseed=1272971091" />
<link rel="stylesheet" media="print" type="text/css" href="/wiki/lib/exe/css.php?s=print&t=custom1&tseed=1272971091" />
<script type="text/javascript" charset="utf-8" ><!--//--><![CDATA[//><!--
var NS='stl:algorithm';var JSINFO = {"id":"stl:algorithm:binary_search","namespace":"stl:algorithm"};
//--><!]]></script>
<script type="text/javascript" charset="utf-8" src="/wiki/lib/exe/js.php?tseed=1272971091" ></script>
<link rel="shortcut icon" href="/wiki/lib/tpl/custom1/images/favicon.png" />
</head>
<body>
<div class="dokuwiki">
<div class="stylehead">
<div class="header">
<div class="pagename">
[[<a href="../../stl/algorithm/binary_search.html" title="Backlinks">binary_search</a>]]
</div>
<div class="logo">
<a href="http://www.cppreference.com" name="dokuwiki__top" id="dokuwiki__top" accesskey="h" title="[ALT+H]">C++ Reference</a> </div>
<div class="clearer"></div>
</div>
<div class="breadcrumbs">
<span class="bchead">You are here: </span><a href="../../start.html" title="start">C++ Reference</a> » <a href="../../stl/start.html" title="stl:start">C++ Standard Template Library</a> » <a href="../../stl/algorithm/start.html" title="stl:algorithm:start">C++ Algorithms</a> » <a href="../../stl/algorithm/binary_search.html" title="stl:algorithm:binary_search">binary_search</a> </div>
</div>
<div class="plugin_translation"><span>Translations of this page<sup><a href="../../localization.html" class="wikilink1" title="localization">?</a></sup>:</span> <ul> <li><div class="li"><span class="curid"><a href="../../stl/algorithm/binary_search.html" class="wikilink1" title="stl:algorithm:binary_search">en</a></span></div></li> <li><div class="li"><a href="../../br-pt/stl/algorithm/binary_search.html" class="wikilink2" title="br-pt:stl:algorithm:binary_search" rel="nofollow">br-pt</a></div></li> <li><div class="li"><a href="../../cn/stl/algorithm/binary_search.html" class="wikilink2" title="cn:stl:algorithm:binary_search" rel="nofollow">cn</a></div></li> <li><div class="li"><a href="../../cz/stl/algorithm/binary_search.html" class="wikilink2" title="cz:stl:algorithm:binary_search" rel="nofollow">cz</a></div></li> <li><div class="li"><a href="../../de/stl/algorithm/binary_search.html" class="wikilink2" title="de:stl:algorithm:binary_search" rel="nofollow">de</a></div></li> <li><div class="li"><a href="../../es/stl/algorithm/binary_search.html" class="wikilink2" title="es:stl:algorithm:binary_search" rel="nofollow">es</a></div></li> <li><div class="li"><a href="../../fr/stl/algorithm/binary_search.html" class="wikilink2" title="fr:stl:algorithm:binary_search" rel="nofollow">fr</a></div></li> <li><div class="li"><a href="../../it/stl/algorithm/binary_search.html" class="wikilink2" title="it:stl:algorithm:binary_search" rel="nofollow">it</a></div></li> <li><div class="li"><a href="../../jp/stl/algorithm/binary_search.html" class="wikilink2" title="jp:stl:algorithm:binary_search" rel="nofollow">jp</a></div></li> <li><div class="li"><a href="../../nl/stl/algorithm/binary_search.html" class="wikilink2" title="nl:stl:algorithm:binary_search" rel="nofollow">nl</a></div></li> <li><div class="li"><a href="../../pl/stl/algorithm/binary_search.html" class="wikilink2" title="pl:stl:algorithm:binary_search" rel="nofollow">pl</a></div></li> <li><div class="li"><a href="../../ro/stl/algorithm/binary_search.html" class="wikilink2" title="ro:stl:algorithm:binary_search" rel="nofollow">ro</a></div></li> <li><div class="li"><a href="../../ru/stl/algorithm/binary_search.html" class="wikilink2" title="ru:stl:algorithm:binary_search" rel="nofollow">ru</a></div></li> <li><div class="li"><a href="../../sk/stl/algorithm/binary_search.html" class="wikilink2" title="sk:stl:algorithm:binary_search" rel="nofollow">sk</a></div></li> <li><div class="li"><a href="../../tr/stl/algorithm/binary_search.html" class="wikilink2" title="tr:stl:algorithm:binary_search" rel="nofollow">tr</a></div></li> <li><div class="li"><a href="../../tw/stl/algorithm/binary_search.html" class="wikilink2" title="tw:stl:algorithm:binary_search" rel="nofollow">tw</a></div></li></ul></div>
<div class="page">
<script src="http://www.google-analytics.com/urchin.js" type="text/javascript">
</script>
<script type="text/javascript">
_uacct = "UA-2828341-1";
urchinTracker();
</script>
<!-- wikipage start -->
<h2><a name="binary_search" id="binary_search">binary_search</a></h2>
<div class="level2">
<p>
Syntax:
</p>
<pre class="c code c++" style="font-family:monospace;"> <span class="co2">#include <algorithm></span>
bool binary_search<span class="br0">(</span> forward_iterator start<span class="sy0">,</span> forward_iterator end<span class="sy0">,</span> <span class="kw4">const</span> TYPE<span class="sy0">&</span> val <span class="br0">)</span><span class="sy0">;</span>
bool binary_search<span class="br0">(</span> forward_iterator start<span class="sy0">,</span> forward_iterator end<span class="sy0">,</span> <span class="kw4">const</span> TYPE<span class="sy0">&</span> val<span class="sy0">,</span> Comp f <span class="br0">)</span><span class="sy0">;</span></pre>
<p>
The binary_search() function searches from <code>start</code> to <code>end</code> for <code>val</code>. The elements
between <code>start</code> and <code>end</code> that are searched should be in ascending order as defined
by the < operator. Note that a binary search will not work unless the elements
being searched are in order.
</p>
<p>
Only the < operator should be defined for the values. Two values <code>a</code> and <code>b</code> are
considered equal when <code>!(a<b) && !(b<a)</code> is true.
</p>
<p>
If <code>val</code> is found, binary_search() returns true, otherwise false.
If the function <code>f</code> is specified, then it is used to compare elements instead of operator< .
</p>
<p>
binary_search() runs in <a href="../../complexity.html" class="wikilink1" title="complexity">logarithmic time</a>.
</p>
<p>
For example, the following code uses binary_search() to determine if the
integers 0-9 are in an array of integers (nums[] should be sorted in ascending order):
</p>
<pre class="c code c++" style="font-family:monospace;"> <span class="kw4">int</span> nums<span class="br0">[</span><span class="br0">]</span> <span class="sy0">=</span> <span class="br0">{</span> <span class="sy0">-</span>242<span class="sy0">,</span> <span class="sy0">-</span>1<span class="sy0">,</span> 0<span class="sy0">,</span> 5<span class="sy0">,</span> 8<span class="sy0">,</span> 9<span class="sy0">,</span> 11 <span class="br0">}</span><span class="sy0">;</span>
<span class="kw4">int</span> start <span class="sy0">=</span> <span class="nu0">0</span><span class="sy0">;</span>
<span class="kw4">int</span> end <span class="sy0">=</span> <span class="nu0">7</span><span class="sy0">;</span>
<span class="kw1">for</span><span class="br0">(</span> <span class="kw4">int</span> i <span class="sy0">=</span> <span class="nu0">0</span><span class="sy0">;</span> i <span class="sy0"><</span> <span class="nu0">10</span><span class="sy0">;</span> i<span class="sy0">++</span> <span class="br0">)</span> <span class="br0">{</span>
<span class="kw1">if</span><span class="br0">(</span> binary_search<span class="br0">(</span> nums<span class="sy0">+</span>start<span class="sy0">,</span> nums<span class="sy0">+</span>end<span class="sy0">,</span> i <span class="br0">)</span> <span class="br0">)</span> <span class="br0">{</span>
<a href="http://www.opengroup.org/onlinepubs/009695399/functions/cout.html"><span class="kw3">cout</span></a> <span class="sy0"><<</span> <span class="st0">"nums[] contains "</span> <span class="sy0"><<</span> i <span class="sy0"><<</span> endl<span class="sy0">;</span>
<span class="br0">}</span> <span class="kw1">else</span> <span class="br0">{</span>
<a href="http://www.opengroup.org/onlinepubs/009695399/functions/cout.html"><span class="kw3">cout</span></a> <span class="sy0"><<</span> <span class="st0">"nums[] DOES NOT contain "</span> <span class="sy0"><<</span> i <span class="sy0"><<</span> endl<span class="sy0">;</span>
<span class="br0">}</span>
<span class="br0">}</span></pre>
<p>
When run, this code displays the following output:
</p>
<pre class="code">
nums[] contains 0
nums[] DOES NOT contain 1
nums[] DOES NOT contain 2
nums[] DOES NOT contain 3
nums[] DOES NOT contain 4
nums[] contains 5
nums[] DOES NOT contain 6
nums[] DOES NOT contain 7
nums[] contains 8
nums[] contains 9</pre>
<p>
Related Topics: <a href="../../stl/algorithm/equal_range.html" class="wikilink1" title="stl:algorithm:equal_range">equal_range</a>, <a href="../../stl/algorithm/lower_bound.html" class="wikilink1" title="stl:algorithm:lower_bound">lower_bound</a>, <a href="../../stl/algorithm/partial_sort.html" class="wikilink1" title="stl:algorithm:partial_sort">partial_sort</a>, <a href="../../stl/algorithm/partial_sort_copy.html" class="wikilink1" title="stl:algorithm:partial_sort_copy">partial_sort_copy</a>, <a href="../../stl/algorithm/sort.html" class="wikilink1" title="stl:algorithm:sort">sort</a>, <a href="../../stl/algorithm/stable_sort.html" class="wikilink1" title="stl:algorithm:stable_sort">stable_sort</a>, <a href="../../stl/algorithm/upper_bound.html" class="wikilink1" title="stl:algorithm:upper_bound">upper_bound</a>
</p>
</div>
<!-- wikipage stop -->
</div>
<div class="clearer"> </div>
<div class="stylefoot">
<div class="meta">
<div class="user">
</div>
<!--
<div class="doc">
stl/algorithm/binary_search.txt · Last modified: 05/03/2010 18:55 by 202.147.142.163 </div>
-->
</div>
<div class="bar" id="bar__bottom">
<div class="bar-left" id="bar__bottomleft">
<a href="../../stl/algorithm/binary_search.html" class="action edit" accesskey="e" rel="nofollow">Edit this page</a> •
<a href="../../stl/algorithm/binary_search.html" class="action revisions" accesskey="o" rel="nofollow">Old revisions</a> </div>
<div class="bar-right" id="bar__bottomright">
•
•
•
<a href="../../stl/algorithm/binary_search.html" class="action login" rel="nofollow">Login</a> •
<a href="../../stl/algorithm/binary_search.html" class="action index" accesskey="x" rel="nofollow">Index</a> •
<a href="../../stl/algorithm/binary_search.html" class="action recent" accesskey="r" rel="nofollow">Recent changes</a> •
<a href="../../feed.php.html" title="Recent changes RSS feed">RSS</a> •
<a href='http://creativecommons.org/licenses/by/3.0/us/' title='Creative Commons license'>cc</a> •
<form action="/wiki/" accept-charset="utf-8" class="search" id="dw__search"><div class="no"><input type="hidden" name="do" value="search" /><input type="text" id="qsearch__in" accesskey="f" name="id" class="edit" title="[ALT+F]" /><input type="submit" value="Search" class="button" title="Search" /><div id="qsearch__out" class="ajax_qsearch JSpopup"></div></div></form>
</div>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="no"><img src="/wiki/lib/exe/indexer.php?id=stl%3Aalgorithm%3Abinary_search&1273196139" width="1" height="1" alt="" /></div>
</body>
</html>