Skip to content

Commit f477d2d

Browse files
committed
(docs) further updates to the documentation page
1 parent e59cdb2 commit f477d2d

1 file changed

Lines changed: 8 additions & 1 deletion

File tree

docs/docs.nim

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -241,6 +241,7 @@
241241
## - **I**: Internal grid (only points inside the simplex)
242242
## - **R**: Random/Monte Carlo uniform sampling over simplex.
243243
## - **G**: Graph (list of grid nodes and list of their neighbors)
244+
## - **L**: Limited graph (list of grid nodes and list of their neighbors with limits)
244245
## 2. Fractional or Integer positions:
245246
## - **F**: Fractional grid/graph (points are normalized to fractions of 1)
246247
## - **I**: Integer grid/graph (points are integers)
@@ -251,8 +252,14 @@
251252
## optionally a custom path as an additonal argument)
252253
## - **Simplex Dimensions / N of Components**: An integer number of components in the simplex space.
253254
## - **N Divisions per Dimension / N of Samples**: An integer number of either:
254-
## 1. Divisions per each simplex dimension for grid or graph tasks (F/I/G__)
255+
## 1. Divisions per each simplex dimension for grid or graph tasks (F/I/G/L__)
255256
## 2. Number of samples for random sampling tasks (R__)
257+
## - **(for limited graphs only) Limits**: A string list of pairs of either integers or floats, depending on the grid type specified by the second letter of
258+
## the configuration string. Each pair represents the minimum and maximum values for each simplex dimension. The number of pairs must match the
259+
## number of simplex dimensions. You can use `[`, `{`, or `@[` for the list. E.g., `[[0, 1],[0,0.555],[0.222,0.888]]` for fractional grid limits
260+
## or `{{0,12},{2,10},{3,9}}` for integer grid limits. Setting the limits to less than 0 or greater than 1/nDiv will pass with a warning, but will
261+
## not throw an error. The integer limits are exactly inclusive, while the fractional limits inclusive of the *closeset* grid point, i.e. max limit of
262+
## 0.660 will let 1/3=0.667 pass for low resolution grids, but not high resolution ones.
256263
## - **(optional) NumPy Array Output Filename**: A custom path to the output NumPy array file (only for __N tasks).
257264
##
258265
## For instance, to generate a 3-dimensional internal fractional grid with 10 divisions per dimension and persist it to a NumPy array file, you can run:

0 commit comments

Comments
 (0)