Extent.cc

Go to the documentation of this file.

/*
 * Developed for the LSST Data Management System.
 * This product includes software developed by the LSST Project
 * (https://www.lsst.org).
 * See the COPYRIGHT file at the top-level directory of this distribution
 * for details of code ownership.
 *
 * 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 GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

#include "lsst/utils/hashCombine.h"
#include "lsst/geom/CoordinateBase.h"
#include "lsst/geom/Point.h"
#include "lsst/geom/Extent.h"

namespace lsst {
namespace geom {

template <typename T, int N>
Extent<T, N>::Extent(Point<T, N> const &other) noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
        : Super(other.asEigen()) {}

// The following two template specializations raise Doxygen warnings and produce no documenation.
// This is a known Doxygen bug: <https://bugzilla.gnome.org/show_bug.cgi?id=406027>
template <typename T>
Extent<T, 2>::Extent(Point<T, 2> const &other) noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
        : Super(other.asEigen()) {}

template <typename T>
Extent<T, 3>::Extent(Point<T, 3> const &other) noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE)
        : Super(other.asEigen()) {}

template <typename T, int N>
CoordinateExpr<N> ExtentBase<T, N>::eq(Extent<T, N> const &other) const noexcept {
    CoordinateExpr<N> r;
    for (int n = 0; n < N; ++n) r[n] = this->_vector[n] == other[n];
    return r;
}

template <typename T, int N>
CoordinateExpr<N> ExtentBase<T, N>::ne(Extent<T, N> const &other) const noexcept {
    CoordinateExpr<N> r;
    for (int n = 0; n < N; ++n) r[n] = this->_vector[n] != other[n];
    return r;
}

template <typename T, int N>
CoordinateExpr<N> ExtentBase<T, N>::lt(Extent<T, N> const &other) const noexcept {
    CoordinateExpr<N> r;
    for (int n = 0; n < N; ++n) r[n] = this->_vector[n] < other[n];
    return r;
}

template <typename T, int N>
CoordinateExpr<N> ExtentBase<T, N>::le(Extent<T, N> const &other) const noexcept {
    CoordinateExpr<N> r;
    for (int n = 0; n < N; ++n) r[n] = this->_vector[n] <= other[n];
    return r;
}

template <typename T, int N>
CoordinateExpr<N> ExtentBase<T, N>::gt(Extent<T, N> const &other) const noexcept {
    CoordinateExpr<N> r;
    for (int n = 0; n < N; ++n) r[n] = this->_vector[n] > other[n];
    return r;
}

template <typename T, int N>
CoordinateExpr<N> ExtentBase<T, N>::ge(Extent<T, N> const &other) const noexcept {
    CoordinateExpr<N> r;
    for (int n = 0; n < N; ++n) r[n] = this->_vector[n] >= other[n];
    return r;
}

template <typename T, int N>
Point<T, N> ExtentBase<T, N>::asPoint() const noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE) {
    return Point<T, N>(static_cast<Extent<T, N> const &>(*this));
}

template <typename T, int N>
Point<T, N> ExtentBase<T, N>::operator+(Point<T, N> const &other) const
        noexcept(Super::IS_ELEMENT_NOTHROW_COPYABLE) {
    return Point<T, N>(this->_vector + other.asEigen());
}

template <int N>
Extent<int, N> truncate(Extent<double, N> const &input) noexcept {
    Extent<int, N> result;
    for (int i = 0; i < N; ++i) {
        result[i] = static_cast<int>(input[i]);
    }
    return result;
}

template <int N>
Extent<int, N> floor(Extent<double, N> const &input) noexcept {
    Extent<int, N> result;
    for (int i = 0; i < N; ++i) {
        result[i] = std::floor(input[i]);
    }
    return result;
}

template <int N>
Extent<int, N> ceil(Extent<double, N> const &input) noexcept {
    Extent<int, N> result;
    for (int i = 0; i < N; ++i) {
        result[i] = std::ceil(input[i]);
    }
    return result;
}

template <typename T, int N>
std::size_t hash_value(Extent<T, N> const &extent) noexcept {
    std::size_t result = 0;     // Completely arbitrary seed
    for (int n = 0; n < N; ++n) result = utils::hashCombine(result, extent[n]);
    return result;
}

#ifndef DOXYGEN

template class ExtentBase<int, 2>;
template class ExtentBase<int, 3>;
template class ExtentBase<double, 2>;
template class ExtentBase<double, 3>;
template class Extent<int, 2>;
template class Extent<int, 3>;
template class Extent<double, 2>;
template class Extent<double, 3>;
template Extent<double, 2>::Extent(Extent<int, 2> const &);
template Extent<double, 3>::Extent(Extent<int, 3> const &);
template Extent<double, 2>::Extent(Point<int, 2> const &);
template Extent<double, 3>::Extent(Point<int, 3> const &);

template Extent<int, 2> truncate(Extent<double, 2> const &);
template Extent<int, 3> truncate(Extent<double, 3> const &);
template Extent<int, 2> floor(Extent<double, 2> const &);
template Extent<int, 3> floor(Extent<double, 3> const &);
template Extent<int, 2> ceil(Extent<double, 2> const &);
template Extent<int, 3> ceil(Extent<double, 3> const &);

template std::size_t hash_value(Extent<int, 2> const &extent) noexcept;
template std::size_t hash_value(Extent<int, 3> const &extent) noexcept;
template std::size_t hash_value(Extent<double, 2> const &extent) noexcept;
template std::size_t hash_value(Extent<double, 3> const &extent) noexcept;

#endif  // !DOXYGEN

}  // namespace geom
}  // namespace lsst