Python API for place_pwlin.
#1250
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
noraabiakar
suggested changes
Nov 30, 2020
bcumming
requested changes
Nov 30, 2020
| Apply the isometry to the first three components of the given tuple, interpreted as a point. | ||
|
|
||
| .. py:function:: __mul__(a: isometry, b: isometry) -> isometry |
There was a problem hiding this comment.
Is -> how one specifies the return type?
I have been using :rtype, e.g.:
https://github.com/arbor-sim/arbor/blame/master/doc/python/morphology.rst#L368
There was a problem hiding this comment.
I just got that syntax from the Python type annotation syntax. I don't know if it's the right or even better way to do it though.
python/morphology.cpp
Outdated
| }), | ||
| "x"_a, "y"_a, "z"_a, "radius"_a, "All values in μm.") | ||
| .def(py::init<double, double, double, double>(), | ||
| "x"_a, "y"_a, "z"_a, "radius"_a) |
There was a problem hiding this comment.
The docstring has been removed (which stated that all inputs were in um)
| @@ -112,6 +116,68 @@ void register_morphology(py::module& m) { | |||
| .def("__str__", [](const arb::mcable& c) { return util::pprintf("{}", c); }) | |||
| .def("__repr__", [](const arb::mcable& c) { return util::pprintf("{}", c); }); | |||
|
|
|||
| // arb::isometry | |||
| py::class_<arb::isometry> isometry(m, "isometry"); | |||
| isometry | |||
There was a problem hiding this comment.
docstrings are missing for the calls and methods in the isometry wrapper.
| "theta"_a, "axis"_a); | ||
|
|
||
| // arb::place_pwlin | ||
| py::class_<arb::place_pwlin> place(m, "place_pwlin"); |
There was a problem hiding this comment.
Missing docstrings also for methods of place_pwlin.
bcumming
approved these changes
Dec 11, 2020
noraabiakar
approved these changes
Dec 14, 2020
* Add unit tests for isometry and place_pwlin Python bindings. * Add equality test for mpoint.
* Add return types in cpp docs for isometry functions. * Add missing docstrings in python interface for place_pwlin and isometry.
halfflat
force-pushed
the
feature/python-place-pwlin
branch
from
1c336cf to
ff51a91
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
place_pwlinandisometryclasses.mpoint.place_pwlinandisometry.