1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>basic_static_string::compare (4 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="overload3.html" title="basic_static_string::compare (3 of 9 overloads)"> 10<link rel="next" href="overload5.html" title="basic_static_string::compare (5 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="overload3.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="overload5.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.overload4"></a><a class="link" href="overload4.html" title="basic_static_string::compare (4 of 9 overloads)">basic_static_string::compare 28 (4 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.overload4.h0"></a> 35 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload4.synopsis"></a></span><a class="link" href="overload4.html#static_string.ref.boost__static_strings__basic_static_string.compare.overload4.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">const_pointer</span> <span class="identifier">s</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 40</pre> 41<h6> 42<a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload4.h1"></a> 43 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload4.description"></a></span><a class="link" href="overload4.html#static_string.ref.boost__static_strings__basic_static_string.compare.overload4.description">Description</a> 44 </h6> 45<p> 46 Let <code class="computeroutput"><span class="identifier">len</span></code> be <code class="computeroutput"><span class="identifier">traits_type</span><span class="special">::</span><span class="identifier">length</span><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></code> 47 and <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>, 48 s, std::min(size(), len). If <code class="computeroutput"><span class="identifier">comp</span> 49 <span class="special">!=</span> <span class="number">0</span></code>, 50 then the result is <code class="computeroutput"><span class="identifier">comp</span></code>. 51 Otherwise, the result is <code class="computeroutput"><span class="number">0</span></code> 52 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> 53 == len, <code class="computeroutput"><span class="special">-</span><span class="number">1</span></code> 54 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> 55 < len, and <code class="computeroutput"><span class="number">1</span></code> otherwise. 56 </p> 57<h6> 58<a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload4.h2"></a> 59 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload4.complexity"></a></span><a class="link" href="overload4.html#static_string.ref.boost__static_strings__basic_static_string.compare.overload4.complexity">Complexity</a> 60 </h6> 61<p> 62 Linear. 63 </p> 64<h6> 65<a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload4.h3"></a> 66 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload4.return_value"></a></span><a class="link" href="overload4.html#static_string.ref.boost__static_strings__basic_static_string.compare.overload4.return_value">Return 67 Value</a> 68 </h6> 69<p> 70 The result of lexicographically comparing <code class="computeroutput"><span class="identifier">s</span></code> 71 and the string. 72 </p> 73<h6> 74<a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload4.h4"></a> 75 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.compare.overload4.parameters"></a></span><a class="link" href="overload4.html#static_string.ref.boost__static_strings__basic_static_string.compare.overload4.parameters">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 Name 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">s</span></code> 98 </p> 99 </td> 100<td> 101 <p> 102 The string to compare. 103 </p> 104 </td> 105</tr></tbody> 106</table></div> 107</div> 108<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 109<td align="left"></td> 110<td align="right"><div class="copyright-footer">Copyright © 2019, 2020 Krystian Stasiowski<br>Copyright © 2016-2019 Vinnie 111 Falco<p> 112 Distributed under the Boost Software License, Version 1.0. (See accompanying 113 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>) 114 </p> 115</div></td> 116</tr></table> 117<hr> 118<div class="spirit-nav"> 119<a accesskey="p" href="overload3.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="overload5.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 120</div> 121</body> 122</html> 123
