File: next_permutation.html

package info (click to toggle)
stl-manual 3.30-6
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 4,092 kB
  • ctags: 4,448
  • sloc: cpp: 17,845; ansic: 2,842; makefile: 41
file content (166 lines) | stat: -rw-r--r-- 7,180 bytes parent folder | download | duplicates (7)
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
<HTML>
<!--
  -- Copyright (c) 1996-1999
  -- 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>next_permutation</Title>
<!-- Generated by htmldoc -->
</HEAD>
<BODY BGCOLOR="#ffffff" LINK="#0000ee" TEXT="#000000" VLINK="#551a8b" 
	ALINK="#ff0000"> 
<IMG SRC="CorpID.gif" 
     ALT="SGI" HEIGHT="43" WIDTH="151"> 
<!--end header-->
<BR Clear>
<H1>next_permutation</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>Next_permutation</tt> is an overloaded name; there are actually two <tt>next_permutation</tt>
functions.
<pre>
template &lt;class <A href="BidirectionalIterator.html">BidirectionalIterator</A>&gt;
bool next_permutation(BidirectionalIterator first,
                      BidirectionalIterator last);

template &lt;class <A href="BidirectionalIterator.html">BidirectionalIterator</A>, class <A href="StrictWeakOrdering.html">StrictWeakOrdering</A>&gt;
bool next_permutation(BidirectionalIterator first, BidirectionalIterator last,
                      <A href="StrictWeakOrdering.html">StrictWeakOrdering</A> comp);
</pre>                   
<h3>Description</h3>
<tt>Next_permutation</tt> transforms the range of elements <tt>[first, last)</tt>
into the lexicographically next greater permutation of the elements.
There is a finite number of distinct permutations (at most
<tt>N!</tt> <A href="#1">[1]</A>, where <tt>N</tt> is <tt>last - first</tt>), so, if the permutations are
ordered by <tt><A href="lexicographical_compare.html">lexicographical_compare</A></tt>, there is an unambiguous
definition of which permutation is lexicographically next.  If such
a permutation exists, <tt>next_permutation</tt> transforms <tt>[first, last)</tt>
into that permutation and returns <tt>true</tt>.  Otherwise it transforms
<tt>[first, last)</tt> into the lexicographically smallest permutation <A href="#2">[2]</A>
and returns <tt>false</tt>.  
<P>
The postcondition is that the new permutation of elements is
lexicographically greater than the old (as determined by
<tt><A href="lexicographical_compare.html">lexicographical_compare</A></tt>) if and only if the return value is
<tt>true</tt>.
<P>
The two versions of <tt>next_permutation</tt> differ in how they define
whether one element is less than another.  The first version 
compares objects using <tt>operator&lt;</tt>, and the second compares objects
using a <A href="functors.html">function object</A> <tt>comp</tt>.
<h3>Definition</h3>
Defined in the standard header <A href="algorithm">algorithm</A>, and in the nonstandard
backward-compatibility header <A href="algo.h">algo.h</A>.
<h3>Requirements on types</h3>
For the first version, the one that takes two arguments:
<UL>
<LI>
<tt>BidirectionalIterator</tt> is a model of <A href="BidirectionalIterator.html">Bidirectional Iterator</A>.
<LI>
<tt>BidirectionalIterator</tt> is mutable.
<LI>
<tt>BidirectionalIterator</tt>'s value type is <A href="LessThanComparable.html">LessThan Comparable</A>.
<LI>
The ordering relation on <tt>BidirectionalIterator</tt>'s value type is
   a <i>strict weak ordering</i>, as defined in the <A href="LessThanComparable.html">LessThan Comparable</A>
   requirements.
</UL>
For the second version, the one that takes three arguments:
<UL>
<LI>
<tt>BidirectionalIterator</tt> is a model of <A href="BidirectionalIterator.html">Bidirectional Iterator</A>.
<LI>
<tt>BidirectionalIterator</tt> is mutable.
<LI>
<tt>StrictWeakOrdering</tt> is a model of <A href="StrictWeakOrdering.html">Strict Weak Ordering</A>.
<LI>
<tt>BidirectionalIterator</tt>'s value type is convertible to
   <tt>StrictWeakOrdering</tt>'s argument type.
</UL>
<h3>Preconditions</h3>
<UL>
<LI>
<tt>[first, last)</tt> is a valid range.
</UL>
<h3>Complexity</h3>
Linear.  At most <tt>(last - first) / 2</tt> swaps.
<h3>Example</h3>
This example uses <tt>next_permutation</tt> to implement the worst known
deterministic sorting algorithm.  Most sorting algorithms are 
<tt>O(N log(N))</tt>, and even bubble sort is only 
<tt>O(N^2)</tt>.  This algorithm is actually <tt>O(N!)</tt>.
<pre>
template &lt;class BidirectionalIterator&gt; 
void snail_sort(BidirectionalIterator first, BidirectionalIterator last)
{
  while (next_permutation(first, last)) {}
}

int main()
{
  int A[] = {8, 3, 6, 1, 2, 5, 7, 4};
  const int N = sizeof(A) / sizeof(int);

  snail_sort(A, A+N);
  <A href="copy.html">copy</A>(A, A+N, <A href="ostream_iterator.html">ostream_iterator</A>&lt;int&gt;(cout, &quot;\n&quot;));
}
</pre>
<h3>Notes</h3>
<P><A name="1">[1]</A>
If all of the elements in <tt>[first, last)</tt> are distinct from each
other, then there are exactly <tt>N!</tt> permutations.  If some elements are
the same as each other, though, then there are fewer.  There are, for
example, only three (<tt>3!/2!</tt>) permutations of the elements <tt>1 1 2</tt>.
<P><A name="2">[2]</A>
Note that the lexicographically smallest permutation is, by
definition, sorted in nondecreasing order.
<h3>See also</h3>
<tt><A href="prev_permutation.html">prev_permutation</A></tt>, <tt><A href="lexicographical_compare.html">lexicographical_compare</A></tt>, 
<A href="LessThanComparable.html">LessThan Comparable</A>, <A href="StrictWeakOrdering.html">Strict Weak Ordering</A>, <tt><A href="sort.html">sort</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; 
1999 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>