Skip to content

Commit

Permalink
📝 Split coordinate enumeration documentation into offset and cubic vs…
Browse files Browse the repository at this point in the history
…. SiQAD
  • Loading branch information
wlambooy committed May 24, 2023
1 parent 196d534 commit 6a41e60
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion include/fiction/layouts/coordinates.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -741,7 +741,8 @@ class coord_iterator
/**
* Standard constructor. Initializes the iterator with a starting position and the boundary within to enumerate.
*
* With `dimension = (1, 2, 1)` and `start = (0, 0, 0)`, the following order would be enumerated:
* With `dimension = (1, 2, 1)` and `start = (0, 0, 0)`, the following order would be enumerated for offset or cubic
* coordinates:
*
* - (0, 0, 0)
* - (1, 0, 0)
Expand All @@ -756,6 +757,21 @@ class coord_iterator
* - (0, 2, 1)
* - (1, 2, 1)
*
* For SiQAD coordinates with the same parameters, we have the following order of enumeration:
*
* - (0, 0, 0)
* - (1, 0, 0)
* - (0, 0, 1)
* - (1, 0, 1)
* - (0, 1, 0)
* - (1, 2, 0)
* - (0, 1, 1)
* - (1, 1, 1)
* - (1, 1, 0)
* - (0, 2, 0)
* - (0, 2, 1)
* - (1, 2, 1)
*
* coord_iterator is compatible with the STL forward_iterator category.
*
* @param dimension Boundary within to enumerate. Iteration wraps at its limits.
Expand Down

0 comments on commit 6a41e60

Please sign in to comment.