skspatial.objects.Points.are_collinear

Points.are_collinear(**kwargs) → bool

Check if the points are all contained in one line.

Parameters:

kwargsdict, optional

Additional keywords passed to numpy.linalg.matrix_rank()

Returns:

bool

True if points are collinear; false otherwise.

Examples

>>> from skspatial.objects import Points

>>> Points(([0, 0, 0], [1, 2, 3], [2, 4, 6])).are_collinear()
True

>>> Points(([0, 0, 0], [1, 2, 3], [5, 2, 0])).are_collinear()
False

>>> Points(([0, 0], [1, 2], [5, 2], [6, 3])).are_collinear()
False