Remove superfluous methods and extend unit test coverage

src/dynamics/ParticleDynamics.jl

@@ -134,12 +134,6 @@ A constructor helper for `ParticleDynamicCache`. Calls [`ConsensusBasedX.constru
 """
 construct_particle_dynamic_cache
 
-@config construct_method_cache(
-  X₀::AbstractArray,
-  method::CBXMethod,
-  particle_dynamic::ParticleDynamic,
-) = nothing
-
 function initialise_particle_dynamic_cache!(
   X₀::AbstractArray,
   particle_dynamic::ParticleDynamic,
@@ -190,13 +184,3 @@ function set_Δt!(
 )
   return nothing
 end
-
-function initialise_method_cache!(
-  X₀::AbstractArray,
-  method::CBXMethod,
-  method_cache::CBXMethodCache,
-  particle_dynamic::ParticleDynamic,
-  particle_dynamic_cache::ParticleDynamicCache,
-)
-  return nothing
-end

src/dynamics/run_dynamic.jl

@@ -53,15 +53,6 @@ function initialise_dynamic!(
   return nothing
 end
 
-function initialise_method!(
-  method::CBXMethod,
-  method_cache::CBXMethodCache,
-  particle_dynamic::ParticleDynamic,
-  particle_dynamic_cache::ParticleDynamicCache,
-)
-  return nothing
-end
-
 function compute_dynamic!(
   particle_dynamic::ParticleDynamic,
   particle_dynamic_cache::ParticleDynamicCache{<:Modes, <:Parallelisations},
@@ -137,16 +128,6 @@ function prepare_method_step!(
   return nothing
 end
 
-function compute_method_step!(
-  method::CBXMethod,
-  method_cache::CBXMethodCache,
-  particle_dynamic::ParticleDynamic,
-  particle_dynamic_cache::ParticleDynamicCache,
-  m::Int,
-)
-  return nothing
-end
-
 function update_dynamic!(
   particle_dynamic::ParticleDynamic,
   particle_dynamic_cache::ParticleDynamicCache,
@@ -156,16 +137,6 @@ function update_dynamic!(
   return nothing
 end
 
-function finalise_method_step!(
-  method::CBXMethod,
-  method_cache::CBXMethodCache,
-  particle_dynamic::ParticleDynamic,
-  particle_dynamic_cache::ParticleDynamicCache,
-  m::Int,
-)
-  return nothing
-end
-
 function finalise_dynamic!(
   particle_dynamic::ParticleDynamic,
   particle_dynamic_cache::ParticleDynamicCache,
@@ -201,22 +172,3 @@ function wrap_output(
     particle_dynamic_cache,
   )
 end
-
-function wrap_output(
-  X₀::AbstractArray,
-  method::CBXMethod,
-  method_cache::CBXMethodCache,
-  particle_dynamic::ParticleDynamic,
-  particle_dynamic_cache::ParticleDynamicCache,
-)
-  initial_particles = X₀
-  final_particles = particle_dynamic_cache.X
-  return (;
-    initial_particles,
-    final_particles,
-    method,
-    method_cache,
-    particle_dynamic,
-    particle_dynamic_cache,
-  )
-end

src/interface/parse_config.jl

@@ -28,41 +28,35 @@ end
 parse_config_default(config::NamedTuple) = merge(DEFAULT_PARSED_CONFIG, config)
 
 function parse_config_mode(config::NamedTuple)
-  if (haskey(config, :mode))
-    mode = config.mode
-    mode = (mode isa String) ? Symbol(mode) : mode
-    mode = (mode isa Symbol) ? Val(mode) : mode
-    if mode isa Val
-      if !(mode isa Modes)
-        explanation = "The selected `mode` is not recognised as an instance of `ConsensusBasedX.Modes`."
-        throw(ArgumentError(explanation))
-      end
-    else
-      explanation = "The keyword `mode` should be a `Symbol`, a `String`, or an instance of `ConsensusBasedX.Modes`."
+  mode = config.mode
+  mode = (mode isa String) ? Symbol(mode) : mode
+  mode = (mode isa Symbol) ? Val(mode) : mode
+  if mode isa Val
+    if !(mode isa Modes)
+      explanation = "The selected `mode` is not recognised as an instance of `ConsensusBasedX.Modes`."
       throw(ArgumentError(explanation))
     end
-    return merge(config, (; mode))
+  else
+    explanation = "The keyword `mode` should be a `Symbol`, a `String`, or an instance of `ConsensusBasedX.Modes`."
+    throw(ArgumentError(explanation))
   end
-  return config
+  return merge(config, (; mode))
 end
 
 function parse_config_noise(config::NamedTuple)
-  if (haskey(config, :noise))
-    noise = config.noise
-    noise = (noise isa String) ? Symbol(noise) : noise
-    noise = (noise isa Symbol) ? Val(noise) : noise
-    if noise isa Val
-      if !(noise isa Noises)
-        explanation = "The selected `noise` is not recognised as an instance of `ConsensusBasedX.Noises`."
-        throw(ArgumentError(explanation))
-      end
-    else
-      explanation = "The keyword `noise` should be a `Symbol`, a `String`, or an instance of `ConsensusBasedX.Noises`."
+  noise = config.noise
+  noise = (noise isa String) ? Symbol(noise) : noise
+  noise = (noise isa Symbol) ? Val(noise) : noise
+  if noise isa Val
+    if !(noise isa Noises)
+      explanation = "The selected `noise` is not recognised as an instance of `ConsensusBasedX.Noises`."
       throw(ArgumentError(explanation))
     end
-    return merge(config, (; noise))
+  else
+    explanation = "The keyword `noise` should be a `Symbol`, a `String`, or an instance of `ConsensusBasedX.Noises`."
+    throw(ArgumentError(explanation))
   end
-  return config
+  return merge(config, (; noise))
 end
 
 function parse_config_root(config::NamedTuple)
@@ -85,22 +79,19 @@ function parse_config_root(config::NamedTuple)
 end
 
 function parse_config_parallelisation(config::NamedTuple)
-  if (haskey(config, :parallelisation))
-    parallelisation = config.parallelisation
-    parallelisation =
-      (parallelisation isa String) ? Symbol(parallelisation) : parallelisation
-    parallelisation =
-      (parallelisation isa Symbol) ? Val(parallelisation) : parallelisation
-    if parallelisation isa Val
-      if !(parallelisation isa Parallelisations)
-        explanation = "The selected `parallelisation` is not recognised as an instance of `ConsensusBasedX.Parallelisations`."
-        throw(ArgumentError(explanation))
-      end
-    else
-      explanation = "The keyword `parallelisation` should be a `Symbol`, a `String`, or an instance of `ConsensusBasedX.Parallelisations`."
+  parallelisation = config.parallelisation
+  parallelisation =
+    (parallelisation isa String) ? Symbol(parallelisation) : parallelisation
+  parallelisation =
+    (parallelisation isa Symbol) ? Val(parallelisation) : parallelisation
+  if parallelisation isa Val
+    if !(parallelisation isa Parallelisations)
+      explanation = "The selected `parallelisation` is not recognised as an instance of `ConsensusBasedX.Parallelisations`."
       throw(ArgumentError(explanation))
     end
-    return merge(config, (; parallelisation))
+  else
+    explanation = "The keyword `parallelisation` should be a `Symbol`, a `String`, or an instance of `ConsensusBasedX.Parallelisations`."
+    throw(ArgumentError(explanation))
   end
-  return config
+  return merge(config, (; parallelisation))
 end

src/utils/arrays.jl

@@ -10,21 +10,6 @@ end
 
 Base.reshape(x::AbstractArray{<:AbstractArray}, mode::TParticleMode) = x
 
-function reverse_reshape(
-  x::AbstractVector{<:AbstractVector{<:AbstractVector{<:Number}}},
-)
-  M = length(x)
-  N = length(x[1])
-  D = length(x[1][1])
-  return [x[m][n][d] for d ∈ 1:D, n ∈ 1:N, m ∈ 1:M]
-end
-
-function reverse_reshape(x::AbstractVector{<:AbstractMatrix{<:Number}})
-  M = length(x)
-  D, N = size(x[1])
-  return [x[m][d, n] for d ∈ 1:D, n ∈ 1:N, m ∈ 1:M]
-end
-
 function deep_add!(
   dest::AbstractArray{<:Any, N},
   src::AbstractArray{<:Any, N},
@@ -84,7 +69,3 @@ end
 nested_zeros(type::Type, dim) = zeros(type, dim)
 
 nested_zeros(type::Type, dim::Int, dim2) = [zeros(type, dim2) for k ∈ 1:dim]
-
-function nested_zeros(type::Type, dim::Int, dim2::Int, dim3)
-  return [zeros(type, dim2, dim3) for k ∈ 1:dim]
-end

test/interface/initialise_particles.jl

@@ -1,5 +1,7 @@
 using ConsensusBasedX, Test
 
+import LinearAlgebra
+
 function tests()
   config =
     (; D = 3, N = 2, M = 1, mode = ConsensusBasedX.ParticleMode, verbosity = 0)
@@ -14,6 +16,16 @@ function tests()
     (; initial_particles = rand(1, 2, 3)),
   )))
 
+  @test_throws ArgumentError ConsensusBasedX.initialise_particles((merge(
+    config,
+    (; initial_particles = rand(3, 2)),
+  )))
+
+  @test_throws ArgumentError ConsensusBasedX.initialise_particles((merge(
+    config,
+    (; initial_particles = rand(3, 2, 1, 4)),
+  )))
+
   X₀ = ConsensusBasedX.initialise_particles((merge(
     config,
     (; initialisation = :uniform),
@@ -53,6 +65,13 @@ function tests()
         all(map(s -> abs(s - 2) <= 0.1, X₀[2, :, :])) &&
         all(map(s -> abs(s - 3) <= 0.1, X₀[3, :, :]))
 
+  X₀ = ConsensusBasedX.initialise_particles_uniform(
+    merge(config, (; initial_guess = [1, 2, 3], initial_diameter = 0.2)),
+  )
+  @test all(map(s -> abs(s - 1) <= 0.1, X₀[1, :, :])) &&
+        all(map(s -> abs(s - 2) <= 0.1, X₀[2, :, :])) &&
+        all(map(s -> abs(s - 3) <= 0.1, X₀[3, :, :]))
+
   X₀ = ConsensusBasedX.initialise_particles_uniform(
     merge(
       config,
@@ -111,6 +130,16 @@ function tests()
         all(map(s -> s == 2, X₀[2, :, :])) &&
         all(map(s -> s == 3, X₀[3, :, :]))
 
+  @test_nowarn ConsensusBasedX.initialise_particles_normal((merge(
+    config,
+    (; initial_mean = [1, 2, 3], initial_covariance = [1 0 0; 0 1 0; 0 0 1]),
+  )))
+
+  @test_throws LinearAlgebra.PosDefException ConsensusBasedX.initialise_particles_normal((merge(
+    config,
+    (; initial_mean = [1, 2, 3], initial_covariance = zeros(3, 3)),
+  )))
+
   X₀ = ConsensusBasedX.initialise_particles_normal((merge(
     config,
     (; initial_mean = [1, 2, 3], initial_variance = [1, 0, 0]),

test/interface/maximise.jl

@@ -2,19 +2,20 @@ using ConsensusBasedX, Test
 
 function tests()
   alloc(x) = Base.gc_alloc_count(x.gcstats)
+  f(x) = -ConsensusBasedX.Quadratic(x, shift = 1)
+  g(x) = -ConsensusBasedX.Ackley(x, shift = 1)
+  h(x) = -ConsensusBasedX.Rastrigin(x, shift = 1)
 
-  config = (; D = 2, benchmark = true)
+  config = (; D = 2,)
+  @test_nowarn maximise(f, config)
 
-  f(x) = -ConsensusBasedX.Quadratic(x, shift = 1)
-  @test alloc(maximise(f, config)) == 0
+  config = Dict(:D => 2)
+  @test_nowarn maximise(f, config)
 
-  g(x) = -ConsensusBasedX.Ackley(x, shift = 1)
+  config = (; D = 2, benchmark = true)
+  @test alloc(maximise(f, config)) == 0
   @test alloc(maximise(g, config)) == 0
-
-  h(x) = -ConsensusBasedX.Rastrigin(x, shift = 1)
   @test alloc(maximise(h, config)) == 0
-
-  return config = (; D = 2,)
 end
 
 tests()

test/interface/minimise.jl

@@ -1,20 +1,20 @@
 using ConsensusBasedX, Test
 
 function tests()
+  alloc(x) = Base.gc_alloc_count(x.gcstats)
   f(x) = ConsensusBasedX.Quadratic(x, shift = 1)
   g(x) = ConsensusBasedX.Ackley(x, shift = 1)
   h(x) = ConsensusBasedX.Rastrigin(x, shift = 1)
 
   config = (; D = 2,)
   @test_nowarn minimise(f, config)
 
-  alloc(x) = Base.gc_alloc_count(x.gcstats)
-  config = (; D = 2, benchmark = true)
+  config = Dict(:D => 2)
+  @test_nowarn minimise(f, config)
 
+  config = (; D = 2, benchmark = true)
   @test alloc(minimise(f, config)) == 0
-
   @test alloc(minimise(g, config)) == 0
-
   @test alloc(minimise(h, config)) == 0
 end
 

test/interface/parse_config.jl

@@ -3,6 +3,8 @@ using ConsensusBasedX, ConsensusBasedX.ConsensusBasedXLowLevel, Test
 function tests()
   @test_throws ArgumentError parse_config(NamedTuple())
 
+  @test_nowarn parse_config((; D = 2))
+
   @test_throws ArgumentError parse_config((; D = 2, mode = "wrongMode"))
   @test_throws ArgumentError parse_config((; D = 2, mode = :wrongMode))
   @test_throws ArgumentError parse_config((; D = 2, mode = 1.0))
@@ -11,6 +13,10 @@ function tests()
   @test_throws ArgumentError parse_config((; D = 2, noise = :wrongNoise))
   @test_throws ArgumentError parse_config((; D = 2, noise = 1.0))
 
+  @test_throws ArgumentError parse_config((; D = 2, root = "wrongRoot"))
+  @test_throws ArgumentError parse_config((; D = 2, root = :wrongRoot))
+  @test_throws ArgumentError parse_config((; D = 2, root = 1.0))
+
   @test_throws ArgumentError parse_config((;
     D = 2,
     parallelisation = "wrongParallelisation",

test/interface/sample.jl

@@ -1,17 +1,26 @@
 using ConsensusBasedX, Test
 
 function tests()
+  alloc(x) = Base.gc_alloc_count(x.gcstats)
   f(x) = ConsensusBasedX.Quadratic(x, shift = 1)
 
+  config = (; D = 2,)
+  @test_nowarn sample(f, config)
+
+  config = Dict(:D => 2)
+  @test_nowarn sample(f, config)
+
   config = (; D = 2, root = :SymmetricRoot)
   @test_nowarn sample(f, config)
 
   config = (; D = 2, root = :AsymmetricRoot)
   @test_nowarn sample(f, config)
 
-  alloc(x) = Base.gc_alloc_count(x.gcstats)
   config = (; D = 2, root = :AsymmetricRoot, benchmark = true)
-  @test alloc(minimise(f, config)) == 0
+  @test alloc(sample(f, config)) == 0
+
+  config = (; D = 2, CBS_mode = :wrongCBSMode)
+  @test_throws ArgumentError sample(f, config)
 end
 
 tests()

test/runtests.jl

@@ -14,6 +14,7 @@ using SafeTestsets, Test
     "interface/sample",
     "tuples/tuples",
     "tuples/types",
+    "utils/arrays",
     "aqua",
     "examples",
     "format",