1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>basic_static_string::compare (6 of 9 overloads)</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="Boost.StaticString"> 8<link rel="up" href="../compare.html" title="basic_static_string::compare"> 9<link rel="prev" href="overload5.html" title="basic_static_string::compare (5 of 9 overloads)"> 10<link rel="next" href="overload7.html" title="basic_static_string::compare (7 of 9 overloads)"> 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="overload5.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../compare.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="overload7.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="static_string.ref.boost__static_strings__basic_static_string.compare.overload6"></a><a class="link" href="overload6.html" title="basic_static_string::compare (6 of 9 overloads)">basic_static_string::compare 28 (6 of 9 overloads)</a> 29</h5></div></div></div> 30<p> 31 Compare a string with the string. 32 </p> 33<h6> 34<a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload6.h0"></a> 35 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload6.synopsis"></a></span><a class="link" href="overload6.html#static_string.ref.boost__static_strings__basic_static_string.compare.overload6.synopsis">Synopsis</a> 36 </h6> 37<pre class="programlisting"><span class="keyword">constexpr</span> <span class="keyword">int</span> 38<span class="identifier">compare</span><span class="special">(</span> 39 <span class="identifier">size_type</span> <span class="identifier">pos1</span><span class="special">,</span> 40 <span class="identifier">size_type</span> <span class="identifier">count1</span><span class="special">,</span> 41 <span class="identifier">const_pointer</span> <span class="identifier">s</span><span class="special">,</span> 42 <span class="identifier">size_type</span> <span class="identifier">count2</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 43</pre> 44<h6> 45<a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload6.h1"></a> 46 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload6.description"></a></span><a class="link" href="overload6.html#static_string.ref.boost__static_strings__basic_static_string.compare.overload6.description">Description</a> 47 </h6> 48<p> 49 Let <code class="computeroutput"><span class="identifier">sub</span></code> be <code class="computeroutput"><span class="identifier">substr</span><span class="special">(</span><span class="identifier">pos1</span><span class="special">,</span> <span class="identifier">count1</span><span class="special">)</span></code>, 50 and <code class="computeroutput"><span class="identifier">comp</span></code> be <code class="computeroutput"><span class="identifier">traits_type</span><span class="special">::</span><span class="identifier">compare</span><span class="special">(</span><span class="identifier">sub</span><span class="special">.</span><span class="identifier">data</span><span class="special">(),</span> <span class="identifier">s</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">min</span><span class="special">(</span><span class="identifier">size</span><span class="special">(),</span> <span class="identifier">count2</span><span class="special">)</span></code>. 51 If <code class="computeroutput"><span class="identifier">comp</span> <span class="special">!=</span> 52 <span class="number">0</span></code>, then the result is <code class="computeroutput"><span class="identifier">comp</span></code>. Otherwise, the result is <code class="computeroutput"><span class="number">0</span></code> if <code class="computeroutput"><span class="identifier">sub</span><span class="special">.</span><span class="identifier">size</span><span class="special">()</span> <span class="special">==</span> <span class="identifier">count2</span></code>, <code class="computeroutput"><span class="special">-</span><span class="number">1</span></code> if <code class="computeroutput"><span class="identifier">sub</span><span class="special">.</span><span class="identifier">size</span><span class="special">()</span> <span class="special"><</span> <span class="identifier">count2</span></code>, and <code class="computeroutput"><span class="number">1</span></code> 53 otherwise. 54 </p> 55<h6> 56<a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload6.h2"></a> 57 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload6.complexity"></a></span><a class="link" href="overload6.html#static_string.ref.boost__static_strings__basic_static_string.compare.overload6.complexity">Complexity</a> 58 </h6> 59<p> 60 Linear. 61 </p> 62<h6> 63<a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload6.h3"></a> 64 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload6.exception_safety"></a></span><a class="link" href="overload6.html#static_string.ref.boost__static_strings__basic_static_string.compare.overload6.exception_safety">Exception 65 Safety</a> 66 </h6> 67<p> 68 Strong guarantee. 69 </p> 70<h6> 71<a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload6.h4"></a> 72 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload6.return_value"></a></span><a class="link" href="overload6.html#static_string.ref.boost__static_strings__basic_static_string.compare.overload6.return_value">Return 73 Value</a> 74 </h6> 75<p> 76 The result of lexicographically comparing <code class="computeroutput"><span class="identifier">s</span></code> 77 and <code class="computeroutput"><span class="identifier">sub</span></code>. 78 </p> 79<h6> 80<a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload6.h5"></a> 81 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload6.parameters"></a></span><a class="link" href="overload6.html#static_string.ref.boost__static_strings__basic_static_string.compare.overload6.parameters">Parameters</a> 82 </h6> 83<div class="informaltable"><table class="table"> 84<colgroup> 85<col> 86<col> 87</colgroup> 88<thead><tr> 89<th> 90 <p> 91 Name 92 </p> 93 </th> 94<th> 95 <p> 96 Description 97 </p> 98 </th> 99</tr></thead> 100<tbody> 101<tr> 102<td> 103 <p> 104 <code class="computeroutput"><span class="identifier">pos1</span></code> 105 </p> 106 </td> 107<td> 108 <p> 109 The index at which to begin the substring. 110 </p> 111 </td> 112</tr> 113<tr> 114<td> 115 <p> 116 <code class="computeroutput"><span class="identifier">count1</span></code> 117 </p> 118 </td> 119<td> 120 <p> 121 The size of the substring. 122 </p> 123 </td> 124</tr> 125<tr> 126<td> 127 <p> 128 <code class="computeroutput"><span class="identifier">s</span></code> 129 </p> 130 </td> 131<td> 132 <p> 133 The string to compare. 134 </p> 135 </td> 136</tr> 137<tr> 138<td> 139 <p> 140 <code class="computeroutput"><span class="identifier">count2</span></code> 141 </p> 142 </td> 143<td> 144 <p> 145 The length of the string to compare. 146 </p> 147 </td> 148</tr> 149</tbody> 150</table></div> 151<h6> 152<a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload6.h6"></a> 153 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload6.exceptions"></a></span><a class="link" href="overload6.html#static_string.ref.boost__static_strings__basic_static_string.compare.overload6.exceptions">Exceptions</a> 154 </h6> 155<div class="informaltable"><table class="table"> 156<colgroup> 157<col> 158<col> 159</colgroup> 160<thead><tr> 161<th> 162 <p> 163 Type 164 </p> 165 </th> 166<th> 167 <p> 168 Thrown On 169 </p> 170 </th> 171</tr></thead> 172<tbody><tr> 173<td> 174 <p> 175 <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">out_of_range</span></code> 176 </p> 177 </td> 178<td> 179 <p> 180 pos1 > <a class="link" href="../size.html" title="basic_static_string::size"><code class="computeroutput"><span class="identifier">size</span><span class="special">()</span></code></a> 181 </p> 182 </td> 183</tr></tbody> 184</table></div> 185</div> 186<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 187<td align="left"></td> 188<td align="right"><div class="copyright-footer">Copyright © 2019, 2020 Krystian Stasiowski<br>Copyright © 2016-2019 Vinnie 189 Falco<p> 190 Distributed under the Boost Software License, Version 1.0. (See accompanying 191 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>) 192 </p> 193</div></td> 194</tr></table> 195<hr> 196<div class="spirit-nav"> 197<a accesskey="p" href="overload5.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../compare.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="overload7.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 198</div> 199</body> 200</html> 201
