File: generate.html

package info (click to toggle)
stl-manual 3.30-4
  • links: PTS
  • area: main
  • in suites: sarge, woody
  • size: 4,088 kB
  • ctags: 4,449
  • sloc: cpp: 17,845; ansic: 2,842; makefile: 35
file content (121 lines) | stat: -rw-r--r-- 5,062 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
<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>generate</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>generate</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>
<pre>
template &lt;class <A href="ForwardIterator.html">ForwardIterator</A>, class <A href="Generator.html">Generator</A>&gt;
void generate(ForwardIterator first, ForwardIterator last, Generator gen);
</pre>                   
<h3>Description</h3>
<tt>Generate</tt> assigns the result of invoking <tt>gen</tt>, a <A href="functors.html">function object</A>
that takes no arguments, to each element in the range <tt>[first,
last)</tt>. <A href="#1">[1]</A>
<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>
<UL>
<LI>
<tt>ForwardIterator</tt> is a model of <A href="ForwardIterator.html">Forward Iterator</A>. <A href="#2">[2]</A>
<LI>
<tt>ForwardIterator</tt> is mutable.
<LI>
<tt>Generator</tt> is a model of <A href="Generator.html">Generator</A>.
<LI>
<tt>Generator</tt>'s result type is convertible to <tt>ForwardIterator</tt>'s
   value type.
</UL>
<h3>Preconditions</h3>
<UL>
<LI>
<tt>[first, last)</tt> is a valid range.
</UL>
<h3>Complexity</h3>
Linear.  Exactly <tt>last - first</tt> invocations of <tt>gen</tt>.  <A href="#1">[1]</A>
<h3>Example</h3>
Fill a vector with random numbers, using the standard C library function
<tt>rand</tt>.
<pre>
vector&lt;int&gt; V;
...
generate(V.begin(), V.end(), rand);
</pre>
<h3>Notes</h3>
<P><A name="1">[1]</A>
The <A href="functors.html">function object</A> <tt>gen</tt> is invoked for each iterator in
the range <tt>[first, last)</tt>, as opposed to just being invoked a
single time outside the loop.  This distinction is important
because a <A href="Generator.html">Generator</A> need not return the same result each time
it is invoked; it is permitted to read from a file, refer to and
modify local state, and so on.
<P><A name="2">[2]</A>
The reason that <tt>generate</tt> requires its argument to be a mutable
<A href="ForwardIterator.html">Forward Iterator</A>, rather than just an <A href="OutputIterator.html">Output Iterator</A>, is that 
it uses a range <tt>[first, last)</tt> of iterators.  There is no sensible
way to describe a range of <A href="OutputIterator.html">Output Iterators</A>, because it is
impossible to compare two <A href="OutputIterator.html">Output Iterators</A> for equality.
The <tt><A href="generate_n.html">generate_n</A></tt> algorithm does have an interface that permits use of
an <A href="OutputIterator.html">Output Iterator</A>.
<h3>See also</h3>
<tt><A href="copy.html">copy</A></tt>, <tt><A href="fill.html">fill</A></tt>, <tt><A href="fill_n.html">fill_n</A></tt>, <tt><A href="generate_n.html">generate_n</A></tt>, <tt><A href="iota.html">iota</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>