skspatial.objects.Vector.is_zero

Vector.is_zero(**kwargs: float) → bool

Check if the vector is the zero vector.

The zero vector in n dimensions is the vector containing n zeros.

Parameters

kwargsdict, optional

Additional keywords passed to math.isclose().

Returns

bool

True if vector is the zero vector; false otherwise.

Examples

>>> from skspatial.objects import Vector

>>> Vector([0, 0]).is_zero()
True
>>> Vector([1, 0]).is_zero()
False

>>> Vector([0, 0, 1e-4]).is_zero()
False
>>> Vector([0, 0, 1e-4]).is_zero(abs_tol=1e-3)
True