pele.distance._get_distance_cpp

Module source

# distutils: language = C++ # cython: language_level=3str

pele.distance._get_distance_cpp.get_distance()

Source

cpdef get_distance(np.ndarray[double] r1, np.ndarray[double] r2, int ndim, method, box=None, double shear=0.0):

Define the Python interface to the C++ distance implementation.

Parameters:

r1[float]

Position of the first particle

r2[float]

Position of the second particle

ndimint

Number of dimensions

methodDistance Enum

Distance measurement method / boundary conditions.

boxnp.array[float], optional

Box size (for periodic and Lees-Edwards distance measure)

shearfloat, optional

Amount of shear (for Lees-Edwards distance measure)