1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>basic_static_string::compare (1 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="../compare.html" title="basic_static_string::compare"> 10<link rel="next" href="overload2.html" title="basic_static_string::compare (2 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="../compare.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="overload2.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.overload1"></a><a class="link" href="overload1.html" title="basic_static_string::compare (1 of 9 overloads)">basic_static_string::compare 28 (1 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.overload1.h0"></a> 35 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload1.synopsis"></a></span><a class="link" href="overload1.html#static_string.ref.boost__static_strings__basic_static_string.compare.overload1.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="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> 42</pre> 43<h6> 44<a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload1.h1"></a> 45 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload1.description"></a></span><a class="link" href="overload1.html#static_string.ref.boost__static_strings__basic_static_string.compare.overload1.description">Description</a> 46 </h6> 47<p> 48 Let <code class="computeroutput"><span class="identifier">comp</span></code> be traits_type::compare(<a class="link" href="../data/overload1.html" title="basic_static_string::data (1 of 2 overloads)"><code class="computeroutput"><span class="identifier">data</span><span class="special">()</span></code></a>, 49 s.data(), std::min(<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>, 50 s.size()). If <code class="computeroutput"><span class="identifier">comp</span> <span class="special">!=</span> 51 <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 <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> 52 == s.size(), <code class="computeroutput"><span class="special">-</span><span class="number">1</span></code> 53 if <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> 54 < s.size(), and <code class="computeroutput"><span class="number">1</span></code> otherwise. 55 </p> 56<h6> 57<a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload1.h2"></a> 58 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload1.complexity"></a></span><a class="link" href="overload1.html#static_string.ref.boost__static_strings__basic_static_string.compare.overload1.complexity">Complexity</a> 59 </h6> 60<p> 61 Linear. 62 </p> 63<h6> 64<a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload1.h3"></a> 65 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload1.return_value"></a></span><a class="link" href="overload1.html#static_string.ref.boost__static_strings__basic_static_string.compare.overload1.return_value">Return 66 Value</a> 67 </h6> 68<p> 69 The result of lexicographically comparing <code class="computeroutput"><span class="identifier">s</span></code> 70 and the string. 71 </p> 72<h6> 73<a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload1.h4"></a> 74 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload1.template_parameters"></a></span><a class="link" href="overload1.html#static_string.ref.boost__static_strings__basic_static_string.compare.overload1.template_parameters">Template 75 Parameters</a> 76 </h6> 77<div class="informaltable"><table class="table"> 78<colgroup> 79<col> 80<col> 81</colgroup> 82<thead><tr> 83<th> 84 <p> 85 Type 86 </p> 87 </th> 88<th> 89 <p> 90 Description 91 </p> 92 </th> 93</tr></thead> 94<tbody><tr> 95<td> 96 <p> 97 <code class="computeroutput"><span class="identifier">M</span></code> 98 </p> 99 </td> 100<td> 101 <p> 102 The size of the string to compare with. 103 </p> 104 </td> 105</tr></tbody> 106</table></div> 107<h6> 108<a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload1.h5"></a> 109 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload1.parameters"></a></span><a class="link" href="overload1.html#static_string.ref.boost__static_strings__basic_static_string.compare.overload1.parameters">Parameters</a> 110 </h6> 111<div class="informaltable"><table class="table"> 112<colgroup> 113<col> 114<col> 115</colgroup> 116<thead><tr> 117<th> 118 <p> 119 Name 120 </p> 121 </th> 122<th> 123 <p> 124 Description 125 </p> 126 </th> 127</tr></thead> 128<tbody><tr> 129<td> 130 <p> 131 <code class="computeroutput"><span class="identifier">s</span></code> 132 </p> 133 </td> 134<td> 135 <p> 136 The string to compare. 137 </p> 138 </td> 139</tr></tbody> 140</table></div> 141</div> 142<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 143<td align="left"></td> 144<td align="right"><div class="copyright-footer">Copyright © 2019, 2020 Krystian Stasiowski<br>Copyright © 2016-2019 Vinnie 145 Falco<p> 146 Distributed under the Boost Software License, Version 1.0. (See accompanying 147 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>) 148 </p> 149</div></td> 150</tr></table> 151<hr> 152<div class="spirit-nav"> 153<a accesskey="p" href="../compare.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="overload2.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 154</div> 155</body> 156</html> 157
