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
|
/*
* LatticeMatch calculator - class used for angles
* Copyright (C) 2015 Andreas Grois
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
*
* A small class that deals with ranges of angles. Its members are two angles, maximum and minimum.
* The main purpose of this class is to provide an easy way to determine the overlap of two ranges.
* There is no support for disjoint ranges (yet).
* Probably that would better be left for a separate class anyhow. Think: vector of anglerange objects
*
* There is an important convention with this class:
* Ranges are always clockwise from the lower to the upper bound.
* They include the lower and the upper bound, as this is required to be able to contain individual points.
*
* This class is part of the LatticeMatch program.
*
* To contact the author either use electronic mail: Andreas Grois <andreas.grois@jku.at>
* or write to:
* Andreas Grois, Institute for Semiconductor and SolidState physics, Johannes Kepler University,
* Altenbergerstraße 69, 4040 Linz, AUSTRIA
*/
#ifndef ANGLERANGE_H
#define ANGLERANGE_H
#include "angleclass.h"
#include <stdexcept>
class anglerange
{
public:
typedef enum sorttype {SRT_LOWER,SRT_UPPER,SRT_SIZE} sorttype;
private:
angleclass lowerborder;
angleclass upperborder;
bool upperset;
bool lowerset;
bool fullcircle;
sorttype sortby; //for comparison operators
//default value: SRT_SIZE
//lower means sort by lower border, upper sort by upper border, and size sort by (upper-lower)
//only size cares about zero-crossing, the others just compare numeric values.
public:
//Default constructor: Both limits 0.0, marked as empty
anglerange();
anglerange(const angleclass &lower, const angleclass &upper);
void setlower(const angleclass &newlower);
void setupper(const angleclass &newupper);
void setempty(); //marks the range as empty.
//to change sort field
void setsorttype(const sorttype value);
const sorttype getsorttype();
bool isempty() const; //returns true when the range is empty (or when one limit isn't set)
angleclass getlower() const; //warning: Does not check if empty, does not check if circle
angleclass getupper() const; //warning: Does not check if empty, does not check if circle
bool isinside(const angleclass &val) const; //check if angleclas val is in the range.
//to deal with full circles:
void setcircle(bool value);
bool iscircle() const;
//this function calculates the overlap between this anglerange and another one, returning it as
//a new anglerange.
anglerange overlap(const anglerange &other);
//this function does the opposite of overlap: Both ranges are combined into one bigger range.
//if they are disjoint, an empty range is given back.
anglerange combine(const anglerange &other);
bool operator<(const anglerange &other) const;
bool operator>(const anglerange &other) const;
bool operator<=(const anglerange &other) const;
bool operator>=(const anglerange &other) const;
//these operators don't use sort order. They really compare by element!
//also: Two empty ranges are considered equal!
bool operator==(const anglerange &other) const;
bool operator!=(const anglerange &other) const;
};
#endif // ANGLERANGE_H
|
