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