Loading [MathJax]/extensions/tex2jax.js
LSST Applications g0fba68d861+aa97b6e50c,g1ec0fe41b4+f536777771,g1fd858c14a+a9301854fb,g35bb328faa+fcb1d3bbc8,g4af146b050+a5c07d5b1d,g4d2262a081+78f4f01b60,g53246c7159+fcb1d3bbc8,g56a49b3a55+9c12191793,g5a012ec0e7+3632fc3ff3,g60b5630c4e+ded28b650d,g67b6fd64d1+ed4b5058f4,g78460c75b0+2f9a1b4bcd,g786e29fd12+cf7ec2a62a,g8352419a5c+fcb1d3bbc8,g87b7deb4dc+7b42cf88bf,g8852436030+e5453db6e6,g89139ef638+ed4b5058f4,g8e3bb8577d+d38d73bdbd,g9125e01d80+fcb1d3bbc8,g94187f82dc+ded28b650d,g989de1cb63+ed4b5058f4,g9d31334357+ded28b650d,g9f33ca652e+50a8019d8c,gabe3b4be73+1e0a283bba,gabf8522325+fa80ff7197,gb1101e3267+d9fb1f8026,gb58c049af0+f03b321e39,gb89ab40317+ed4b5058f4,gcf25f946ba+e5453db6e6,gcf6002c91b+2a0c9e9e84,gd6cbbdb0b4+bb83cc51f8,gdd1046aedd+ded28b650d,gde0f65d7ad+66b3a48cb7,ge278dab8ac+d65b3c2b70,ge410e46f29+ed4b5058f4,gf23fb2af72+b7cae620c0,gf5e32f922b+fcb1d3bbc8,gf67bdafdda+ed4b5058f4,w.2025.16
LSST Data Management Base Package
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
_vector3d.cc
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#include "pybind11/pybind11.h"
30
31#include "lsst/sphgeom/python.h"
32
33#include "lsst/sphgeom/Angle.h"
37
38namespace py = pybind11;
39using namespace pybind11::literals;
40
41namespace lsst {
42namespace sphgeom {
43
44template <>
46 cls.def(py::init<>());
47 cls.def(py::init<double, double, double>(), "x"_a, "y"_a, "z"_a);
48 cls.def(py::init<Vector3d const &>(), "vector"_a);
49 // Construct a Vector3d from a UnitVector3d, enabling implicit
50 // conversion from UnitVector3d to Vector3d in python via
51 // py::implicitly_convertible
52 cls.def(py::init([](UnitVector3d const &u) {
53 return new Vector3d(u.x(), u.y(), u.z());
54 }));
55
56 cls.def("__eq__", &Vector3d::operator==, py::is_operator());
57 cls.def("__ne__", &Vector3d::operator!=, py::is_operator());
58 cls.def("__neg__", (Vector3d(Vector3d::*)() const) & Vector3d::operator-);
59 cls.def("__add__", &Vector3d::operator+, py::is_operator());
60 cls.def("__sub__",
61 (Vector3d(Vector3d::*)(Vector3d const &) const) &
62 Vector3d::operator-,
63 py::is_operator());
64 cls.def("__mul__", &Vector3d::operator*, py::is_operator());
65 cls.def("__truediv__", &Vector3d::operator/, py::is_operator());
66
67 cls.def("__iadd__", &Vector3d::operator+=);
68 cls.def("__isub__", &Vector3d::operator-=);
69 cls.def("__imul__", &Vector3d::operator*=);
70 cls.def("__itruediv__", &Vector3d::operator/=);
71
72 cls.def("x", &Vector3d::x);
73 cls.def("y", &Vector3d::y);
74 cls.def("z", &Vector3d::z);
75 cls.def("dot", &Vector3d::dot);
76 cls.def("getSquaredNorm", &Vector3d::getSquaredNorm);
77 cls.def("getNorm", &Vector3d::getNorm);
78 cls.def("isZero", &Vector3d::isZero);
79 cls.def("normalize", &Vector3d::normalize);
80 cls.def("isNormalized", &Vector3d::isNormalized);
81 cls.def("cross", &Vector3d::cross);
82 cls.def("cwiseProduct", &Vector3d::cwiseProduct);
83 cls.def("rotatedAround", &Vector3d::rotatedAround, "axis"_a, "angle"_a);
84
85 cls.def("__len__", [](Vector3d const &self) { return py::int_(3); });
86 cls.def("__getitem__", [](Vector3d const &self, py::int_ i) {
87 return self(python::convertIndex(3, i));
88 });
89
90 cls.def("__str__", [](Vector3d const &self) {
91 return py::str("[{!s}, {!s}, {!s}]")
92 .format(self.x(), self.y(), self.z());
93 });
94 cls.def("__repr__", [](Vector3d const &self) {
95 return py::str("Vector3d({!r}, {!r}, {!r})")
96 .format(self.x(), self.y(), self.z());
97 });
98
99 cls.def("__reduce__", [cls](Vector3d const &self) {
100 return py::make_tuple(cls,
101 py::make_tuple(self.x(), self.y(), self.z()));
102 });
103}
104
105} // sphgeom
106} // lsst
This file declares a class for representing unit vectors in ℝ³.
This file declares a class for representing vectors in ℝ³.
UnitVector3d is a unit vector in ℝ³ with components stored in double precision.
Vector3d is a vector in ℝ³ with components stored in double precision.
Definition Vector3d.h:51
Vector3d cwiseProduct(Vector3d const &v) const
cwiseProduct returns the component-wise product of this vector and v.
Definition Vector3d.h:157
Vector3d rotatedAround(UnitVector3d const &k, Angle a) const
rotatedAround returns a copy of this vector, rotated around the unit vector k by angle a according to...
Definition Vector3d.cc:133
double dot(Vector3d const &v) const
dot returns the inner product of this vector and v.
Definition Vector3d.h:80
bool isNormalized() const
isNormalized returns true if this vectors norm is very close to 1.
Definition Vector3d.h:103
double x() const
Definition Vector3d.h:73
bool isZero() const
isZero returns true if all the components of this vector are zero.
Definition Vector3d.h:93
double y() const
Definition Vector3d.h:75
double getNorm() const
getNorm returns the L2 norm of this vector.
Definition Vector3d.h:88
double normalize()
normalize scales this vector to have unit norm and returns its norm prior to scaling.
Definition Vector3d.cc:49
double z() const
Definition Vector3d.h:77
double getSquaredNorm() const
getSquaredNorm returns the inner product of this vector with itself.
Definition Vector3d.h:85
Vector3d cross(Vector3d const &v) const
cross returns the cross product of this vector and v.
Definition Vector3d.h:108
ptrdiff_t convertIndex(ptrdiff_t len, pybind11::int_ i)
Convert a Python index i over a sequence with length len to a non-negative (C++ style) index,...
Definition utils.h:48
void defineClass(Pybind11Class &cls)
This file declares a class for representing angles.