random TPS generator

bmad-sim · Apr 29, 2024 · 84ee72c · 84ee72c
1 parent 5f5b93a
commit 84ee72c
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/operators.jl b/src/operators.jl
@@ -57,6 +57,11 @@ for (fname, felt) in ((:zeros, :zero), (:ones, :one))
 end
 
 # --- rand ---
+"""
+    rand(::Type{T}; use::Union{Descriptor,TPS,ComplexTPS}=GTPSA.desc_current) where {T<:Union{TPS,ComplexTPS}}
+
+Generate a `TPS`/`ComplexTPS` with all random coefficients.
+"""
 function rand(::Type{T}; use::Union{Descriptor,TPS,ComplexTPS}=GTPSA.desc_current) where {T<:Union{TPS,ComplexTPS}}
   t = T(use=use)
   len = length(t)