matrix3d.cc

Go to the documentation of this file.

/*
 * LSST Data Management System
 * See COPYRIGHT file at the top of the source tree.
 *
 * 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/>.
 */
#include "pybind11/pybind11.h"

#include <memory>

#include "lsst/sphgeom/Matrix3d.h"
#include "lsst/sphgeom/python/utils.h"

namespace py = pybind11;
using namespace pybind11::literals;

namespace lsst {
namespace sphgeom {
namespace {

Vector3d getRow(Matrix3d const &self, py::int_ row) {
    return self.getRow(static_cast<int>(python::convertIndex(3, row)));
}

PYBIND11_MODULE(matrix3d, mod) {
    py::module::import("lsst.sphgeom.vector3d");

    py::class_<Matrix3d, std::shared_ptr<Matrix3d>> cls(mod, "Matrix3d");

    cls.def(py::init<>());
    cls.def(py::init<double, double, double, double, double, double, double,
                     double, double>(),
            "m00"_a, "m01"_a, "m02"_a, "m10"_a, "m11"_a, "m12"_a, "m20"_a,
            "m21"_a, "m22"_a);
    cls.def(py::init<Vector3d const &>(), "diagonal"_a);
    cls.def(py::init<double>(), "scale"_a);
    cls.def(py::init<Matrix3d const &>(), "matrix"_a);

    cls.def("__eq__", &Matrix3d::operator==, py::is_operator());
    cls.def("__ne__", &Matrix3d::operator!=, py::is_operator());

    // Add bounds checking to getRow and getColumn
    cls.def("getRow", &getRow, "row"_a);
    cls.def("getColumn",
            [](Matrix3d const &self, py::int_ col) {
                return self.getColumn(
                        static_cast<int>(python::convertIndex(3, col)));
            },
            "col"_a);

    cls.def("__len__", [](Matrix3d const &self) { return py::int_(3); });
    cls.def("__getitem__", &getRow, py::is_operator());
    cls.def("__getitem__",
            [](Matrix3d const &self, py::tuple t) {
                if (t.size() > 2) {
                    throw py::index_error("Too many indexes for Matrix3d");
                } else if (t.size() == 0) {
                    return py::cast(self);
                } else if (t.size() == 1) {
                    return py::cast(getRow(self, t[0].cast<py::int_>()));
                }
                return py::cast(
                        self(python::convertIndex(3, t[0].cast<py::int_>()),
                             python::convertIndex(3, t[1].cast<py::int_>())));
            },
            py::is_operator());

    cls.def("inner", &Matrix3d::inner, "matrix"_a);
    cls.def("getSquaredNorm", &Matrix3d::getSquaredNorm);
    cls.def("getNorm", &Matrix3d::getNorm);

    cls.def("__mul__",
            (Vector3d(Matrix3d::*)(Vector3d const &) const) &
                    Matrix3d::operator*,
            "vector"_a, py::is_operator());
    cls.def("__mul__",
            (Matrix3d(Matrix3d::*)(Matrix3d const &) const) &
                    Matrix3d::operator*,
            "matrix"_a, py::is_operator());
    cls.def("__add__", &Matrix3d::operator+, py::is_operator());
    cls.def("__sub__", &Matrix3d::operator-, py::is_operator());

    cls.def("cwiseProduct", &Matrix3d::cwiseProduct);
    cls.def("transpose", &Matrix3d::transpose);
    cls.def("inverse", &Matrix3d::inverse);

    cls.def("__str__", [](Matrix3d const &self) {
        return py::str("[[{!s}, {!s}, {!s}],\n"
                       " [{!s}, {!s}, {!s}],\n"
                       " [{!s}, {!s}, {!s}]]")
                .format(self(0, 0), self(0, 1), self(0, 2), self(1, 0),
                        self(1, 1), self(1, 2), self(2, 0), self(2, 1),
                        self(2, 2));
    });
    cls.def("__repr__", [](Matrix3d const &self) {
        return py::str("Matrix3d({!r}, {!r}, {!r},\n"
                       "         {!r}, {!r}, {!r},\n"
                       "         {!r}, {!r}, {!r})")
                .format(self(0, 0), self(0, 1), self(0, 2), self(1, 0),
                        self(1, 1), self(1, 2), self(2, 0), self(2, 1),
                        self(2, 2));
    });
    cls.def("__reduce__", [cls](Matrix3d const &self) {
        auto args = py::make_tuple(self(0, 0), self(0, 1), self(0, 2),
                                   self(1, 0), self(1, 1), self(1, 2),
                                   self(2, 0), self(2, 1), self(2, 2));
        return py::make_tuple(cls, args);
    });
}

}  // <anonymous>
}  // sphgeom
}  // lsst