LSST Applications
21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
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 Key , typename Value , typename KeyHash = boost::hash<Key>, typename KeyPred = std::equal_to<Key>> | |
void | declareCache (py::module &mod, std::string const &name) |
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. More... | |
template<class PyClass > | |
void | addOutputOp (PyClass &cls, std::string const &method) |
Add __str__ or __repr__ method implemented by operator<< . More... | |
template<class PyClass > | |
void | addHash (PyClass &cls) |
Add __hash__ method implemented by std::hash . More... | |
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. More... | |
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. More... | |
void lsst::cpputils::python::addHash | ( | PyClass & | cls | ) |
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 | ||
) |