Use more specific error types

@Assert can get optimized away by the compiler, and generic error() uses ErrorException, which doesn't provide much information. Used DomainError for an argument being outside a valid set, and used ArgumentError for multiple arguments relating to each other (e.g., multiple arrays having the same length)
JuliaAstro · giordano · May 12, 2024 · May 12, 2024 · May 12, 2024 · 0da83d34b26bb53def44f50a1106e8a85684bc1c
commit 0da83d34b26bb53def44f50a1106e8a85684bc1c
diff --git a/src/aitoff.jl b/src/aitoff.jl
@@ -69,7 +69,9 @@ aitoff(l::Real, b::Real) = aitoff(promote(float(l), float(b))...)
 aitoff(lb::Tuple{Real, Real}) = aitoff(lb...)
 
 function aitoff(l::AbstractArray{L}, b::AbstractArray{B}) where {L<:Real,B<:Real}
-    @assert length(l) == length(b)
+    if length(l) != length(b)
+        throw(ArgumentError("l and b arrays must have the same length"))
+    end
     typel = float(L)
     x = similar(l, typel)
     y = similar(b, typel)

diff --git a/src/altaz2hadec.jl b/src/altaz2hadec.jl
@@ -88,7 +88,9 @@ altaz2hadec(altaz::Tuple{Real, Real}, lat::Real) = altaz2hadec(altaz..., lat)
 
 function altaz2hadec(alt::AbstractArray{R}, az::AbstractArray{<:Real},
                      lat::AbstractArray{<:Real}) where {R<:Real}
-    @assert length(alt) == length(az) == length(lat)
+    if !(length(alt) == length(az) == length(lat))
+        throw(ArgumentError("alt, az, and lat arrays must have the same length"))
+    end
     typealt = float(R)
     ha  = similar(alt, typealt)
     dec = similar(alt, typealt)

diff --git a/src/bprecess.jl b/src/bprecess.jl
@@ -20,7 +20,9 @@ const Mbprec =
 # commented, in case someone is interested.
 function _bprecess(ra::T, dec::T, parallax::T, radvel::T,
                    epoch::T, muradec::Vector{T}) where {T<:AbstractFloat}
-    @assert length(muradec) == 2
+    if length(muradec) != 2
+        throw(DomainError("muradec must have length 2"))
+    end
     sinra,  cosra  = sincos(deg2rad(ra))
     sindec, cosdec = sincos(deg2rad(dec))
     r0 = SVector(cosra*cosdec,  sinra*cosdec,  sindec)
@@ -91,7 +93,10 @@ function bprecess(ra::AbstractArray{R}, dec::AbstractArray{<:Real},
                   muradec::AbstractArray{<:Real};
                   parallax::AbstractArray{<:Real}=zeros(R, length(ra)),
                   radvel::AbstractArray{<:Real}=zeros(R, length(ra))) where {R<:Real}
-    @assert length(ra) == length(dec) == size(muradec)[2] == length(parallax) == length(radvel)
+    if !(length(ra) == length(dec) == size(muradec, 2) == length(parallax) == length(radvel))
+        throw(ArgumentError(
+            "ra, dec, muradec[:,2], parallax, and radvel arrays should be of the same length"))
+    end
     typer = float(R)
     ra1950  = similar(ra, typer)
     dec1950 = similar(dec, typer)
@@ -104,7 +109,9 @@ end
 
 function bprecess(ra::AbstractArray{R}, dec::AbstractArray{D},
                   epoch::Real=2000.0) where {R<:Real,D<:Real}
-    @assert length(ra) == length(dec)
+    if length(ra) != length(dec)
+        throw(ArgumentError("ra and dec arrays should be of the same length"))
+    end
     typer = float(R)
     ra1950  = similar(ra, typer)
     dec1950 = similar(dec, typer)

