Skip to content

Commit 693f270

Browse files
committed
[SymForce] Clarify docstrings on SE(n) classes
Reviewers: hayk,bradley,nathan,ryan-b Topic: sym-se-docs GitOrigin-RevId: 04669af6d492f353de4bac51bc7b21ae74f186d8
1 parent da612a9 commit 693f270

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

symforce/geo/pose2_se2.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,13 @@ class Pose2_SE2(Pose2):
2222
"""
2323
Group of two-dimensional rigid body transformations - SE(2).
2424
25+
There is no generated runtime analogue of this class in the `sym` package, which means you
26+
cannot use it as an input or output of generated functions or as a variable in an optimized
27+
Values. This is intentional - in general, you should use the Pose2 class instead of this one,
28+
because the generated expressions will be significantly more efficient. If you are sure that
29+
you need the different behavior of this class, it's here for reference or for use in symbolic
30+
expressions.
31+
2532
The storage space is a complex (real, imag) for rotation followed by a position (x, y).
2633
2734
The tangent space is one angle for rotation followed by two elements for translation in the

symforce/geo/pose3_se3.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,13 @@ class Pose3_SE3(Pose3):
2222
"""
2323
Group of three-dimensional rigid body transformations - SE(3).
2424
25+
There is no generated runtime analogue of this class in the `sym` package, which means you
26+
cannot use it as an input or output of generated functions or as a variable in an optimized
27+
Values. This is intentional - in general, you should use the Pose3 class instead of this one,
28+
because the generated expressions will be significantly more efficient. If you are sure that
29+
you need the different behavior of this class, it's here for reference or for use in symbolic
30+
expressions.
31+
2532
The storage is a quaternion (x, y, z, w) for rotation followed by position (x, y, z).
2633
2734
The tangent space is 3 elements for rotation followed by 3 elements for translation in the

0 commit comments

Comments
 (0)