T3Frame.allclose#

t3toolbox.frame_variations_format.T3Frame.allclose(other, rtol=None, atol=None)#
def allclose(
        self,
        other: 'T3Frame',

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

True where other represents the same BASE POINT as self (gauge-invariant), per stack element – the ragged twin of UT3Frame.allclose(), via to_t3() difference norms. Three distinct equality questions exist for a frame; say which you mean: this method (same base point, any gauge); safety.frames_equal(a.data, b.data) (the same-FRAME / same-tangent-space question, gauge included); corewise_equal() (bitwise representation). == is intentionally not defined.

Parameters:
  • other (T3Frame)

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

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

Return type:

NDArray