Skip to content

Commit

Permalink
documentation changes
Browse files Browse the repository at this point in the history
  • Loading branch information
melsman committed Oct 1, 2023
1 parent a197c73 commit 23584de
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 5 deletions.
14 changes: 10 additions & 4 deletions lib/github.com/diku-dk/sml-sobol/sobol.sig
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
(* Quasi-random Sobol number generation. Ported from the Futhark Sobol
sequence implementation.
*)
(** Quasi-random Sobol number generation.
Quasi-random Sobol number generation ported from the Futhark Sobol
sequence implementation.
*)

signature SOBOL = sig

Expand All @@ -15,11 +18,14 @@ end

(**
[type vecD] The type of arrays of size D (not statically inforced).
[D] The dimensionality of a sequence.
[norm] The real value `2.0**32`.
[frac w] turns the Word32.word value w into a real in the interval [0;1[
[frac w] turns the Word32.word value w into a real in the interval
(0;1(.
[independent i] returns the `i`'th sobol vector of size D.
Expand Down
13 changes: 12 additions & 1 deletion lib/github.com/diku-dk/sml-sobol/sobol_dir.sig
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
(* Interface for Sobol direction vectors *)
(** Interface for Sobol direction vectors *)

signature SOBOL_DIR = sig
val n : int
Expand All @@ -7,3 +7,14 @@ signature SOBOL_DIR = sig
val a : Word32.word Array.array (* of size n *)
val s : int Array.array (* of size n *)
end

(**
[Discussion]
These constants and arrays are used for generating sobol
sequences. Different instantiations of this signature are available,
dependent on the dimensionality of the required sequence of Sobol
vectors.
*)
1 change: 1 addition & 0 deletions lib/github.com/diku-dk/sml-sobol/sobol_dir50.sml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
available from https://github.com/diku-dk/sobol-futhark
*)

(** SigDoc *)
structure SobolDir50 : SOBOL_DIR = struct

val n : int = 50
Expand Down

0 comments on commit 23584de

Please sign in to comment.