Skip to content

Commit

Permalink
Fix documentation of proj_dist_fn parameter in clugen()
Browse files Browse the repository at this point in the history
  • Loading branch information
nunofachada authored Sep 2, 2023
1 parent 69a5e94 commit c6202cd
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/main.jl
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,8 @@ arguments, described next.
- `"norm"` (default): Distribute point projections along lines using a normal
distribution (μ=_line center_, σ=`llength/6`).
- `"unif"`: Distribute points uniformly along the line.
- User-defined function, which accepts two parameters, line length (float),
number of points (integer) and a random number generator, and returns an array
- User-defined function, which accepts three parameters, line length (float),
number of points (integer), and a random number generator, and returns an array
containing the distance of each point projection to the center of the line. For
example, the `"norm"` option roughly corresponds to
`(len, n, rng) -> (1.0 / 6.0) * len .* randn(rng, n)`.
Expand Down

0 comments on commit c6202cd

Please sign in to comment.