CompatHelper: bump compat for LightSumTypes to 5, (keep existing compat) (#1103)

Co-authored-by: Adriano Meligrana <[email protected]>
Co-authored-by: George Datseris <[email protected]>
Co-authored-by: CompatHelper Julia <[email protected]>

Author: 4 people

Project.toml

@@ -53,7 +53,7 @@ Graphs = "1.4"
 JLD2 = "0.4, 0.5"
 LazyArtifacts = "1.3"
 LightOSM = "0.2, 0.3"
-LightSumTypes = "4"
+LightSumTypes = "5"
 LinearAlgebra = "1"
 MacroTools = "0.5"
 Makie = "0.20, 0.21"

src/deprecations.jl

@@ -391,97 +391,3 @@ function nearby_agents_exact(a, model, r=1)
     @warn "`nearby_agents_exact` is deprecated in favor of `nearby_agents(...; search=:exact)`." maxlog=1
     return (model[id] for id in nearby_ids(a, model, r; search=:exact))
 end
-
-export @dispatch, @finalize_dispatch, kindof, allkinds
-export LightSumTypes
-using LightSumTypes: allkinds
-
-macro multiagent(version, struct_repr)
-    expr = _multiagent(version, struct_repr)
-    return esc(expr)
-end
-
-function _multiagent(version, struct_repr)
-    new_type, base_type_spec, abstract_type, agent_specs = decompose_struct_base(struct_repr)
-    base_fields = compute_base_fields(base_type_spec)
-    agent_specs_with_base = []
-    for a_spec in agent_specs
-        @capture(a_spec, @subagent astruct_spec_)
-        int_type, new_fields = decompose_struct(astruct_spec)
-        push!(agent_specs_with_base,
-              :(@kwdef mutable struct $int_type
-                    $(base_fields...)
-                    $(new_fields...)
-                end))
-    end
-    t = :($new_type <: $abstract_type)
-    c = @capture(new_type, new_type_n_{new_params__})
-    if c == false
-        new_type_n = new_type
-        new_params = []
-    end
-    new_params_no_constr = [p isa Expr && p.head == :(<:) ? p.args[1] : p for p in new_params]
-    new_type_no_constr = :($new_type_n{$(new_params_no_constr...)})
-    a_specs = :(begin $(agent_specs_with_base...) end)
-    if version == QuoteNode(:opt_speed)
-        expr = quote
-                   LightSumTypes.@sum_structs :on_fields $t $a_specs
-                   Agents.ismultiagentcompacttype(::Type{$(namify(new_type))}) = true
-                   LightSumTypes.export_variants($(namify(t)))
-               end
-    elseif version == QuoteNode(:opt_memory)
-        expr = quote
-                   LightSumTypes.@sum_structs :on_types $t $a_specs
-                   Agents.ismultiagentsumtype(::Type{$(namify(new_type))}) = true
-                   LightSumTypes.export_variants($(namify(t)))
-               end
-    else
-        error("The version of @multiagent chosen was not recognized, use either `:opt_speed` or `:opt_memory` instead.")
-    end
-
-    expr_multiagent = :(Agents.ismultiagenttype(::Type{$(namify(new_type))}) = true)
-    if new_params != []
-        if version == QuoteNode(:opt_speed)
-            expr_multiagent_p = quote
-                Agents.ismultiagenttype(::Type{$(new_type_no_constr)}) where {$(new_params...)} = true
-                Agents.ismultiagentcompacttype(::Type{$(new_type_no_constr)}) where {$(new_params...)} = true
-            end
-        else
-            expr_multiagent_p = quote
-                Agents.ismultiagenttype(::Type{$(new_type_no_constr)}) where {$(new_params...)} = true
-                Agents.ismultiagentsumtype(::Type{$(new_type_no_constr)}) where {$(new_params...)} = true
-            end
-        end
-    else
-        expr_multiagent_p = :()
-    end
-
-    expr = quote
-               $expr
-               $expr_multiagent
-               $expr_multiagent_p
-               nothing
-           end
-
-    return expr
-end
-
-ismultiagenttype(::Type) = false
-ismultiagentsumtype(::Type) = false
-ismultiagentcompacttype(::Type) = false
-
-function LightSumTypes.kindof(a::AbstractAgent)
-    throw(ArgumentError("Agent of type $(typeof(a)) has not been created via `@multiagent`."))
-end
-
-function LightSumTypes.allkinds(a::Type{<:AbstractAgent})
-    (nameof(a), ) # this function is extended automatically in the macro
-end
-
-macro dispatch(f_def)
-    return esc(:(LightSumTypes.@pattern $f_def))
-end
-
-macro finalize_dispatch()
-    return esc(:(LightSumTypes.@finalize_patterns))
-end

src/precompile.jl

@@ -27,27 +27,5 @@ using PrecompileTools
                     c::Int16
                 end)
         _agent(expr)
