File: istream_iterator.html

package info (click to toggle)
stl-manual 3.30-9
links: PTS, VCS
area: main
in suites: lenny
size: 4,092 kB
ctags: 4,448
sloc: cpp: 17,845; ansic: 2,842; makefile: 41
file content (304 lines) | stat: -rw-r--r-- 7,860 bytes
parent folder | download | duplicates (6)
<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>istream_iterator&lt;T, Distance&gt;</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>istream_iterator&lt;T, Distance&gt;</H1>

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

<h3>Description</h3>
An <tt>istream_iterator</tt> is an <A href="InputIterator.html">Input Iterator</A> that performs formatted
input of objects of type <tt>T</tt> from a particular <tt>istream</tt>.  When end of
stream is reached, the <tt>istream_iterator</tt> takes on a special <i>end of
stream</i> value, which is a past-the-end iterator.  Note that all of the
restrictions of an <A href="InputIterator.html">Input Iterator</A> must be obeyed, including the
restrictions on the ordering of <tt>operator*</tt> and <tt>operator++</tt>
operations.
<h3>Example</h3>
Fill a <tt><A href="Vector.html">vector</A></tt> with values read from standard input.
<pre>
<A href="Vector.html">vector</A>&lt;int&gt; V;
<A href="copy.html">copy</A>(istream_iterator&lt;int&gt;(cin), istream_iterator&lt;int&gt;(),
     <A href="back_insert_iterator.html">back_inserter</A>(V));   
</pre>
<h3>Definition</h3>
Defined in the standard header <A href="iterator">iterator</A>, and in the nonstandard
backward-compatibility header <A href="iterator.h">iterator.h</A>.
<h3>Template parameters</h3>
<Table border>
<TR>
<TH>
Parameter
</TH>
<TH>
Description
</TH>
<TH>
Default
</TH>
</TR>
<TR>
<TD VAlign=top>
<tt>T</tt>
</TD>
<TD VAlign=top>
The <tt>istream_iterator</tt>'s value type.  <tt>Operator*</tt> returns a <tt>const T&amp;</tt>.
</TD>
<TD VAlign=top>
&nbsp;
</TD>
</TR>
<TR>
<TD VAlign=top>
<tt>Distance</tt>
</TD>
<TD VAlign=top>
The <tt>istream_iterator</tt>'s distance type.
</TD>
<TD VAlign=top>
<tt>ptrdiff_t</tt>
</TD>
</tr>
</table>
<h3>Model of</h3>
<A href="InputIterator.html">Input Iterator</A>
<h3>Type requirements</h3>
The value type <tt>T</tt> must be a type such that <tt>cin &gt;&gt; T</tt> is a 
valid expression.  
<P>
The value type <tt>T</tt> must be a model of <A href="DefaultConstructible.html">Default Constructible</A>.
<P>
The distance type must, as described in the
<A href="InputIterator.html">Input Iterator</A> requirements, be a signed integral type.
<h3>Public base classes</h3>
None.
<h3>Members</h3>
<Table border>
<TR>
<TH>
Member
</TH>
<TH>
Where defined
</TH>
<TH>
Description
</TH>
</TR>
<TR>
<TD VAlign=top>
<b><tt>istream_iterator</b>()</tt>
</TD>
<TD VAlign=top>
<tt>istream_iterator</tt>
</TD>
<TD VAlign=top>
See below.
</TD>
</TR>
<TR>
<TD VAlign=top>
<b><tt>istream_iterator</b>(istream&amp;)</tt>
</TD>
<TD VAlign=top>
<tt>istream_iterator</tt>
</TD>
<TD VAlign=top>
See below.
</TD>
</TR>
<TR>
<TD VAlign=top>
<b><tt>istream_iterator</b>(const istream_iterator&amp;)</tt>
</TD>
<TD VAlign=top>
 <A href="trivial.html">Trivial Iterator</A>