diff --git a/src/co_aberration.jl b/src/co_aberration.jl
@@ -84,7 +84,9 @@ co_aberration(jd::Real, ra::Real, dec::Real, eps::Real=NaN) =
 
 function co_aberration(jd::AbstractVector{R}, ra::AbstractVector{R},
                        dec::AbstractVector{R}, eps::Real=NaN) where {R<:Real}
-    @assert length(jd) == length(ra) == length(dec) "jd, ra and dec vectors should be of the same length"
+    if !(length(jd) == length(ra) == length(dec))
+        throw(ArgumentError("jd, ra and dec vectors should be of the same length"))
+    end
     typejd = float(R)
     ra_out  = similar(ra,  typejd)
     dec_out = similar(dec, typejd)

diff --git a/src/co_nutate.jl b/src/co_nutate.jl
@@ -87,8 +87,9 @@ co_nutate(jd::Real, ra::Real, dec::Real) =
 
 function co_nutate(jd::AbstractVector{P}, ra::AbstractVector{<:Real},
                    dec::AbstractVector{<:Real}) where {P<:Real}
-    @assert length(jd) == length(ra) == length(dec) "jd, ra and dec vectors
-                                                     should be of the same length"
+    if !(length(jd) == length(ra) == length(dec))
+        throw(ArgumentError("jd, ra and dec vectors should be of the same length"))
+    end
     typejd = float(P)
     ra_out  = similar(jd,  typejd)
     dec_out = similar(dec, typejd)

diff --git a/src/deredd.jl b/src/deredd.jl
@@ -56,7 +56,9 @@ deredd(Eby::Real, by::Real, m1::Real, c1::Real, ub::Real) =
 function deredd(Eby::AbstractArray{E}, by::AbstractArray{<:Real},
                 m1::AbstractArray{<:Real}, c1::AbstractArray{<:Real},
                 ub::AbstractArray{<:Real}) where {E<:Real}
-    @assert length(Eby) == length(by) == length(m1) == length(c1) == length(ub)
+    if !(length(Eby) == length(by) == length(m1) == length(c1) == length(ub))
+        throw(ArgumentError("Eby, by, m1, c1, and ub arrays should be of the same length"))
+    end
     typeeby = float(E)
     by0 = similar(Eby, typeeby)
     m0  = similar(Eby, typeeby)

diff --git a/src/eci2geo.jl b/src/eci2geo.jl
@@ -85,7 +85,9 @@ eci2geo(xyz::Tuple{Real, Real, Real}, jd::Real) =
 
 function eci2geo(x::AbstractArray{X}, y::AbstractArray{<:Real}, z::AbstractArray{<:Real},
                  jd::AbstractArray{<:Real}) where {X<:Real}
-    @assert length(x) == length(y) == length(z) == length(jd)
+    if !(length(x) == length(y) == length(z) == length(jd))
+        throw(ArgumentError("x, y, z, and jd arrays should be of the same length"))
+    end
     typex = float(X)
     lat  = similar(x, typex)
     long = similar(x, typex)

diff --git a/src/eqpole.jl b/src/eqpole.jl
@@ -61,7 +61,9 @@ eqpole(l::Real, b::Real; southpole::Bool=false) =
 
 function eqpole(l::AbstractArray{L}, b::AbstractArray{<:Real};
                 southpole::Bool=false) where {L<:Real}
-    @assert length(l) == length(b)
+    if length(l) != length(b)
+        throw(ArgumentError("l and b arrays should be of the same length"))
+    end
     typel = float(L)
     x = similar(l, typel)
     y = similar(l, typel)

diff --git a/src/euler.jl b/src/euler.jl
@@ -3,7 +3,8 @@
 function _euler(ai::T, bi::T, select::Integer, FK4::Bool, radians::Bool) where {T<:AbstractFloat}
 
     if select>6 || select<1
-        error("Input for coordinate transformation should be an integer in the range 1:6")
+        throw(DomainError(
+            "Input for coordinate transformation should be an integer in the range 1:6"))
     end
 
     if FK4
