1 <!-- Copyright 2008 Lubomir Bourdev and Hailin Jin
3 Distributed under the Boost Software License, Version 1.0.
4 (See accompanying file LICENSE_1_0.txt or copy at
5 http://www.boost.org/LICENSE_1_0.txt)
9 Copyright 2005-2007 Adobe Systems Incorporated
10 Distributed under the MIT License (see accompanying file LICENSE_1_0_0.txt
11 or a copy at http://stlab.adobe.com/licenses.html)
13 Some files are held under additional license.
14 Please see "http://stlab.adobe.com/licenses.html" for more information.
17 <!DOCTYPE html PUBLIC
"-//W3C//DTD XHTML 1.0 Transitional//EN"
18 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
19 <html xmlns=
"http://www.w3.org/1999/xhtml" lang=
"en" xml:
lang=
"en">
22 <TITLE>Generic Image Library: iterator_from_2d Class Template Reference
</TITLE>
23 <META HTTP-EQUIV=
"content-type" CONTENT=
"text/html;charset=ISO-8859-1"/>
24 <LINK TYPE=
"text/css" REL=
"stylesheet" HREF=
"adobe_source.css"/>
27 <table border=
"0" cellspacing=
"0" cellpadding=
"0" style='width:
100%; margin:
0; padding:
0'
><tr>
28 <td width=
"100%" valign=
"top" style='padding-left:
10px; padding-right:
10px; padding-bottom:
10px'
>
29 <div class=
"qindex"><a class=
"qindex" href=
"index.html">Modules
</a>
30 |
<a class=
"qindex" href=
"classes.html">Alphabetical List
</a>
31 |
<a class=
"qindex" href=
"annotated.html">Class List
</a>
32 |
<a class=
"qindex" href=
"dirs.html">Directories
</a>
33 |
<a class=
"qindex" href=
"files.html">File List
</a>
34 |
<a class=
"qindex" href=
"../index.html">GIL Home Page
</a>
37 <!-- Generated by Doxygen 1.5.6 -->
38 <div class=
"navpath"><a class=
"el" href=
"namespaceboost.html">boost
</a>::
<b>gil
</b>::
<a class=
"el" href=
"g_i_l_0042.html">iterator_from_2d
</a>
40 <div class=
"contents">
41 <h1>iterator_from_2d Class Template Reference
<br>
43 [
<a class=
"el" href=
"g_i_l_0195.html">iterator_from_2d
</a>,
<a class=
"el" href=
"g_i_l_0182.html">Models
</a>]
</small>
44 </h1><!-- doxytag: class="boost::gil::iterator_from_2d" --><code>#include
<<a class=
"el" href=
"g_i_l_0229.html">iterator_from_2d.hpp
</a>></code>
48 <a href=
"g_i_l_0041.html">List of all members.
</a><hr><a name=
"_details"></a><h2>Detailed Description
</h2>
49 <h3>template
<typename Loc2
><br>
50 class boost::gil::iterator_from_2d
< Loc2
></h3>
52 Provides
1D random-access navigation to the pixels of the
<a class=
"el" href=
"g_i_l_0038.html" title=
"container interface over image view. Models ImageConcept, PixelBasedConcept">image
</a>. Models:
<a class=
"el" href=
"g_i_l_0352.html" title=
"An STL random access traversal iterator over a model of PixelConcept.">PixelIteratorConcept
</a>,
<a class=
"el" href=
"g_i_l_0344.html" title=
"Concept for all pixel-based GIL constructs, such as pixels, iterators, locators,...">PixelBasedConcept
</a>,
<a class=
"el" href=
"g_i_l_0290.html" title=
"Concept for iterators, locators and views that can define a type just like the given...">HasDynamicXStepTypeConcept
</a>.
54 Pixels are traversed from the top to the bottom row and from the left to the right within each row
<table border=
"0" cellpadding=
"0" cellspacing=
"0">
56 <tr><td colspan=
"2"><br><h2>Public Types
</h2></td></tr>
57 <tr><td class=
"memItemLeft" nowrap
align=
"right" valign=
"top"><a class=
"anchor" name=
"1b4bb84b55643493877c2ee963f64b2c"></a><!-- doxytag: member="boost::gil::iterator_from_2d::parent_t" ref="1b4bb84b55643493877c2ee963f64b2c" args="" -->
58 typedef iterator_facade
<br>
59 < <a class=
"el" href=
"g_i_l_0042.html">iterator_from_2d
</a>< Loc2
><br>
60 , typename Loc2::value_type,
<br>
61 random_access_traversal_tag,
<br>
62 typename Loc2::reference,
<br>
63 typename Loc2::coord_t
> </td><td class=
"memItemRight" valign=
"bottom"><b>parent_t
</b></td></tr>
65 <tr><td class=
"memItemLeft" nowrap
align=
"right" valign=
"top"><a class=
"anchor" name=
"6c80bdd4dcae459dd371e3d941b83468"></a><!-- doxytag: member="boost::gil::iterator_from_2d::reference" ref="6c80bdd4dcae459dd371e3d941b83468" args="" -->
66 typedef parent_t::reference
</td><td class=
"memItemRight" valign=
"bottom"><b>reference
</b></td></tr>
68 <tr><td class=
"memItemLeft" nowrap
align=
"right" valign=
"top"><a class=
"anchor" name=
"af1864eda36a1748894be741b3d64bde"></a><!-- doxytag: member="boost::gil::iterator_from_2d::difference_type" ref="af1864eda36a1748894be741b3d64bde" args="" -->
69 typedef parent_t::difference_type
</td><td class=
"memItemRight" valign=
"bottom"><b>difference_type
</b></td></tr>
71 <tr><td class=
"memItemLeft" nowrap
align=
"right" valign=
"top"><a class=
"anchor" name=
"1f14d8ca8049b9d8110bc78465353d61"></a><!-- doxytag: member="boost::gil::iterator_from_2d::x_iterator" ref="1f14d8ca8049b9d8110bc78465353d61" args="" -->
72 typedef Loc2::x_iterator
</td><td class=
"memItemRight" valign=
"bottom"><b>x_iterator
</b></td></tr>
74 <tr><td class=
"memItemLeft" nowrap
align=
"right" valign=
"top"><a class=
"anchor" name=
"7c16f36ca14e1a4bb735d453aeb5d7b5"></a><!-- doxytag: member="boost::gil::iterator_from_2d::point_t" ref="7c16f36ca14e1a4bb735d453aeb5d7b5" args="" -->
75 typedef Loc2::point_t
</td><td class=
"memItemRight" valign=
"bottom"><b>point_t
</b></td></tr>
77 <tr><td colspan=
"2"><br><h2>Public Member Functions
</h2></td></tr>
78 <tr><td class=
"memItemLeft" nowrap
align=
"right" valign=
"top"><a class=
"anchor" name=
"379c24f2d0a75769afc06dff7b569b8f"></a><!-- doxytag: member="boost::gil::iterator_from_2d::width" ref="379c24f2d0a75769afc06dff7b569b8f" args="() const " -->
79 std::ptrdiff_t
</td><td class=
"memItemRight" valign=
"bottom"><b>width
</b> () const
</td></tr>
81 <tr><td class=
"memItemLeft" nowrap
align=
"right" valign=
"top"><a class=
"anchor" name=
"cb3204f0b17472894a99939821d597be"></a><!-- doxytag: member="boost::gil::iterator_from_2d::x_pos" ref="cb3204f0b17472894a99939821d597be" args="() const " -->
82 std::ptrdiff_t
</td><td class=
"memItemRight" valign=
"bottom"><b>x_pos
</b> () const
</td></tr>
84 <tr><td class=
"memItemLeft" nowrap
align=
"right" valign=
"top"><a class=
"anchor" name=
"0cc719b54aea5b1b8650f38c5eba9d45"></a><!-- doxytag: member="boost::gil::iterator_from_2d::y_pos" ref="0cc719b54aea5b1b8650f38c5eba9d45" args="() const " -->
85 std::ptrdiff_t
</td><td class=
"memItemRight" valign=
"bottom"><b>y_pos
</b> () const
</td></tr>
87 <tr><td class=
"memItemLeft" nowrap
align=
"right" valign=
"top">reference
</td><td class=
"memItemRight" valign=
"bottom"><a class=
"el" href=
"g_i_l_0042.html#de1279c4ed222b6efb0867c038765ea1">operator[]
</a> (difference_type d) const
</td></tr>
89 <tr><td class=
"memItemLeft" nowrap
align=
"right" valign=
"top"><a class=
"anchor" name=
"90ccf75aa2deb01fbce509842191cad2"></a><!-- doxytag: member="boost::gil::iterator_from_2d::is_1d_traversable" ref="90ccf75aa2deb01fbce509842191cad2" args="() const " -->
90 bool
</td><td class=
"memItemRight" valign=
"bottom"><b>is_1d_traversable
</b> () const
</td></tr>
92 <tr><td class=
"memItemLeft" nowrap
align=
"right" valign=
"top"><a class=
"anchor" name=
"72169bdc650ac7eda288398e4ce1d7f8"></a><!-- doxytag: member="boost::gil::iterator_from_2d::x" ref="72169bdc650ac7eda288398e4ce1d7f8" args="()" -->
93 x_iterator
& </td><td class=
"memItemRight" valign=
"bottom"><b>x
</b> ()
</td></tr>
95 <tr><td class=
"memItemLeft" nowrap
align=
"right" valign=
"top"><a class=
"anchor" name=
"45df0fa110e66d8fb30cb24c1dd56266"></a><!-- doxytag: member="boost::gil::iterator_from_2d::iterator_from_2d" ref="45df0fa110e66d8fb30cb24c1dd56266" args="(const Loc2 &p, std::ptrdiff_t width, std::ptrdiff_t x=0, std::ptrdiff_t y=0)" -->
96 </td><td class=
"memItemRight" valign=
"bottom"><b>iterator_from_2d
</b> (const Loc2
&p, std::ptrdiff_t width, std::ptrdiff_t x=
0, std::ptrdiff_t y=
0)
</td></tr>
98 <tr><td class=
"memItemLeft" nowrap
align=
"right" valign=
"top"><a class=
"anchor" name=
"cb7687c40d4a935c63ac210d97c22aa4"></a><!-- doxytag: member="boost::gil::iterator_from_2d::iterator_from_2d" ref="cb7687c40d4a935c63ac210d97c22aa4" args="(const iterator_from_2d &pit)" -->
99 </td><td class=
"memItemRight" valign=
"bottom"><b>iterator_from_2d
</b> (const
<a class=
"el" href=
"g_i_l_0042.html">iterator_from_2d
</a> &pit)
</td></tr>
101 <tr><td class=
"memTemplParams" nowrap
colspan=
"2"><a class=
"anchor" name=
"d4f1b6e1c89a7fae91557a16fb27e1af"></a><!-- doxytag: member="boost::gil::iterator_from_2d::iterator_from_2d" ref="d4f1b6e1c89a7fae91557a16fb27e1af" args="(const iterator_from_2d< Loc > &pit)" -->
102 template
<typename Loc
> </td></tr>
103 <tr><td class=
"memTemplItemLeft" nowrap
align=
"right" valign=
"top"> </td><td class=
"memTemplItemRight" valign=
"bottom"><b>iterator_from_2d
</b> (const
<a class=
"el" href=
"g_i_l_0042.html">iterator_from_2d
</a>< Loc
> &pit)
</td></tr>
105 <tr><td colspan=
"2"><br><h2>Friends
</h2></td></tr>
106 <tr><td class=
"memItemLeft" nowrap
align=
"right" valign=
"top"><a class=
"anchor" name=
"5a1cb889c68b7d25cfc8b22e9b156142"></a><!-- doxytag: member="boost::gil::iterator_from_2d::iterator_from_2d" ref="5a1cb889c68b7d25cfc8b22e9b156142" args="" -->
107 class
</td><td class=
"memItemRight" valign=
"bottom"><b>iterator_from_2d
</b></td></tr>
109 <tr><td class=
"memItemLeft" nowrap
align=
"right" valign=
"top"><a class=
"anchor" name=
"c09f73e325921cc50ebcd96bed0f8096"></a><!-- doxytag: member="boost::gil::iterator_from_2d::boost::iterator_core_access" ref="c09f73e325921cc50ebcd96bed0f8096" args="" -->
110 class
</td><td class=
"memItemRight" valign=
"bottom"><b>boost::iterator_core_access
</b></td></tr>
113 <hr><h2>Member Function Documentation
</h2>
114 <a class=
"anchor" name=
"de1279c4ed222b6efb0867c038765ea1"></a><!-- doxytag: member="boost::gil::iterator_from_2d::operator[]" ref="de1279c4ed222b6efb0867c038765ea1" args="(difference_type d) const " -->
115 <div class=
"memitem">
116 <div class=
"memproto">
117 <table class=
"memname">
119 <td class=
"memname">reference operator[]
</td>
121 <td class=
"paramtype">difference_type
</td>
122 <td class=
"paramname"> <em>d
</em> </td>
123 <td> )
</td>
124 <td> const
<code> [inline]
</code></td>
131 For some reason operator[] provided by iterator_adaptor returns a custom class that is convertible to reference We require our own reference because it is registered in iterator_traits
134 <hr>The documentation for this class was generated from the following file:
<ul>
135 <li><a class=
"el" href=
"g_i_l_0229.html">iterator_from_2d.hpp
</a></ul>
137 <hr size=
"1"><address style=
"text-align: right;"><small>Generated on Sat May
2 13:
50:
18 2009 for Generic Image Library by
138 <a href=
"http://www.doxygen.org/index.html">
139 <img src=
"doxygen.png" alt=
"doxygen" align=
"middle" border=
"0"></a> 1.5.6 </small></address>