@@ -44,8 +44,8 @@ pip install coordinax
4444 dimensions). A rep does not store numerical values.
4545- Vector: data + rep + role. Data are the coordinate values or physical
4646 components.
47- - Role: semantic interpretation of vector data (Pos, Vel, PhysAcc, etc.). A role is
48- not a rep.
47+ - Role: semantic interpretation of vector data (Pos, Vel, PhysAcc, etc.). A role
48+ is not a rep.
4949- Metric: a bilinear form g on the tangent space defining inner products and
5050 norms (Euclidean, sphere intrinsic, Minkowski).
5151- Physical components: components of a geometric vector expressed in an
@@ -84,7 +84,7 @@ We can also transform physical vector components between reps:
8484
8585```
8686v = {"x": u.Q(4.0, "km/s"), "y": u.Q(5.0, "km/s"), "z": u.Q(6.0, "km/s")}
87- v_sph = cxt.tangent_transform (cxc.sph3d, cxc.cart3d, v, at=q)
87+ v_sph = cxt.physical_tangent_transform (cxc.sph3d, cxc.cart3d, v, at=q)
8888```
8989
9090## Metrics
@@ -148,12 +148,12 @@ bool(
148148
149149Different vector roles transform via different mechanisms:
150150
151- | Role | Transformation | Requires Base Point? |
152- | -------------- | ----------------------------------- | -------------------- |
153- | ` Point ` | Position transform (coordinate map) | No |
154- | ` PhysDisp ` | Tangent transform (physical vector) | Sometimes[ ^ 1 ] |
155- | ` PhysVel ` | Tangent transform (physical vector) | Sometimes[ ^ 1 ] |
156- | ` PhysAcc ` | Tangent transform (physical vector) | Sometimes[ ^ 1 ] |
151+ | Role | Transformation | Requires Base Point? |
152+ | ---------- | ----------------------------------- | -------------------- |
153+ | ` Point ` | Position transform (coordinate map) | No |
154+ | ` PhysDisp ` | Tangent transform (physical vector) | Sometimes[ ^ 1 ] |
155+ | ` PhysVel ` | Tangent transform (physical vector) | Sometimes[ ^ 1 ] |
156+ | ` PhysAcc ` | Tangent transform (physical vector) | Sometimes[ ^ 1 ] |
157157
158158[ ^ 1 ] :
159159 Required when converting between representations (e.g., Cartesian ↔
@@ -162,9 +162,9 @@ Different vector roles transform via different mechanisms:
162162
163163## PointedVector: Ergonomic Tangent Vector Conversions
164164
165- ` PointedVector ` provides a container for vectors anchored at a common base point,
166- automatically managing the base point dependency required for tangent vector
167- transformations:
165+ ` PointedVector ` provides a container for vectors anchored at a common base
166+ point, automatically managing the base point dependency required for tangent
167+ vector transformations:
168168
169169```
170170import coordinax as cx
@@ -236,25 +236,24 @@ d_sum = d1.add(d2) # role is Displacement
236236disp_from_origin = cx.as_pos(new_pos)
237237```
238238
239- | Operation | Result | Allowed? |
240- | ----------------------------- | ---- ---------- | -------- |
241- | ` PhysDisp + PhysDisp ` | ` PhysDisp ` | ✅ |
242- | ` Point + PhysDisp ` | ` Point ` | ✅ |
243- | ` PhysDisp + Point ` | — | ❌ |
244- | ` Point + Point ` | — | ❌ |
239+ | Operation | Result | Allowed? |
240+ | --------------------- | ---------- | -------- |
241+ | ` PhysDisp + PhysDisp ` | ` PhysDisp ` | ✅ |
242+ | ` Point + PhysDisp ` | ` Point ` | ✅ |
243+ | ` PhysDisp + Point ` | — | ❌ |
244+ | ` Point + Point ` | — | ❌ |
245245
246246> ** ⚠️ Critical: Physical Components with Uniform Units**
247247>
248- > ` PhysDisp ` stores ** physical vector components in an orthonormal frame** ,
249- > not coordinate increments. All components must have uniform dimension
250- > ` [length] ` .
248+ > ` PhysDisp ` stores ** physical vector components in an orthonormal frame** , not
249+ > coordinate increments. All components must have uniform dimension ` [length] ` .
251250>
252251> For example, in cylindrical coordinates:
253252>
254253> - ✅ ** Correct** : ` PhysDisp(rho=1m, phi=2m, z=3m) ` — physical components,
255254> where ` phi=2m ` means "2 meters in the tangential direction"
256- > - ❌ ** Wrong** : ` PhysDisp(rho=1m, phi=0.5rad, z=3m) ` — coordinate
257- > increments with mixed units
255+ > - ❌ ** Wrong** : ` PhysDisp(rho=1m, phi=0.5rad, z=3m) ` — coordinate increments
256+ > with mixed units
258257>
259258> This applies to all tangent vectors (` PhysDisp ` , ` PhysVel ` , ` PhysAcc ` ), which
260259> transform via orthonormal frame transformations, not coordinate chart
0 commit comments