@@ -98,7 +99,9 @@ euler(aibi::Tuple{Real, Real}, select::Integer; FK4::Bool=false, radians::Bool=f
 
 function euler(ai::AbstractVector{R}, bi::AbstractVector{<:Real}, select::Integer;
                FK4::Bool=false, radians::Bool=false) where {R<:Real}
-    @assert length(ai) == length(bi) "ai and bi arrays should be of the same length"
+    if length(ai) != length(bi)
+        throw(ArgumentError("ai and bi arrays should be of the same length"))
+    end
     typeai = float(R)
     ai_out  = similar(ai,  typeai)
     bi_out = similar(bi, typeai)

diff --git a/src/gal_uvw.jl b/src/gal_uvw.jl
@@ -131,8 +131,11 @@ function gal_uvw(ra::AbstractArray{R}, dec::AbstractArray{<:Real},
                  pmra::AbstractArray{<:Real}, pmdec::AbstractArray{<:Real},
                  vrad::AbstractArray{<:Real}, plx::AbstractArray{<:Real};
                  lsr::Bool=false) where {R<:Real}
-    @assert length(ra) == length(dec) == length(pmra) ==
-        length(pmdec) == length(vrad) == length(plx)
+    if !(length(ra) == length(dec) == length(pmra) ==
+         length(pmdec) == length(vrad) == length(plx))
+        throw(ArgumentError(
+            "ra, dec, pmra, pmdec, vrad, and plx arrays must all have the same length"))
+    end
     typer = float(R)
     u = similar(ra, typer)
     v = similar(ra, typer)

diff --git a/src/gcirc.jl b/src/gcirc.jl
@@ -23,7 +23,8 @@ function gcirc(units::Integer, ra1::T, dec1::T, ra2::T, dec2::T) where {T<:Abstr
         φ_2 = deg2rad(dec2)
     else
         # In any other case throw an error.
-        error("units must be 0 (radians), 1 (hours, degrees) or 2 (degrees)")
+        throw(DomainError(
+            "units must be 0 (radians), 1 (hours, degrees) or 2 (degrees)"))
     end
     Δφ_2 = (φ_2 - φ_1) * 0.5
     Δλ_2 = (λ_2 - λ_1) * 0.5

diff --git a/src/geo2eci.jl b/src/geo2eci.jl
@@ -78,7 +78,10 @@ geo2eci(lla::Tuple{Real, Real, Real}, jd::Real) =
 function geo2eci(lat::AbstractArray{LA}, long::AbstractArray{<:Real},
                  alt::AbstractArray{<:Real},
                  jd::AbstractArray{<:Real}) where {LA<:Real}
-    @assert length(lat) == length(long) == length(alt) == length(jd)
+    if !(length(lat) == length(long) == length(alt) == length(jd))
+        throw(ArgumentError(
+            "lat, long, alt, and jd arrays must have the same length"))
+    end
     typela = float(LA)
     x = similar(lat, typela)
     y = similar(lat, typela)

diff --git a/src/geo2geodetic.jl b/src/geo2geodetic.jl
@@ -159,7 +159,9 @@ geo2geodetic(lla::Tuple{Real, Real, Real}, eq::Real, pol::Real) =
 function geo2geodetic(lat::AbstractArray{LA}, long::AbstractArray{<:Real},
                       alt::AbstractArray{<:Real},
                       eq::Real, pol::Real) where {LA<:Real}
-    @assert length(lat) == length(long) == length(alt)
+    if !(length(lat) == length(long) == length(alt))
+        throw(ArgumentError("lat, long, and alt arrays must have the same length"))
+    end
     typela  = float(LA)
     outlat  = similar(lat, typela)
     outlong = similar(lat, typela)
@@ -183,7 +185,9 @@ geo2geodetic(lla::Tuple{Real, Real, Real}, planet::AbstractString="earth") =
 function geo2geodetic(lat::AbstractArray{LA}, long::AbstractArray{<:Real},
                       alt::AbstractArray{<:Real},
                       planet::AbstractString="earth") where {LA<:Real}
-    @assert length(lat) == length(long) == length(alt)
+    if !(length(lat) == length(long) == length(alt))
+        throw(ArgumentError("lat, long, and alt arrays must have the same length"))
+    end
     typela  = float(LA)
     outlat  = similar(lat, typela)
     outlong = similar(lat, typela)

diff --git a/src/geo2mag.jl b/src/geo2mag.jl
@@ -89,7 +89,9 @@ geo2mag(lat::Real, long::Real, year::Real=Dates.year(Dates.now())) =
 
 function geo2mag(lat::AbstractArray{LA}, long::AbstractArray{<:Real},
                  year::Real=Dates.year(Dates.now())) where {LA<:Real}
-    @assert length(lat) == length(long)
+    if length(lat) != length(long)
+        throw(ArgumentError("lat and long arrays should be of the same length"))
+    end
     typela   = float(LA)
     maglat   = similar(lat, typela)
     maglong  = similar(lat, typela)

diff --git a/src/geodetic2geo.jl b/src/geodetic2geo.jl
@@ -126,7 +126,9 @@ geodetic2geo(lla::Tuple{Real, Real, Real}, eq::Real, pol::Real) =
 function geodetic2geo(lat::AbstractArray{LA}, long::AbstractArray{<:Real},
                       alt::AbstractArray{<:Real}, eq::Real,
                       pol::Real) where {LA<:Real}
-    @assert length(lat) == length(long) == length(alt)
+    if !(length(lat) == length(long) == length(alt))
+        throw(ArgumentError("lat, long, and alt arrays must have the same length"))
+    end
     typela  = float(LA)
     outlat  = similar(lat, typela)
     outlong = similar(lat, typela)
@@ -151,7 +153,9 @@ function geodetic2geo(lat::AbstractArray{LA},
                       long::AbstractArray{<:Real},
                       alt::AbstractArray{<:Real},
                       planet::AbstractString="earth") where {LA<:Real}
-    @assert length(lat) == length(long) == length(alt)
+    if !(length(lat) == length(long) == length(alt))
+        throw(ArgumentError("lat, long, and alt arrays must have the same length"))
+    end
     typela  = float(LA)
     outlat  = similar(lat, typela)
     outlong = similar(lat, typela)

diff --git a/src/hadec2altaz.jl b/src/hadec2altaz.jl
@@ -85,7 +85,9 @@ hadec2altaz(hadec::Tuple{Real, Real}, lat::Real; ws::Bool=false) =
 
 function hadec2altaz(ha::AbstractArray{R}, dec::AbstractArray{<:Real},
                      lat::AbstractArray{<:Real}; ws::Bool=false) where {R<:Real}
-    @assert length(ha) == length(dec) == length(lat)
+    if !(length(ha) == length(dec) == length(lat))
+        throw(ArgumentError("ha, dec, and lat arrays must have the same length"))
+    end
     typeha = float(R)
     alt = similar(ha, typeha)
     az  = similar(ha, typeha)

diff --git a/src/helio.jl b/src/helio.jl
@@ -18,7 +18,7 @@ const record = Dict(1=>"mercury", 2=>"venus", 3=>"earth", 4=>"mars", 5=>"jupiter
 function _helio(jd::T, num::Integer, radians::Bool) where {T<:AbstractFloat}
 
     if num<1 || num>9
-        error("Input should be an integer in the range 1:9 denoting planet number")
+        throw(DomainError("Input should be an integer in the range 1:9 denoting planet number"))
     end
     t = (jd - J2000) / JULIANCENTURY
     body = record[num]
@@ -115,8 +115,9 @@ helio(jd::Real, num::Integer, radians::Bool=false) =
 
 function helio(jd::AbstractVector{P}, num::AbstractVector{<:Real},
                radians::Bool = false) where {P<:Real}
-    @assert length(jd) == length(num) "jd and num vectors should
-                                       be of the same length"
+    if length(jd) != length(num)
+        throw(ArgumentError("jd and num vectors should be of the same length"))
+    end
     typejd = float(P)
     hrad_out = similar(jd,  typejd)
     hlong_out = similar(jd,  typejd)

diff --git a/src/imf.jl b/src/imf.jl
@@ -4,7 +4,8 @@ function imf(mass::AbstractVector{T}, expon::AbstractVector{T},
              mass_range::AbstractVector{T}) where {T<:AbstractFloat}
     ne_comp = length(expon)
     if length(mass_range) != ne_comp + 1
-        error("Length of array mass_range is not one more than that of expon")
+        throw(ArgumentError(
+            "Length of array mass_range is not one more than that of expon"))
     end
     integ = Vector{T}(undef, ne_comp)
     joint = ones(T, ne_comp)
@@ -19,10 +20,10 @@ function imf(mass::AbstractVector{T}, expon::AbstractVector{T},
             joint[i] = joint[i-1]*(mass_range[i]^(expon[i-1] - expon[i]))
         end
     end
-    norm = joint./(dot(integ, joint))
+    norm = joint ./ (dot(integ, joint))
     psi = fill!(similar(mass), 0)
     for i = 1:ne_comp
-        test = findall(mass_range[i].< mass.<mass_range[i+1])
+        test = findall(mass_range[i] .<  mass .< mass_range[i+1])
         if length(test) !=0
             psi[test] = norm[i].*(mass[test].^expon[i])
         end

diff --git a/src/jprecess.jl b/src/jprecess.jl
@@ -20,7 +20,9 @@ const Mjprec =
 # commented, in case someone is interested.
 function _jprecess(ra::T, dec::T, parallax::T, radvel::T, epoch::T,
                    muradec::Vector{T}) where {T<:AbstractFloat}
-    @assert length(muradec) == 2
+    if length(muradec) != 2
+        throw(DomainError("muradec must have length 2"))
+    end
     sinra, cosra  = sincos(deg2rad(ra))
     sindec, cosdec = sincos(deg2rad(dec))
     if isfinite(epoch) && epoch != 1950
@@ -94,7 +96,11 @@ function jprecess(ra::AbstractArray{R}, dec::AbstractArray{<:Real},
                   muradec::AbstractArray{<:Real};
                   parallax::AbstractArray{<:Real}=zeros(R, length(ra)),
                   radvel::AbstractArray{<:Real}=zeros(R, length(ra))) where {R<:Real}
-    @assert length(ra) == length(dec) == size(muradec)[2] == length(parallax) == length(radvel)
+    if !(length(ra) == length(dec) == size(muradec)[2] == length(parallax) == length(radvel))
+        # TODO write more helpful error message
+        throw(ArgumentError(
+            "ra, dec, muradec[:,2], parallax, and radvel must have the same length"))
+    end
     typer = float(R)
     ra2000  = similar(ra, typer)
     dec2000 = similar(dec, typer)
@@ -107,7 +113,9 @@ end
 
 function jprecess(ra::AbstractArray{R}, dec::AbstractArray{<:Real},
                   epoch::Real=1950.0) where {R<:Real}
-    @assert length(ra) == length(dec)
+    if length(ra) != length(dec)
+        throw(ArgumentError("ra and dec arrays should be of the same length"))
+    end
     typer = float(R)
     ra2000  = similar(ra, typer)
     dec2000 = similar(dec, typer)

diff --git a/src/juldate.jl b/src/juldate.jl
@@ -62,10 +62,11 @@ function juldate(dt::DateTime)
         Dates.hour(dt), Dates.minute(dt),
         Dates.second(dt), Dates.millisecond(dt)
 
+    if year == 0
+        throw(DomainError("There is no year zero in Julian Calendar"))
+    end
     if year < 0
         year += 1
-    elseif year == 0
-        error("There is no year zero in Julian Calendar")
     end
     # Do not include leap year in January and February.
     if month < 3

diff --git a/src/kepler_solver.jl b/src/kepler_solver.jl
@@ -2,7 +2,9 @@
 # Copyright (C) 2016 Mosè Giordano.
 
 function kepler_solver(_M::Real, e::Real)
-    @assert 0 <= e <= 1 "eccentricity must be in the range [0, 1]"
+    if e < 0 || e > 1
+        throw(DomainError("eccentricity must be in the range [0, 1]"))
+    end
     # M must be in the range [-pi, pi], see Markley (1995), page 2.
     M = rem2pi(_M, RoundNearest)
     T = float(promote_type(typeof(M), typeof(e)))

diff --git a/src/mag2geo.jl b/src/mag2geo.jl
@@ -93,7 +93,9 @@ mag2geo(lat::Real, long::Real, year::Real=Dates.year(Dates.now())) =
 
 function mag2geo(lat::AbstractArray{LA}, long::AbstractArray{LO},
                  year::Real=Dates.year(Dates.now())) where {LA<:Real, LO<:Real}
-    @assert length(lat) == length(long)
+    if length(lat) != length(long)
+        throw(ArgumentError("lat and long arrays should be of the same length"))
+    end
     typela   = float(LA)
     geolat   = similar(lat, typela)
     geolong  = similar(lat, typela)

diff --git a/src/ordinal.jl b/src/ordinal.jl
@@ -39,7 +39,7 @@ Code of this function is based on IDL Astronomy User's Library.
 """
 function ordinal(num::Integer)
     a = num % 100
-    if a== 11 || a == 12 || a == 13
+    if a == 11 || a == 12 || a == 13
         suffix = "th"
     else
         a = num % 10

diff --git a/src/planet_coords.jl b/src/planet_coords.jl
@@ -67,7 +67,9 @@ planet_coords(date::Real, num::Integer) = _planet_coords(float(date), num)
 
 function planet_coords(date::AbstractVector{R},
                        num::AbstractVector{<:Integer}) where {R<:Real}
-    @assert length(date) == length(num) "date and num arrays should be of the same length"
+    if length(date) != length(num)
+      throw(ArgumentError("date and num arrays should be of the same length"))
+    end
     typedate = float(R)
     ra_out  = similar(date, typedate)
     dec_out = similar(date, typedate)

diff --git a/src/polrec.jl b/src/polrec.jl
@@ -58,7 +58,9 @@ polrec(r_a::Tuple{Real, Real}; degrees::Bool=false) = polrec(r_a...,
 
 function polrec(r::AbstractArray{R}, a::AbstractArray{A};
                 degrees::Bool=false) where {R<:Real, A<:Real}
-    @assert length(r) == length(a)
+    if length(r) != length(a)
+        throw(ArgumentError("r and a arrays should be of the same length"))
+    end
     typer = float(R)
     x = similar(r, typer)
     y = similar(r, typer)

diff --git a/src/posang.jl b/src/posang.jl
@@ -23,7 +23,8 @@ function posang(units::Integer, ra1::T, dec1::T, ra2::T, dec2::T) where {T<:Abst
         dec2_rad = deg2rad(dec2)
     else
         # In any other case throw an error.
-        error("units must be 0 (radians), 1 (hours, degrees) or 2 (degrees)")
+        throw(DomainError(
+            "units must be 0 (radians), 1 (hours, degrees) or 2 (degrees)"))
     end
     sin_radif, cos_radif = sincos(ra2_rad - ra1_rad)
     sin_dec1, cos_dec1 = sincos(dec1_rad)