UT3Frame.allclose#

t3toolbox.uniform_frame_variations_format.UT3Frame.allclose(other, rtol=None, atol=0.0)#
def allclose(
        self,
        other: 'UT3Frame',

        rtol:  typ.Optional[float] = None,  # None: the ambient jax-aware default (safety.comparison_rtol)
        atol:  float = 0.0,
) -> NDArray:  # bool array, shape = stack_shape; scalar unstacked; reduce with .all()

True (per stack element) if other represents the same BASE POINT as self (gauge-invariant): ||self.to_ut3() - other.to_ut3()|| <= atol + rtol * max(norms). Three distinct equality questions exist for a frame; say which you mean: this method (same base point, any gauge); safety.frames_equal on the masked supercores (the same-FRAME / same-tangent-space question); corewise_equal() (bitwise incl. padding). == is intentionally not defined.

Parameters:
  • other (UT3Frame)

  • rtol (t3toolbox.backend.common.typ.Optional[float])

  • atol (float)

Return type:

NDArray