8000 doco update · flyinger/spatialmath-python@0333ffc · GitHub
[go: up one dir, main page]

Skip to content
8000

Commit 0333ffc

Browse files
committed
doco update
1 parent 260e935 commit 0333ffc

File tree

1 file changed

+7
-11
lines changed

1 file changed

+7
-11
lines changed

spatialmath/super_pose.py

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,8 @@ class SMPose(SMUserList):
6262
Arithmetic operators are overloaded but the operation they perform depend
6363
on the types of the operands. For example:
6464
65-
- ``*`` will compose two instances of the same subclass, and the result will be
66-
an instance of the same subclass, since this is a group operator.
65+
- ``*`` will compose two instances of the same subclass, and the result will
66+
be an instance of the same subclass, since this is a group operator.
6767
- ``+`` will add two instances of the same subclass, and the result will be
6868
a matrix, not an instance of the same subclass, since addition is not a group operator.
6969
@@ -270,9 +270,7 @@ def log(self, twist=False):
270270
"""
271271
Logarithm of pose (superclass method)
272272
273-
:return: logarithm
274-
:rtype: numpy.ndarray
275-
:raises: ValueError
273+
:return: logarithm :rtype: numpy.ndarray :raises: ValueError
276274
277275
An efficient closed-form solution of the matrix logarithm.
278276
@@ -281,10 +279,8 @@ def log(self, twist=False):
281279
----- ---------------------------------------
282280
Pose Shape Structure
283281
===== ====== ===============================
284-
SO2 (2,2) skew-symmetric
285-
SE2 (3,3) augmented skew-symmetric
286-
SO3 (3,3) skew-symmetric
287-
SE3 (4,4) augmented skew-symmetric
282+
SO2 (2,2) skew-symmetric SE2 (3,3) augmented skew-symmetric
283+
SO3 (3,3) skew-symmetric SE3 (4,4) augmented skew-symmetric
288284
===== ====== ===============================
289285
290286
Example::
@@ -298,9 +294,9 @@ def log(self, twist=False):
298294
[ 0. , 0. , 0. , 0. ]])
299295
300296
301-
:seealso: :func:`~spatialmath.base.transforms2d.trlog2`, :func:`~spatialmath.base.transforms3d.trlog`
297+
:seealso: :func:`~spatialmath.base.transforms2d.trlog2`,
298+
:func:`~spatialmath.base.transforms3d.trlog`
302299
"""
303-
print('in log')
304300
if self.N == 2:
305301
log = [tr.trlog2(x, twist=twist) for x in self.data]
306302
else:

0 commit comments

Comments
 (0)
0