-        expr = :(struct A(NoSpaceAgent) <: AbstractA
-                    @subagent struct B
-                        x::Int
-                    end
-                    @subagent struct C
-                        y::Int
-                    end
-                end)
-        _multiagent(QuoteNode(:opt_memory), expr)
-        _multiagent(QuoteNode(:opt_speed), expr)    
-        expr = :(struct A{X}(GridAgent{2})
-                    @subagent struct B
-                        x::Bool = false
-                        y::Int
-                    end
-                    @subagent struct C{X<:Real}
-                        y::Int
-                        z::X
-                    end
-                end)
-        _multiagent(QuoteNode(:opt_memory), expr)
-        _multiagent(QuoteNode(:opt_speed), expr)
     end
 end

src/spaces/nothing.jl

@@ -7,7 +7,7 @@ otherwise they will try to add `nothing` to the agent position.
 
 # We need to extend this one, because otherwise there is a `pos` that
 # is attempted to be given to the agent creation...
-function add_agent!(A::Type, model::ABM{Nothing}, args::Vararg{Any, N}; kwargs...) where {N} 
+function add_agent!(A::Union{Function, Type}, model::ABM{Nothing}, args::Vararg{Any, N}; kwargs...) where {N} 
     id = nextid(model)
     if !isempty(args)
         newagent = A(id, args...)

test/api_tests.jl

@@ -350,75 +350,53 @@ end
     @test agent2.pos == (2, 4)
 end
 
-@multiagent :opt_memory struct Animal{T,N,J}(GridAgent{2})
-    @subagent struct Wolf{T,N}
-        energy::T = 0.5
-        ground_speed::N
-        const fur_color::Symbol
-    end
-    @subagent struct Hawk{T,N,J}
-        energy::T = 0.1
-        ground_speed::N
-        flight_speed::J
-    end
+@agent struct Wolf{T,N}(GridAgent{2})
+    energy::T = 0.5
+    ground_speed::N
+    const fur_color::Symbol
 end
 
-@multiagent :opt_speed struct A{T}(NoSpaceAgent)
-    @subagent struct B{T}
-        a::T = 1
-        b::Int
-        c::Symbol
-    end
-    @subagent struct C
-        b::Int = 2
-        c::Symbol
-        d::Vector{Int}
-    end
-    @subagent struct D{T}
-        c::Symbol = :k
-        d::Vector{Int}
-        a::T
-    end
+@agent struct Hawk{T,N,J}(GridAgent{2})
+    energy::T = 0.1
+    ground_speed::N
+    flight_speed::J
 end
 
-abstract type AbstractE <: AbstractAgent end
-@multiagent struct E(NoSpaceAgent) <: AbstractE
-    @subagent struct F
-        x::Int
-    end
-    @subagent struct G
-        y::Int
-    end
-end
+@multiagent Animal(Wolf, Hawk)
 
-@multiagent :opt_speed struct MultiSchelling1{X}(GridAgent{2})
-    @subagent struct Civilian1 # can't re-define existing `Schelling` name
-        mood::Bool = false
-        group::Int
-    end
-    @subagent struct Governor1{X<:Real} # can't redefine existing `Politician` name
-        group::Int
-        influence::X
-    end
+@agent struct B{T}(NoSpaceAgent)
+    a::T = 1
+    b::Int
+    c::Symbol
 end
+@agent struct C(NoSpaceAgent)
+    b::Int = 2
+    c::Symbol
+    d::Vector{Int}
+end
+@agent struct D{T}(NoSpaceAgent)
+    c::Symbol = :k
+    d::Vector{Int}
+    a::T
+end
+@multiagent A(B,C,D)
 
-@multiagent :opt_memory struct MultiSchelling2{X}(GridAgent{2})
-    @subagent struct Civilian2 # can't re-define existing `Schelling` name
-        mood::Bool = false
-        group::Int
-    end
-    @subagent struct Governor2{X<:Real} # can't redefine existing `Politician` name
-        group::Int
-        influence::X
-    end
+abstract type AbstractE <: AbstractAgent end
+
+@agent struct F(NoSpaceAgent)
+    x::Int
 end
+@agent struct G(NoSpaceAgent)
+    y::Int
+end
+@multiagent E(F,G) <: AbstractE
 
 @testset "@multiagent macro" begin
 
