Relationship.h

Go to the documentation of this file.

/*
 * LSST Data Management System
 * Copyright 2014-2016 AURA/LSST.
 *
 * This product includes software developed by the
 * LSST Project (http://www.lsst.org/).
 *
 * 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 3 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 LSST License Statement and
 * the GNU General Public License along with this program.  If not,
 * see <https://www.lsstcorp.org/LegalNotices/>.
 */

#ifndef LSST_SPHGEOM_RELATIONSHIP_H_
#define LSST_SPHGEOM_RELATIONSHIP_H_

#include <bitset>


namespace lsst {
namespace sphgeom {

using Relationship = std::bitset<3>;

static constexpr Relationship DISJOINT(1);

static constexpr Relationship INTERSECTS(0);

static constexpr Relationship CONTAINS(2);

static constexpr Relationship WITHIN(4);

inline Relationship invert(Relationship r) {
    // If A is disjoint from B, then B is disjoint from A. But if A contains B
    // then B is within A, so the corresponding bits must be swapped.
    return (r & DISJOINT) | ((r & CONTAINS) << 1) | ((r & WITHIN) >> 1);
}

}} // namespace lsst::sphgeom

#endif // LSST_SPHGEOM_RELATIONSHIP_H_