LSST Applications g04a91732dc+a777afbe81,g07dc498a13+7e3c5f68a2,g12483e3c20+0145ec33cd,g1409bbee79+7e3c5f68a2,g1a7e361dbc+7e3c5f68a2,g1fd858c14a+9f35e23ec3,g35bb328faa+fcb1d3bbc8,g3ad4f90e5c+0145ec33cd,g3bd4b5ce2c+cbf1bea503,g4e0f332c67+5d362be553,g53246c7159+fcb1d3bbc8,g5477a8d5ce+db04660fe6,g60b5630c4e+0145ec33cd,g623d845a50+0145ec33cd,g6f0c2978f1+3526b51a37,g75b6c65c88+d54b601591,g78460c75b0+2f9a1b4bcd,g786e29fd12+cf7ec2a62a,g7b71ed6315+fcb1d3bbc8,g8852436030+4639f750a5,g89139ef638+7e3c5f68a2,g9125e01d80+fcb1d3bbc8,g919ac25b3e+6220c5324a,g95236ca021+f7a31438ed,g989de1cb63+7e3c5f68a2,g9f33ca652e+2d6fa11d35,gaaedd4e678+7e3c5f68a2,gabe3b4be73+1e0a283bba,gb1101e3267+4a428ef779,gb4a253aaf5+0122250889,gb58c049af0+f03b321e39,gc99c83e5f0+76d20ab76d,gcf25f946ba+4639f750a5,gd6cbbdb0b4+c8606af20c,gde0f65d7ad+3d8a3b7e46,ge278dab8ac+932305ba37,gf795337580+03b96afe58,gfba249425e+fcb1d3bbc8,w.2025.08
LSST Data Management Base Package
|
Classes | |
class | PySharedPtr |
A shared pointer that tracks both a C++ object and its associated PyObject. More... | |
class | TemplateInvoker |
A helper class for wrapping C++ template functions as Python functions with dtype arguments. More... | |
class | WrapperCollection |
A helper class for subdividing pybind11 module across multiple translation units (i.e. More... | |
Functions | |
template<typename T, typename PyClass> | |
void | addSharedPtrEquality (PyClass &cls) |
Add __eq__ and __ne__ methods based on two std::shared_ptr<T> pointing to the same address. | |
template<class PyClass> | |
void | addOutputOp (PyClass &cls, std::string const &method) |
Add __str__ or __repr__ method implemented by operator<< . | |
template<class PyClass> | |
void | addHash (PyClass &cls) |
Add __hash__ method implemented by std::hash . | |
std::size_t | cppIndex (std::ptrdiff_t size, std::ptrdiff_t i) |
Compute a C++ index from a Python index (negative values count from the end) and range-check. | |
std::pair< std::size_t, std::size_t > | cppIndex (std::ptrdiff_t size_i, std::ptrdiff_t size_j, std::ptrdiff_t i, std::ptrdiff_t j) |
Compute a pair of C++ indices from a pair of Python indices (negative values count from the end) and range-check. | |
template<typename Key, typename Value, typename KeyHash = boost::hash<Key>, typename KeyPred = std::equal_to<Key>> | |
void | declareCache (py::module &mod, std::string const &name) |
void lsst::cpputils::python::addHash | ( | PyClass & | cls | ) |
Add __hash__
method implemented by std::hash
.
PyClass | The pybind11 class_ type. The wrapped class must have an enabled specialization of std::hash . |
cls | The PyClass object to which to add a wrapper. |
Definition at line 104 of file python.h.
void lsst::cpputils::python::addOutputOp | ( | PyClass & | cls, |
std::string const & | method ) |
Add __str__
or __repr__
method implemented by operator<<
.
For flexibility, this method can be used to define one or both of __str__
and __repr__
. It can also be used to define any Python method that takes no arguments and returns a string, regardless of name.
PyClass | The pybind11 class_ type. The wrapped class must support << as a stream output operator. |
cls | The PyClass object to which to add a wrapper. |
method | The name of the method to implement. Should be "__str__" or "__repr__" . |
Definition at line 87 of file python.h.
|
inline |
Add __eq__
and __ne__
methods based on two std::shared_ptr<T> pointing to the same address.
T | The type to which the std::shared_ptr points. |
PyClass | The pybind11 class_ type; this can be automatically deduced. |
Example:
lsst::afw::table records are considered equal if two std::shared_ptr<record>
point to the same record. This is wrapped as follows for lsst::afw::table::BaseRecord
, where cls
is an instance of pybind11::class_<BaseRecord, std::shared_ptr<BaseRecord>>)
:
utils::addSharedPtrEquality<BaseRecord>(cls);
Note that all record subclasses inherit this behavior without needing to call this function.
Definition at line 63 of file python.h.
|
inline |
Compute a C++ index from a Python index (negative values count from the end) and range-check.
[in] | size | Number of elements in the collection. |
[in] | i | Index into the collection; negative values count from the end |
Python | IndexError if i not in range [-size, size - 1] |
Definition at line 124 of file python.h.
|
inline |
Compute a pair of C++ indices from a pair of Python indices (negative values count from the end) and range-check.
[in] | size_i | Number of elements along the first axis. |
[in] | size_j | Number of elements along the second axis. |
[in] | i | Index along first axis; negative values count from the end |
[in] | j | Index along second axis; negative values count from the end |
Python | IndexError if either input index not in range [-size, size - 1] |
Definition at line 150 of file python.h.
void lsst::cpputils::python::declareCache | ( | py::module & | mod, |
std::string const & | name ) |
Definition at line 41 of file Cache.h.