Fix new emitter switch (#151)

* rename example files

* fix MaybeVector and add maybe.jl with docs

* fix zoom lens @show syss[1] typo

docs/src/examples.md

@@ -39,7 +39,7 @@ mdparse(@code_string draw_zoomlenses()) # hide
 ```
 
 ```@example example
-syss = draw_zoomlenses(["assets/zoom$i.png" for i in 1:3]); @show sys[1]; nothing # hide
+syss = draw_zoomlenses(["assets/zoom$i.png" for i in 1:3]); @show syss[1]; nothing # hide
 ```
 
 ![Zoom position 1 visualization](assets/zoom1.png)

src/Examples/Examples.jl

@@ -17,8 +17,8 @@ using Unitful
 using Plots
 using LinearAlgebra
 
-include("docs.jl")
-include("other.jl")
+include("docs_examples.jl")
+include("other_examples.jl")
 
 end #module Examples
 export Examples

src/Examples/docs.jl → src/Examples/docs_examples.jl

@@ -30,7 +30,7 @@ function draw_cooketriplet(filename::Maybe{AbstractString} = nothing)
     return sys
 end
 
-function draw_zoomlenses(filenames::MaybeVector{AbstractString} = cycle([nothing]))
+function draw_zoomlenses(filenames::MaybeVector{AbstractString} = repeat([nothing], 3))
     stops = [2.89, 3.99, 4.90]
     zooms = [9.48, 4.48, 2.00]
     dists = [4.46970613, 21.21, 43.81]
@@ -220,7 +220,7 @@ function draw_multiHOE(filename::Maybe{AbstractString} = nothing)
     return nothing
 end
 
-function draw_stackedbeamsplitters(filenames::MaybeVector{AbstractString} = cycle([nothing]))
+function draw_stackedbeamsplitters(filenames::MaybeVector{AbstractString} = repeat([nothing], 3))
     # ReflectOrTransmit: nondeterministic
     # Transmit: deterministic, all beamsplitters transmissive
     # Reflect: deterministic, all beamsplitters reflective

src/OpticSim.jl

@@ -3,7 +3,6 @@
 # See LICENSE in the project root for full license information.
 
 module OpticSim
-export Maybe, MaybeVector
 
 import Unitful
 using LinearAlgebra: eigen, svd, I, qr, dot, cross, norm, det, normalize, inv
@@ -19,14 +18,13 @@ using Revise
 import GLMakie
 import Makie.AbstractPlotting
 
-const Maybe{T} = Union{T, Nothing}
-const MaybeVector{T} = Union{Vector{<:T}, Iterators.Cycle{Vector{Nothing}}}
+include("maybe.jl")
+include("constants.jl")
+include("utilities.jl")
 
 include("GlassCat/GlassCat.jl")
-import OpticSim.GlassCat: plot_indices, index, polyfit_indices, absairindex, absorption, info, glassid, glassname, glassforid, isair, findglass, modelglass, glassfromMIL, GlassID
+import .GlassCat: plot_indices, index, polyfit_indices, absairindex, absorption, info, glassid, glassname, glassforid, isair, findglass, modelglass, glassfromMIL, GlassID
 
-include("constants.jl")
-include("utilities.jl")
 include("Geometry/Geometry.jl")
 include("Optical/Optical.jl")
 include("Vis/Vis.jl")

src/maybe.jl

@@ -0,0 +1,21 @@
+# MIT license
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# See LICENSE in the project root for full license information.
+
+export Maybe, MaybeVector
+
+"""
+Haskell-style [option type](https://en.wikipedia.org/wiki/Option_type) primarily used to allow optional inputs/outputs
+for functions.
+
+For example, in `src/Examples/docs_examples.jl`, we have `draw_cooketriplet(filename::Maybe{AbstractString} = nothing)`.
+If the function is called with a `filename` argument, then it is passed as a string, and `Vis.save(filename)` saves an
+image of the drawn example. If there is no argument, then the save call is dispatched to the empty `function
+Vis.save(::Nothing) end`. This allows the user to run the example without saving a file.
+"""
+const Maybe{T} = Union{T, Nothing}
+
+"""
+Extension of `Maybe{T}` which allows things like `[nothing, 1, 1.0, nothing] isa MaybeVector{Real}`
+"""
+const MaybeVector{T} = Vector{<:Maybe{T}}