annotate OrthancStone/Sources/Toolbox/SegmentTree.h @ 1873:e0966648ebd0

unit tests of SegmentTree
author Sebastien Jodogne <s.jodogne@gmail.com>
date Tue, 11 Jan 2022 15:36:04 +0100
parents db8a8a19b543
children 07964689cb0b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1872
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Stone of Orthanc
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5 * Copyright (C) 2017-2022 Osimis S.A., Belgium
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 * Copyright (C) 2021-2022 Sebastien Jodogne, ICTEAM UCLouvain, Belgium
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 *
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * This program is free software: you can redistribute it and/or
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * modify it under the terms of the GNU Lesser General Public License
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * as published by the Free Software Foundation, either version 3 of
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 * the License, or (at your option) any later version.
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 *
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * This program is distributed in the hope that it will be useful, but
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * Lesser General Public License for more details.
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 *
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * You should have received a copy of the GNU Lesser General Public
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 * License along with this program. If not, see
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 * <http://www.gnu.org/licenses/>.
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 **/
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 #pragma once
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 #include <Compatibility.h>
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 #include <IDynamicObject.h>
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 namespace OrthancStone
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 {
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 /**
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32 * This implementation of segment trees closely follows Section
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 * 1.2.3.1 (pages 13-15) of "Computational Geometry - An
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 * Introduction" by Preparata and Ian Shamos (1985).
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 **/
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 class SegmentTree : public boost::noncopyable
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 {
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 public:
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 class IPayloadFactory : public boost::noncopyable
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 {
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 public:
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 virtual ~IPayloadFactory()
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 {
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 }
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 virtual Orthanc::IDynamicObject* Create() = 0;
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 };
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50 class IVisitor : public boost::noncopyable
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51 {
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52 public:
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53 virtual ~IVisitor()
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 {
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55 }
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56
1873
e0966648ebd0 unit tests of SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1872
diff changeset
57 // "fullyInside" is true iff. the segment of "node" is fully
e0966648ebd0 unit tests of SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1872
diff changeset
58 // inside the user-provided segment
1872
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59 virtual void Visit(const SegmentTree& node,
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60 bool fullyInside) = 0;
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61 };
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63 private:
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64 size_t lowBound_;
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65 size_t highBound_;
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66 std::unique_ptr<SegmentTree> left_;
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
67 std::unique_ptr<SegmentTree> right_;
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
68 std::unique_ptr<Orthanc::IDynamicObject> payload_;
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70 public:
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71 SegmentTree(size_t lowBound,
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
72 size_t highBound,
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
73 IPayloadFactory& factory);
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
74
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
75 size_t GetLowBound() const
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
76 {
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
77 return lowBound_;
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
78 }
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
79
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80 size_t GetHighBound() const
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
81 {
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
82 return highBound_;
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
83 }
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
84
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
85 bool IsLeaf() const
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
86 {
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87 return left_.get() == NULL;
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88 }
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
90 Orthanc::IDynamicObject& GetPayload() const;
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
91
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
92 template <typename T>
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
93 T& GetTypedPayload() const
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
94 {
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
95 return dynamic_cast<T&>(GetPayload());
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
96 }
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
97
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
98 SegmentTree& GetLeftChild() const;
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
99
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
100 SegmentTree& GetRightChild() const;
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
101
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
102 size_t CountNodes() const;
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
103
1873
e0966648ebd0 unit tests of SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1872
diff changeset
104 /**
e0966648ebd0 unit tests of SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1872
diff changeset
105 * Apply the given visitor to all the segments that intersect the
e0966648ebd0 unit tests of SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1872
diff changeset
106 * [low,high] segment. This corresponds to both methods "INSERT()"
e0966648ebd0 unit tests of SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1872
diff changeset
107 * and "DELETE()" from the reference textbook.
e0966648ebd0 unit tests of SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1872
diff changeset
108 **/
e0966648ebd0 unit tests of SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1872
diff changeset
109 void VisitSegment(size_t low,
e0966648ebd0 unit tests of SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1872
diff changeset
110 size_t high,
e0966648ebd0 unit tests of SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1872
diff changeset
111 IVisitor& visitor) const;
e0966648ebd0 unit tests of SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1872
diff changeset
112
e0966648ebd0 unit tests of SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1872
diff changeset
113 // For unit tests
e0966648ebd0 unit tests of SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1872
diff changeset
114 const SegmentTree* FindLeaf(size_t low) const;
e0966648ebd0 unit tests of SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1872
diff changeset
115
e0966648ebd0 unit tests of SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1872
diff changeset
116 // For unit tests
e0966648ebd0 unit tests of SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1872
diff changeset
117 const SegmentTree* FindNode(size_t low,
e0966648ebd0 unit tests of SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1872
diff changeset
118 size_t high) const;
1872
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
119 };
db8a8a19b543 SegmentTree
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
120 }