lsst.sphgeom gbd998247f1+585e252eca
Loading...
Searching...
No Matches
Relationship.h
Go to the documentation of this file.
1/*
2 * This file is part of sphgeom.
3 *
4 * Developed for the LSST Data Management System.
5 * This product includes software developed by the LSST Project
6 * (http://www.lsst.org).
7 * See the COPYRIGHT file at the top-level directory of this distribution
8 * for details of code ownership.
9 *
10 * This software is dual licensed under the GNU General Public License and also
11 * under a 3-clause BSD license. Recipients may choose which of these licenses
12 * to use; please see the files gpl-3.0.txt and/or bsd_license.txt,
13 * respectively. If you choose the GPL option then the following text applies
14 * (but note that there is still no warranty even if you opt for BSD instead):
15 *
16 * This program is free software: you can redistribute it and/or modify
17 * it under the terms of the GNU General Public License as published by
18 * the Free Software Foundation, either version 3 of the License, or
19 * (at your option) any later version.
20 *
21 * This program is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 * GNU General Public License for more details.
25 *
26 * You should have received a copy of the GNU General Public License
27 * along with this program. If not, see <http://www.gnu.org/licenses/>.
28 */
29
30#ifndef LSST_SPHGEOM_RELATIONSHIP_H_
31#define LSST_SPHGEOM_RELATIONSHIP_H_
32
33#include <bitset>
34
37
38namespace lsst {
39namespace sphgeom {
40
42using Relationship = std::bitset<3>;
43
45static constexpr Relationship DISJOINT(1);
46
51static constexpr Relationship INTERSECTS(0);
52
54static constexpr Relationship CONTAINS(2);
55
57static constexpr Relationship WITHIN(4);
58
63 // If A is disjoint from B, then B is disjoint from A. But if A contains B
64 // then B is within A, so the corresponding bits must be swapped.
65 return (r & DISJOINT) | ((r & CONTAINS) << 1) | ((r & WITHIN) >> 1);
66}
67
68}} // namespace lsst::sphgeom
69
70#endif // LSST_SPHGEOM_RELATIONSHIP_H_
Relationship invert(Relationship r)
Definition Relationship.h:62
std::bitset< 3 > Relationship
Relationship describes how two sets are related.
Definition Relationship.h:42