LSST Applications g0265f82a02+c6dfa2ddaf,g1162b98a3f+b2075782a9,g2079a07aa2+1b2e822518,g2bbee38e9b+c6dfa2ddaf,g337abbeb29+c6dfa2ddaf,g3ddfee87b4+a60788ef87,g50ff169b8f+2eb0e556e8,g52b1c1532d+90ebb246c7,g555ede804d+a60788ef87,g591dd9f2cf+ba8caea58f,g5ec818987f+864ee9cddb,g858d7b2824+9ee1ab4172,g876c692160+a40945ebb7,g8a8a8dda67+90ebb246c7,g8cdfe0ae6a+4fd9e222a8,g99cad8db69+5e309b7bc6,g9ddcbc5298+a1346535a5,ga1e77700b3+df8f93165b,ga8c6da7877+aa12a14d27,gae46bcf261+c6dfa2ddaf,gb0e22166c9+8634eb87fb,gb3f2274832+d0da15e3be,gba4ed39666+1ac82b564f,gbb8dafda3b+5dfd9c994b,gbeb006f7da+97157f9740,gc28159a63d+c6dfa2ddaf,gc86a011abf+9ee1ab4172,gcf0d15dbbd+a60788ef87,gdaeeff99f8+1cafcb7cd4,gdc0c513512+9ee1ab4172,ge79ae78c31+c6dfa2ddaf,geb67518f79+ba1859f325,geb961e4c1e+f9439d1e6f,gee10cc3b42+90ebb246c7,gf1cff7945b+9ee1ab4172,w.2024.12
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.