File: find_end.html

package info (click to toggle)
stl-manual 3.11-3
  • links: PTS
  • area: main
  • in suites: potato, slink
  • size: 3,760 kB
  • ctags: 3,857
  • sloc: cpp: 16,351; ansic: 1,340; makefile: 34; sh: 6
file content (192 lines) | stat: -rw-r--r-- 7,730 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
<HTML>
<!--
  -- Copyright (c) 1996,1997
  -- Silicon Graphics Computer Systems, Inc.
  --
  -- Permission to use, copy, modify, distribute and sell this software
  -- and its documentation for any purpose is hereby granted without fee,
  -- provided that the above copyright notice appears in all copies and
  -- that both that copyright notice and this permission notice appear
  -- in supporting documentation.  Silicon Graphics makes no
  -- representations about the suitability of this software for any
  -- purpose.  It is provided "as is" without express or implied warranty.
  --
  -- Copyright (c) 1994
  -- Hewlett-Packard Company
  --
  -- Permission to use, copy, modify, distribute and sell this software
  -- and its documentation for any purpose is hereby granted without fee,
  -- provided that the above copyright notice appears in all copies and
  -- that both that copyright notice and this permission notice appear
  -- in supporting documentation.  Hewlett-Packard Company makes no
  -- representations about the suitability of this software for any
  -- purpose.  It is provided "as is" without express or implied warranty.
  --
  -->
<Head>
<Title>find_end</Title>
<!-- Generated by htmldoc -->
</HEAD>
<BODY BGCOLOR="#ffffff" LINK="#0000ee" TEXT="#000000" VLINK="#551a8b" 
	ALINK="#ff0000"> 
<IMG SRC="CorpID.gif" 
     ALT="Silicon Graphics, Inc." HEIGHT="43" WIDTH="151"> 
<!--end header-->
<BR Clear>
<H1>find_end</H1>

<Table CellPadding=0 CellSpacing=0 width=100%>
<TR>
<TD Align=left><Img src = "algorithms.gif" Alt=""   WIDTH = "194"  HEIGHT = "38" ></TD>
<TD Align=right><Img src = "function.gif" Alt=""   WIDTH = "194"  HEIGHT = "38" ></TD>
</TR>
<TR>
<TD Align=left VAlign=top><b>Category</b>: algorithms</TD>
<TD Align=right VAlign=top><b>Component type</b>: function</TD>
</TR>
</Table>

<h3>Prototype</h3>
<tt>find_end</tt> is an overloaded name; there are actually two <tt>find_end</tt>
functions.
<pre>
template &lt;class ForwardIterator1, class ForwardIterator2&gt;
ForwardIterator1 
find_end(ForwardIterator1 first1, ForwardIterator1 last1, 
         ForwardIterator2 first2, ForwardIterator2 last2);

template &lt;class ForwardIterator1, class ForwardIterator2, 
          class BinaryPredicate&gt;
ForwardIterator1 
find_end(ForwardIterator1 first1, ForwardIterator1 last1, 
         ForwardIterator2 first2, ForwardIterator2 last2,
         BinaryPredicate comp);
</pre>		   
<h3>Description</h3>
<tt>Find_end</tt> is misnamed: it is much more similar to <tt><A href="search.html">search</A></tt>
than to <tt><A href="find.html">find</A></tt>, and a more accurate name would have been
<tt>search_end</tt>.
<P>
Like <tt>search</tt>, <tt>find_end</tt> attempts to find a subsequence within
the range <tt>[first1, last1)</tt> that is identical to <tt>[first2, last2)</tt>.
The difference is that while <tt>search</tt> finds the first such
subsequence, <tt>find_end</tt> finds the last such subsequence.  
<tt>Find_end</tt> returns an iterator pointing to the beginning of 
that subsequence; if no such subsequence exists, it returns <tt>last1</tt>.
<P>
The two versions of 
<tt>search</tt> differ in how they determine whether two elements are the same:
the first uses <tt>operator==</tt>, and the second uses the user-supplied
<A href="functors.html">function object</A> <tt>comp</tt>.
<P>
The first version of <tt>find_end</tt> returns the last iterator
<tt>i</tt> in the range <tt>[first1, last1 - (last2 - first2))</tt> such that, for
every iterator <tt>j</tt> in the range <tt>[first2, last2)</tt>, 
<tt>*(i + (j - first2)) == *j</tt>.  The second version 
of <tt>find_end</tt> returns the last iterator
<tt>i</tt> in <tt>[first1, last1 - (last2 - first2))</tt> such that, for
every iterator <tt>j</tt> in <tt>[first2, last2)</tt>, 
<tt>binary_pred(*(i + (j - first2)), *j)</tt> is <tt>true</tt>.  These conditions
simply mean that every element in the subrange beginning with <tt>i</tt>
must be the same as the corresponding element in <tt>[first2, last2)</tt>.
<h3>Definition</h3>
Defined in <A href="algo.h">algo.h</A>.  
<h3>Requirements on types</h3>
For the first version:
<UL>
<LI>
<tt>ForwardIterator1</tt> is a model of <A href="ForwardIterator.html">Forward Iterator</A>.
<LI>
<tt>ForwardIterator2</tt> is a model of <A href="ForwardIterator.html">Forward Iterator</A>.
<LI>
<tt>ForwardIterator1</tt>'s value type is a model of <A href="EqualityComparable.html">EqualityComparable</A>.
<LI>
<tt>ForwardIterator2</tt>'s value type is a model of <A href="EqualityComparable.html">EqualityComparable</A>.
<LI>
Objects of <tt>ForwardIterator1</tt>'s value type can be compared for
   equality with Objects of <tt>ForwardIterator2</tt>'s value type.
