diff options
| author | Tom Rondeau <tom@trondeau.com> | 2014-10-10 16:06:46 -0400 |
|---|---|---|
| committer | Tom Rondeau <tom@trondeau.com> | 2014-10-10 16:06:46 -0400 |
| commit | 559a0fef07612d75881003f1fbb785ad5fe86b93 (patch) | |
| tree | d2798afb3ead36b94fdc14638ccc498a66b10447 /docs/doxygen/other/pmt.dox | |
| parent | 797b5924d310fe6d5fdcce176b6fb3d89618b7b5 (diff) | |
docs: adding info on python-pmt converters into pmt manual page.
Diffstat (limited to 'docs/doxygen/other/pmt.dox')
| -rw-r--r-- | docs/doxygen/other/pmt.dox | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/doxygen/other/pmt.dox b/docs/doxygen/other/pmt.dox index bc7f870ccd..51e1865d39 100644 --- a/docs/doxygen/other/pmt.dox +++ b/docs/doxygen/other/pmt.dox @@ -477,4 +477,21 @@ pmt::pmt_t a pmt::from_double(1.0); std::cout << "The PMT a contains " << a << std::endl; \endcode + +\section pmt_python Conversion between Python Objects and PMTs + +Although PMTs can be manipulated in Python using the Python versions +of the C++ interfaces, there are some additional goodies that make it +easier to work with PMTs in python. There are functions to automate +the conversion between PMTs and Python types for booleans, strings, +integers, longs, floats, complex numbers, dictionaries, lists, tuples +and combinations thereof. + +Two functions capture most of this functionality: + +\code +pmt.to_pmt # Converts a python object to a PMT. +pmt.to_python # Converts a PMT into a python object. +\endcode + */ |