module documentation

Helpers for array operations involving indexing

Function const Get values of array a at indices, out of bounds indices return a constant
Function const_boundary Get values of array a at indices, out of bounds indices return a constant
Function pacman Get values of array a at indices, out of bounds indices obey pacman physics, i.e., topology of a torus. Same as periodic boundaries
Function periodic Get values of array a at indices, out of bounds indices are wrapped periodically
Function reflect Get values of array a at indices, out of bounds indices are reflected at the edges.
Type Variable T Undocumented
Variable _lgr Undocumented
def const(a: np.ndarray[S[N], T], indices: np.ndarray[[N, M], int], const: T = 0) -> np.ndarray[[N, M], T]:

Get values of array a at indices, out of bounds indices return a constant

def const_boundary(a: np.ndarray[S[N], T], indices: np.ndarray[[N, M], int]) -> np.ndarray[[N, M], T]:

Get values of array a at indices, out of bounds indices return a constant

def pacman(a: np.ndarray[S[N], T], indices: np.ndarray[[N, M], int]) -> np.ndarray[[N, M], T]:

Get values of array a at indices, out of bounds indices obey pacman physics, i.e., topology of a torus. Same as periodic boundaries

def periodic(a: np.ndarray[S[N], T], indices: np.ndarray[[N, M], int]) -> np.ndarray[[N, M], T]:

Get values of array a at indices, out of bounds indices are wrapped periodically

def reflect(a: np.ndarray[S[N], T], indices: np.ndarray[[N, M], int]) -> np.ndarray[[N, M], T]:

Get values of array a at indices, out of bounds indices are reflected at the edges.

T =

Undocumented

Value
TypeVar('T')
_lgr =

Undocumented