File: itkLevelOrderTreeIterator.h

package info (click to toggle)
insighttoolkit5 5.4.5-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 704,588 kB
  • sloc: cpp: 784,579; ansic: 628,724; xml: 44,704; fortran: 34,250; python: 22,934; sh: 4,078; pascal: 2,636; lisp: 2,158; makefile: 461; yacc: 328; asm: 205; perl: 203; lex: 146; tcl: 132; javascript: 98; csh: 81
file content (120 lines) | stat: -rw-r--r-- 3,168 bytes parent folder | download | duplicates (2)
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
/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         https://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef itkLevelOrderTreeIterator_h
#define itkLevelOrderTreeIterator_h

#include <queue>
#include <climits>
#include "itkTreeIteratorBase.h"

namespace itk
{
/**
 * \class LevelOrderTreeIterator
 * \brief Iterate over a tree in level order.
 *
 * \ingroup ITKDeprecated
 */
template <typename TTreeType>
class ITK_TEMPLATE_EXPORT LevelOrderTreeIterator : public TreeIteratorBase<TTreeType>
{
public:
  /** Typedefs */
  using Self = LevelOrderTreeIterator;
  using Superclass = TreeIteratorBase<TTreeType>;
  using TreeType = TTreeType;
  using ValueType = typename TTreeType::ValueType;
  using typename Superclass::TreeNodeType;
  using typename Superclass::NodeType;

  /** Constructor with end level specification */
  LevelOrderTreeIterator(TreeType * tree, int endLevel = INT_MAX, const TreeNodeType * start = nullptr);

  /** Constructor with end level specification. */
  LevelOrderTreeIterator(TreeType * tree, int startLevel, int endLevel, const TreeNodeType * start = nullptr);

  ~LevelOrderTreeIterator() override = default;

  /** Get the type of the iterator. */
  NodeType
  GetType() const override;

  /** Get the start level. */
  int
  GetStartLevel() const;

  /** Get the end level. */
  int
  GetEndLevel() const;

  /** Get the current level. */
  int
  GetLevel() const;

  /** Clone function. */
  TreeIteratorBase<TTreeType> *
  Clone() override;

  /** operator = */
  const Self &
  operator=(const Self & iterator)
  {
    if (this != &iterator)
    {
      this->Superclass::operator=(iterator);
      m_StartLevel = iterator.m_StartLevel;
      m_EndLevel = iterator.m_EndLevel;
      m_Queue = iterator.m_Queue;
    }
    return *this;
  }

protected:
  /** Get the next node. */
  const ValueType &
  Next() override;

  /** Return true if the next node exists. */
  bool
  HasNext() const override;

private:
  /** Find the next available node. */
  const TreeNodeType *
  FindNextNode() const;

  /** Helper function to find the next node. */
  const TreeNodeType *
  FindNextNodeHelp() const;

  /** Get the level given a node. */
  int
  GetLevel(const TreeNodeType * node) const;

  int                                      m_StartLevel{};
  int                                      m_EndLevel{};
  mutable std::queue<const TreeNodeType *> m_Queue{};
};

} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkLevelOrderTreeIterator.hxx"
#endif

#endif