</TD>
<TD VAlign=top>
The copy constructor
</TD>
</TR>
<TR>
<TD VAlign=top>
<tt>istream_iterator&amp; <b>operator=</b>(const istream_iterator&amp;)</tt>
</TD>
<TD VAlign=top>
 <A href="trivial.html">Trivial Iterator</A>
</TD>
<TD VAlign=top>
The assignment operator
</TD>
</TR>
<TR>
<TD VAlign=top>
<tt>constT&amp; <b>operator*</b>() const</tt>
</TD>
<TD VAlign=top>
 <A href="InputIterator.html">Input Iterator</A>
</TD>
<TD VAlign=top>
Returns the next object in the stream.
</TD>
</TR>
<TR>
<TD VAlign=top>
<tt>istream_iterator&amp; <b>operator++</b>()</tt>
</TD>
<TD VAlign=top>
 <A href="InputIterator.html">Input Iterator</A>
</TD>
<TD VAlign=top>
Preincrement.
</TD>
</TR>
<TR>
<TD VAlign=top>
<tt>istream_iterator&amp; <b>operator++</b>(int)</tt>
</TD>
<TD VAlign=top>
 <A href="InputIterator.html">Input Iterator</A>
</TD>
<TD VAlign=top>
Postincrement.
</TD>
</TR>
<TR>
<TD VAlign=top>
<tt>bool <b>operator==</b>(const istream_iterator&amp;, const istream_iterator&amp;)</tt>
</TD>
<TD VAlign=top>
 <A href="trivial.html">Trivial iterator</A>
</TD>
<TD VAlign=top>
The equality operator.  This is a global function, not a member function.
</TD>
</TR>
<TR>
<TD VAlign=top>
<tt>input_iterator_tag <b>iterator_category</b>(const istream_iterator&amp;)</tt>
</TD>
<TD VAlign=top>
 <A href="iterator_tags.html">iterator tags</A>
</TD>
<TD VAlign=top>
Returns the iterator's category.
</TD>
</TR>
<TR>
<TD VAlign=top>
<tt>T* <b>value_type</b>(const istream_iterator&amp;)</tt>
</TD>
<TD VAlign=top>
 <A href="iterator_tags.html">iterator tags</A>
</TD>
<TD VAlign=top>
Returns the iterator's value type.
</TD>
</TR>
<TR>
<TD VAlign=top>
<tt>Distance* <b>distance_type</b>(const istream_iterator&amp;)</tt>
</TD>
<TD VAlign=top>
 <A href="iterator_tags.html">iterator tags</A>
</TD>
<TD VAlign=top>
Returns the iterator's distance type.
&lt;
</TD>
</tr>
</table>
<h3>New members</h3>
These members are not defined 
in the <A href="InputIterator.html">Input Iterator</A> requirements,
but are specific to <tt>istream_iterator</tt>.
<Table border>
<TR>
<TH>
Function
</TH>
<TH>
Description
</TH>
</TR>
<TR>
<TD VAlign=top>
<b><tt>istream_iterator</b>()</tt>
</TD>
<TD VAlign=top>
The default constructor:  Constructs an end-of-stream iterator.
   This is a past-the-end iterator, and it is useful when constructing
   a &quot;range&quot;.  
</TD>
</TR>
<TR>
<TD VAlign=top>
<b><tt>istream_iterator</b>(istream&amp; s)</tt>
</TD>
<TD VAlign=top>
Creates an <tt>istream_iterator</tt> that reads values from the input
   stream <tt>s</tt>.  When <tt>s</tt> reaches end of stream, this iterator will
   compare equal to an end-of-stream iterator created using the
   default constructor.
</TD>
</tr>
</table>
<h3>Notes</h3>
<h3>See also</h3>
<A href="ostream_iterator.html">ostream_iterator</A>, <A href="InputIterator.html">Input Iterator</A>, <A href="OutputIterator.html">Output Iterator</A>.

<!--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>