DGtal 1.4.2
Loading...
Searching...
No Matches
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//-----------------------------------------------------------------------------
42template <typename TGraphVisitor>
43inline
44DGtal::GraphVisitorRange<TGraphVisitor>::
45~GraphVisitorRange()
46{
47}
48//-----------------------------------------------------------------------------
49template <typename TGraphVisitor>
50inline
51DGtal::GraphVisitorRange<TGraphVisitor>::
52GraphVisitorRange( GraphVisitor* visitorPtr )
53 : myVisitor( visitorPtr )
54{
55 ASSERT( visitorPtr != 0 );
56}
57//-----------------------------------------------------------------------------
58template <typename TGraphVisitor>
59inline
60typename DGtal::GraphVisitorRange<TGraphVisitor>::ConstIterator
61DGtal::GraphVisitorRange<TGraphVisitor>::
62begin() const
63{
64 ASSERT( myVisitor.unique() );
65 return ConstIterator( myVisitor );
66}
67//-----------------------------------------------------------------------------
68template <typename TGraphVisitor>
69inline
70typename DGtal::GraphVisitorRange<TGraphVisitor>::ConstIterator
71DGtal::GraphVisitorRange<TGraphVisitor>::
72end() const
73{
74 return ConstIterator();
75}
76//-----------------------------------------------------------------------------
77template <typename TGraphVisitor>
78inline
79typename DGtal::GraphVisitorRange<TGraphVisitor>::NodeConstIterator
80DGtal::GraphVisitorRange<TGraphVisitor>::
81beginNode() const
82{
83 ASSERT( myVisitor.unique() );
84 return NodeConstIterator( myVisitor );
85}
86//-----------------------------------------------------------------------------
87template <typename TGraphVisitor>
88inline
89typename DGtal::GraphVisitorRange<TGraphVisitor>::NodeConstIterator
90DGtal::GraphVisitorRange<TGraphVisitor>::
91endNode() 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 */
103template <typename TGraphVisitor>
104inline
105void
106DGtal::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 */
116template <typename TGraphVisitor>
117inline
118bool
119DGtal::GraphVisitorRange<TGraphVisitor>::isValid() const
120{
121 return true;
122}
123
124
125
126///////////////////////////////////////////////////////////////////////////////
127// Implementation of inline functions //
128
129template <typename TGraphVisitor>
130inline
131std::ostream&
132DGtal::operator<< ( std::ostream & out,
133 const GraphVisitorRange<TGraphVisitor> & object )
134{
135 object.selfDisplay( out );
136 return out;
137}
138
139// //
140///////////////////////////////////////////////////////////////////////////////
141
142