</UL>
For the second version:
<UL>
<LI>
<tt>ForwardIterator1</tt> is a model of <A href="ForwardIterator.html">Forward Iterator</A>.
<LI>
<tt>ForwardIterator2</tt> is a model of <A href="ForwardIterator.html">Forward Iterator</A>.
<LI>
<tt>BinaryPredicate</tt> is a model of <A href="BinaryPredicate.html">Binary Predicate</A>.
<LI>
<tt>ForwardIterator1</tt>'s value type is convertible to <tt>BinaryPredicate</tt>'s
   first argument type.
<LI>
<tt>ForwardIterator2</tt>'s value type is convertible to <tt>BinaryPredicate</tt>'s
   second argument type.
</UL>
<h3>Preconditions</h3>
<UL>
<LI>
<tt>[first1, last1)</tt> is a valid range.
<LI>
<tt>[first2, last2)</tt> is a valid range.
</UL>
<h3>Complexity</h3>
The number of comparisons is proportional to <tt>(last1 - first1) *
(last2 - first2)</tt>.  If both <tt>ForwardIterator1</tt> and <tt>ForwardIterator2</tt>
are models of <A href="BidirectionalIterator.html">Bidirectional Iterator</A>, then the average complexity
is linear and the worst case is at most <tt>(last1 - first1) *
(last2 - first2)</tt> comparisons.
<h3>Example</h3>
<pre>
int main()
{
  char* s = &quot;executable.exe&quot;;
  char* suffix = &quot;exe&quot;;

  const int N = strlen(s);
  const int N_suf = strlen(suffix);

  char* location = find_end(s, s + N,
                            suffix, suffix + N_suf);

  if (location != s + N) {
    cout &lt;&lt; &quot;Found a match for &quot; &lt;&lt; suffix &lt;&lt; &quot; within &quot; &lt;&lt; s &lt;&lt; endl;
    cout &lt;&lt; s &lt;&lt; endl;

    int i;
    for (i = 0; i &lt; (location - s); ++i)
      cout &lt;&lt; ' ';
    for (i = 0; i &lt; N_suf; ++i)
      cout &lt;&lt; '^';
    cout &lt;&lt; endl;
  }
  else
    cout &lt;&lt; &quot;No match for &quot; &lt;&lt; suffix &lt;&lt; &quot; within &quot; &lt;&lt; s &lt;&lt; endl;
}
</pre>
<h3>Notes</h3>
<P><A name="1">[1]</A>
The reason that this range is  <tt>[first1, last1 - (last2 - first2))</tt>,
instead of simply <tt>[first1, last1)</tt>, is that we are looking for a
subsequence that is equal to the <i>complete</i> sequence <tt>[first2,
last2)</tt>.  An iterator <tt>i</tt> can't be the beginning of such a subsequence
unless <tt>last1 - i</tt> is greater than or equal to <tt>last2 - first2</tt>.
Note the implication of this: you may call <tt>find_end</tt> with arguments
such that <tt>last1 - first1</tt> is less than <tt>last2 - first2</tt>, but such a
search will always fail.
<h3>See also</h3>
<tt><A href="search.html">search</A></tt>

<!--start footer--> 
<HR SIZE="6">
<A href="http://www.sgi.com/"><IMG SRC="surf.gif" HEIGHT="54" WIDTH="54" 
        ALT="[Silicon Surf]"></A>
<A HREF="index.html"><IMG SRC="stl_home.gif" 
        HEIGHT="54" WIDTH="54" ALT="[STL Home]"></A>
<BR>
<FONT SIZE="-2">
<A href="http://www.sgi.com/Misc/sgi_info.html" TARGET="_top">Copyright &copy; 
1996 Silicon Graphics, Inc.</A> All Rights Reserved.</FONT>
<FONT SIZE="-3"><a href="http://www.sgi.com/Misc/external.list.html" TARGET="_top">TrademarkInformation</A>
</FONT>
<P>
</BODY>
</HTML>