1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>basic_static_string::compare (8 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="overload7.html" title="basic_static_string::compare (7 of 9 overloads)"> 10<link rel="next" href="overload9.html" title="basic_static_string::compare (9 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="overload7.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="overload9.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.overload8"></a><a class="link" href="overload8.html" title="basic_static_string::compare (8 of 9 overloads)">basic_static_string::compare 28 (8 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.overload8.h0"></a> 35 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload8.synopsis"></a></span><a class="link" href="overload8.html#static_string.ref.boost__static_strings__basic_static_string.compare.overload8.synopsis">Synopsis</a> 36 </h6> 37<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> 38 <span class="special">[</span><span class="identifier">role</span> <span class="identifier">red</span> <span class="identifier">error</span><span class="special">.</span><span class="identifier">param</span> <span class="identifier">neither</span> <span class="identifier">has</span> <span class="identifier">a</span> <span class="identifier">declname</span> <span class="identifier">nor</span> <span class="identifier">a</span> <span class="char">'class '</span> <span class="identifier">prefix</span> <span class="identifier">in</span> <span class="identifier">the</span> <span class="identifier">type</span><span class="special">][</span><span class="identifier">role</span> <span class="identifier">red</span> <span class="identifier">error</span><span class="special">.</span><span class="identifier">param</span> <span class="identifier">neither</span> <span class="identifier">has</span> <span class="identifier">a</span> <span class="identifier">declname</span> <span class="identifier">nor</span> <span class="identifier">a</span> <span class="char">'class '</span> <span class="identifier">prefix</span> <span class="identifier">in</span> <span class="identifier">the</span> <span class="identifier">type</span><span class="special">][</span><span class="identifier">role</span> <span class="identifier">red</span> <span class="identifier">error</span><span class="special">.</span><span class="identifier">param</span> <span class="identifier">neither</span> <span class="identifier">has</span> <span class="identifier">a</span> <span class="identifier">declname</span> <span class="identifier">nor</span> <span class="identifier">a</span> <span class="char">'class '</span> <span class="identifier">prefix</span> <span class="identifier">in</span> <span class="identifier">the</span> <span class="identifier">type</span><span class="special">][</span><span class="identifier">role</span> <span class="identifier">red</span> <span class="identifier">error</span><span class="special">.</span><span class="identifier">param</span> <span class="identifier">neither</span> <span class="identifier">has</span> <span class="identifier">a</span> <span class="identifier">declname</span> <span class="identifier">nor</span> <span class="identifier">a</span> <span class="char">'class '</span> <span class="identifier">prefix</span> <span class="identifier">in</span> <span class="identifier">the</span> <span class="identifier">type</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">T</span><span class="special">&</span> <span class="identifier">t</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.overload8.h1"></a> 47 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload8.description"></a></span><a class="link" href="overload8.html#static_string.ref.boost__static_strings__basic_static_string.compare.overload8.description">Description</a> 48 </h6> 49<p> 50 Let <code class="computeroutput"><span class="identifier">s</span></code> be <code class="computeroutput"><span class="identifier">string_view_type</span><span class="special">(</span><span class="identifier">t</span><span class="special">)</span></code>, 51 <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>, 52 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>. 53 If <code class="computeroutput"><span class="identifier">comp</span> <span class="special">!=</span> 54 <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>, 55 <code class="computeroutput"><span class="special">-</span><span class="number">1</span></code> 56 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> 57 otherwise. 58 </p> 59<h6> 60<a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload8.h2"></a> 61 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload8.complexity"></a></span><a class="link" href="overload8.html#static_string.ref.boost__static_strings__basic_static_string.compare.overload8.complexity">Complexity</a> 62 </h6> 63<p> 64 Linear. 65 </p> 66<h6> 67<a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload8.h3"></a> 68 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload8.exception_safety"></a></span><a class="link" href="overload8.html#static_string.ref.boost__static_strings__basic_static_string.compare.overload8.exception_safety">Exception 69 Safety</a> 70 </h6> 71<p> 72 Strong guarantee. 73 </p> 74<h6> 75<a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload8.h4"></a> 76 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload8.template_parameters"></a></span><a class="link" href="overload8.html#static_string.ref.boost__static_strings__basic_static_string.compare.overload8.template_parameters">Template 77 Parameters</a> 78 </h6> 79<div class="informaltable"><table class="table"> 80<colgroup> 81<col> 82<col> 83</colgroup> 84<thead><tr> 85<th> 86 <p> 87 Type 88 </p> 89 </th> 90<th> 91 <p> 92 Description 93 </p> 94 </th> 95</tr></thead> 96<tbody><tr> 97<td> 98 <p> 99 <code class="computeroutput"><span class="identifier">T</span></code> 100 </p> 101 </td> 102<td> 103 <p> 104 The type of the object to convert. 105 </p> 106 </td> 107</tr></tbody> 108</table></div> 109<h6> 110<a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload8.h5"></a> 111 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload8.constraints"></a></span><a class="link" href="overload8.html#static_string.ref.boost__static_strings__basic_static_string.compare.overload8.constraints">Constraints</a> 112 </h6> 113<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">is_convertible</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">T</span><span class="special">&,</span> <span class="identifier">string_view</span><span class="special">>::</span><span class="identifier">value</span> <span class="special">&&</span> 114<span class="special">!</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">is_convertible</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">T</span><span class="special">&,</span> <span class="identifier">const_pointer</span><span class="special">>::</span><span class="identifier">value</span><span class="special">.</span> 115</pre> 116<h6> 117<a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload8.h6"></a> 118 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload8.return_value"></a></span><a class="link" href="overload8.html#static_string.ref.boost__static_strings__basic_static_string.compare.overload8.return_value">Return 119 Value</a> 120 </h6> 121<p> 122 The result of lexicographically comparing <code class="computeroutput"><span class="identifier">s</span></code> 123 and <code class="computeroutput"><span class="identifier">sub</span></code>. 124 </p> 125<h6> 126<a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload8.h7"></a> 127 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload8.parameters"></a></span><a class="link" href="overload8.html#static_string.ref.boost__static_strings__basic_static_string.compare.overload8.parameters">Parameters</a> 128 </h6> 129<div class="informaltable"><table class="table"> 130<colgroup> 131<col> 132<col> 133</colgroup> 134<thead><tr> 135<th> 136 <p> 137 Name 138 </p> 139 </th> 140<th> 141 <p> 142 Description 143 </p> 144 </th> 145</tr></thead> 146<tbody> 147<tr> 148<td> 149 <p> 150 <code class="computeroutput"><span class="identifier">pos1</span></code> 151 </p> 152 </td> 153<td> 154 <p> 155 The index at which to begin the substring. 156 </p> 157 </td> 158</tr> 159<tr> 160<td> 161 <p> 162 <code class="computeroutput"><span class="identifier">count1</span></code> 163 </p> 164 </td> 165<td> 166 <p> 167 The length of the substring. 168 </p> 169 </td> 170</tr> 171<tr> 172<td> 173 <p> 174 <code class="computeroutput"><span class="identifier">t</span></code> 175 </p> 176 </td> 177<td> 178 <p> 179 The string to compare. 180 </p> 181 </td> 182</tr> 183</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="overload7.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="overload9.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 198</div> 199</body> 200</html> 201