-    hawk_1 = Hawk(1, (1, 1), 1.0, 2.0, 3)
-    hawk_2 = Hawk(; id = 2, pos = (1, 2), ground_speed = 2.3, flight_speed = 2)
-    wolf_1 = Wolf(3, (2, 2), 2.0, 3.0, :black)
-    wolf_2 = Wolf(; id = 4, pos = (2, 1), ground_speed = 2.0, fur_color = :white)
+    hawk_1 = (Animal∘Hawk)(1, (1, 1), 1.0, 2.0, 3)
+    hawk_2 = (Animal∘Hawk)(; id = 2, pos = (1, 2), ground_speed = 2.3, flight_speed = 2)
+    wolf_1 = (Animal∘Wolf)(3, (2, 2), 2.0, 3.0, :black)
+    wolf_2 = (Animal∘Wolf)(; id = 4, pos = (2, 1), ground_speed = 2.0, fur_color = :white)
 
     @test hawk_1.energy == 1.0
     @test hawk_2.energy == 0.1
@@ -430,31 +408,31 @@ end
     @test wolf_2.fur_color == :white
     @test_throws "" hawk_1.fur_color
     @test_throws "" wolf_1.flight_speed
-    @test kindof(hawk_1) == kindof(hawk_2) == :Hawk
-    @test kindof(wolf_1) == kindof(wolf_2) == :Wolf
+    @test variant(hawk_1) isa Hawk && variant(hawk_2) isa Hawk
+    @test variant(wolf_1) isa Wolf && variant(wolf_2) isa Wolf
 
     fake_step!(a) = nothing
     model = StandardABM(Animal, GridSpace((5, 5)); agent_step! = fake_step!)
 
-    add_agent!(Hawk, model, 1.0, 2.0, 3)
-    add_agent!(Wolf, model, 2.0, 3.0, :black)
+    add_agent!(Animal∘Hawk, model, 1.0, 2.0, 3)
+    add_agent!(Animal∘Wolf, model, 2.0, 3.0, :black)
     @test nagents(model) == 2
     sample!(model, 2)
     @test nagents(model) == 2
 
-    b1 = B(1, 2, 1, :s)
-    c1 = C(1, 1, :s, Int[])
-    d1 = D(1, :s, [1], 1.0)
-    b2 = B(; id = 1, b = 1, c = :s)
-    c2 = C(; id = 1, c = :s, d = [1,2])
-    d2 = D(; id = 1, d = [1], a = true)
+    b1 = (A∘B)(1, 2, 1, :s)
+    c1 = (A∘C)(1, 1, :s, Int[])
+    d1 = (A∘D)(1, :s, [1], 1.0)
+    b2 = (A∘B)(; id = 1, b = 1, c = :s)
+    c2 = (A∘C)(; id = 1, c = :s, d = [1,2])
+    d2 = (A∘D)(; id = 1, d = [1], a = true)
 
     @test b2.a == 1
     @test c2.b == 2
     @test d2.c == :k
-    @test kindof(b1) == kindof(b2) == :B
-    @test kindof(c1) == kindof(c2) == :C
-    @test kindof(d1) == kindof(d2) == :D
+    @test variant(b1) isa B && variant(b2) isa B
+    @test variant(c1) isa C && variant(c2) isa C
+    @test variant(d1) isa D && variant(d2) isa D
     @test_throws "" b2.d
     @test_throws "" c1.a
     @test_throws "" d1.b
@@ -466,33 +444,25 @@ end
 
     model = StandardABM(A; agent_step! = fake_step!)
 
-    add_agent!(B, model, 2, 1, :s)
-    add_agent!(C, model, 1, :s, Int[])
-    add_agent!(D, model, :s, [1], 1.0)
+    add_agent!(A∘B, model, 2, 1, :s)
+    add_agent!(A∘C, model, 1, :s, Int[])
+    add_agent!(A∘D, model, :s, [1], 1.0)
     @test nagents(model) == 3
     sample!(model, 2)
     @test nagents(model) == 2
 
-    f = F(1, 1)
-    g = G(2, 2)
+    f = (E∘F)(1, 1)
+    g = (E∘G)(2, 2)
 
     @test f.id == 1
     @test g.id == 2
     @test f.x == 1
     @test g.y == 2
     @test_throws "" f.y
     @test_throws "" g.x
-    @test kindof(f) == :F
-    @test kindof(g) == :G
+    @test variant(f) isa F
+    @test variant(g) isa G
     @test E <: AbstractE && E <: AbstractE
     @test f isa E && g isa E
-
-
-    civ = Civilian1(; id = 2, pos = (2, 2), group = 2)
-    gov = Governor1(; id = 3 , pos = (2, 2), group = 2, influence = 0.5)
-    civ = Civilian2(; id = 2, pos = (2, 2), group = 2)
-    gov = Governor2(; id = 3 , pos = (2, 2), group = 2, influence = 0.5)
-
-    @test_throws "" Governor1(; id = 3 , pos = (2, 2), group = 2, influence = im)
-    @test_throws "" Governor2(; id = 3 , pos = (2, 2), group = 2, influence = im)
 end
+