QCaml/common/lib/spin.mli

24 lines
359 B
OCaml

(** Spin *)
(* Electron spin *)
(** Type *)
type t = Alfa | Beta
(** Note :
~Alfa~ if written with an 'f' instead of 'ph' because it has the same
number of letters as ~Beta~, so the alignment of the code is nicer.
*)
(** Functions *)
val other : t -> t
(** Returns the opposite spin. *)
(** Printers *)
val pp : Format.formatter -> t -> unit