Skip to content

Commit

Permalink
Update docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
pmrv committed Nov 15, 2021
1 parent eae78f0 commit 589d0b5
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions pyiron_atomistics/atomistics/structure/neighbors.py
Original file line number Diff line number Diff line change
Expand Up @@ -1047,10 +1047,10 @@ def indices(self):
"""
Neighbour indices (excluding itself) of each atom computed using the get_neighbors_traj() method
Returns:
numpy.ndarray/list: An array of dimension N_steps / stride x N_atoms x N_neighbors
If the structures have different number of atoms, the array will have -1 on indices that are invalid.
Returns:
numpy.ndarray: An int array of dimension N_steps / stride x N_atoms x N_neighbors
"""
return self._flat_store.get_array_filled("indices")

Expand All @@ -1059,10 +1059,10 @@ def distances(self):
"""
Neighbour distances (excluding itself) of each atom computed using the get_neighbors_traj() method
Returns:
numpy.ndarray/list: An array of dimension N_steps / stride x N_atoms x N_neighbors
If the structures have different number of atoms, the array will have NaN on indices that are invalid.
Returns:
numpy.ndarray: A float array of dimension N_steps / stride x N_atoms x N_neighbors
"""
return self.flat_store.get_array_filled("distances")

Expand All @@ -1071,10 +1071,10 @@ def vecs(self):
"""
Neighbour vectors (excluding itself) of each atom computed using the get_neighbors_traj() method
Returns:
numpy.ndarray/list: An array of dimension N_steps / stride x N_atoms x N_neighbors x 3
If the structures have different number of atoms, the array will have NaN on indices that are invalid.
Returns:
numpy.ndarray: A float array of dimension N_steps / stride x N_atoms x N_neighbors x 3
"""
return self._flat_store.get_array_filled("vecs")

Expand Down

0 comments on commit 589d0b5

Please sign in to comment.