DGtal  0.9.2
GraphVisitorRange.ih
1 /**
2  * This program is free software: you can redistribute it and/or modify
3  * it under the terms of the GNU Lesser General Public License as
4  * published by the Free Software Foundation, either version 3 of the
5  * License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program. If not, see <http://www.gnu.org/licenses/>.
14  *
15  **/
16 
17 /**
18  * @file GraphVisitorRange.ih
19  * @author Jacques-Olivier Lachaud (\c jacques-olivier.lachaud@univ-savoie.fr )
20  * Laboratory of Mathematics (CNRS, UMR 5127), University of Savoie, France
21  *
22  * @date 2013/01/31
23  *
24  * Implementation of inline methods defined in GraphVisitorRange.h
25  *
26  * This file is part of the DGtal library.
27  */
28 
29 
30 //////////////////////////////////////////////////////////////////////////////
31 #include <cstdlib>
32 //////////////////////////////////////////////////////////////////////////////
33 
34 ///////////////////////////////////////////////////////////////////////////////
35 // IMPLEMENTATION of inline methods.
36 ///////////////////////////////////////////////////////////////////////////////
37 
38 ///////////////////////////////////////////////////////////////////////////////
39 // ----------------------- Standard services ------------------------------
40 
41 //-----------------------------------------------------------------------------
42 template <typename TGraphVisitor>
43 inline
44 DGtal::GraphVisitorRange<TGraphVisitor>::
45 ~GraphVisitorRange()
46 {
47 }
48 //-----------------------------------------------------------------------------
49 template <typename TGraphVisitor>
50 inline
51 DGtal::GraphVisitorRange<TGraphVisitor>::
52 GraphVisitorRange( GraphVisitor* visitorPtr )
53  : myVisitor( visitorPtr )
54 {
55  ASSERT( visitorPtr != 0 );
56 }
57 //-----------------------------------------------------------------------------
58 template <typename TGraphVisitor>
59 inline
60 typename DGtal::GraphVisitorRange<TGraphVisitor>::ConstIterator
61 DGtal::GraphVisitorRange<TGraphVisitor>::
62 begin() const
63 {
64  ASSERT( myVisitor.unique() );
65  return ConstIterator( myVisitor );
66 }
67 //-----------------------------------------------------------------------------
68 template <typename TGraphVisitor>
69 inline
70 typename DGtal::GraphVisitorRange<TGraphVisitor>::ConstIterator
71 DGtal::GraphVisitorRange<TGraphVisitor>::
72 end() const
73 {
74  return ConstIterator();
75 }
76 //-----------------------------------------------------------------------------
77 template <typename TGraphVisitor>
78 inline
79 typename DGtal::GraphVisitorRange<TGraphVisitor>::NodeConstIterator
80 DGtal::GraphVisitorRange<TGraphVisitor>::
81 beginNode() const
82 {
83  ASSERT( myVisitor.unique() );
84  return NodeConstIterator( myVisitor );
85 }
86 //-----------------------------------------------------------------------------
87 template <typename TGraphVisitor>
88 inline
89 typename DGtal::GraphVisitorRange<TGraphVisitor>::NodeConstIterator
90 DGtal::GraphVisitorRange<TGraphVisitor>::
91 endNode() const
92 {
93  return NodeConstIterator();
94 }
95 
96 ///////////////////////////////////////////////////////////////////////////////
97 // Interface - public :
98 
99 /**
100  * Writes/Displays the object on an output stream.
101  * @param out the output stream where the object is written.
102  */
103 template <typename TGraphVisitor>
104 inline
105 void
106 DGtal::GraphVisitorRange<TGraphVisitor>::selfDisplay ( std::ostream & out ) const
107 {
108  out << "[GraphVisitorRange in_traversal="
109  << ( myVisitor.unique() ? "no" : "yes" ) << " ]";
110 }
111 
112 /**
113  * Checks the validity/consistency of the object.
114  * @return 'true' if the object is valid, 'false' otherwise.
115  */
116 template <typename TGraphVisitor>
117 inline
118 bool
119 DGtal::GraphVisitorRange<TGraphVisitor>::isValid() const
120 {
121  return true;
122 }
123 
124 
125 
126 ///////////////////////////////////////////////////////////////////////////////
127 // Implementation of inline functions //
128 
129 template <typename TGraphVisitor>
130 inline
131 std::ostream&
132 DGtal::operator<< ( std::ostream & out,
133  const GraphVisitorRange<TGraphVisitor> & object )
134 {
135  object.selfDisplay( out );
136  return out;
137 }
138 
139 // //
140 ///////////////////////////////////////////////////////////////////////////////
141 
142