Add tests for fallback methods

docs/src/api.md

@@ -111,6 +111,7 @@ QUBOTools.State
 QUBOTools.AbstractSample
 QUBOTools.Sample
 QUBOTools.sample
+QUBOTools.hassample
 ```
 
 ```@docs

src/interface/fallback.jl

@@ -23,6 +23,8 @@ frame(src)           = frame(backend(src))
 id(src)              = id(backend(src))
 description(src)     = description(backend(src))
 metadata(src)        = metadata(backend(src))
+
+# Variables
 index(src, v)        = index(backend(src), v)
 hasindex(src, i)     = hasindex(backend(src), i)
 indices(src)         = indices(backend(src))
@@ -41,6 +43,7 @@ value(src, i)               = value(backend(src), i)
 reads(src)                  = reads(backend(src))
 reads(src, i)               = reads(backend(src), i)
 sample(src, i)              = sample(backend(src), i)
+hassample(src, i)           = hassample(backend(src), i)
 solution(src)               = solution(backend(src))
 start(src, args...; kws...) = start(backend(src), args...; kws...)
 attach!(src, x)             = attach!(backend(src), x)

src/interface/solution.jl

@@ -29,12 +29,19 @@ Returns the model's current solution.
 function solution end
 
 @doc raw"""
-    sample(model, i::Integer) where {T,U<:Integer}
+    sample(model, i::Integer)
 
 Returns the ``i``-th sample on the model's current solution, if available.
 """
 function sample end
 
+@doc raw"""
+    hassample(solution::AbstractSolution, i::Integer)
+
+Tells if the ``i``-th sample is available on the solution.
+"""
+function hassample end
+
 @doc raw"""
     state(sample::AbstractSample{T,U}) where {T,U<:Integer}
 

src/library/model/abstract.jl

@@ -2,6 +2,10 @@ function Base.isempty(model::AbstractModel)
     return iszero(dimension(model))
 end
 
+function Base.broadcastable(model::AbstractModel)
+    return Ref(model) # Broadcast over model as scalar
+end
+
 function indices(model::AbstractModel)
     return collect(1:dimension(model))
 end
@@ -42,20 +46,28 @@ function form(
 end
 
 # ~*~ Data queries ~*~ #
-function state(model::AbstractModel, index::Integer)
-    return state(solution(model), index)
+function hassample(model::AbstractModel, i::Integer)
+    return hassample(solution(model), i)
+end
+
+function sample(model::AbstractModel, i::Integer)
+    return sample(solution(model), i)
+end
+
+function state(model::AbstractModel, i::Integer)
+    return state(solution(model), i)
 end
 
 function reads(model::AbstractModel)
     return reads(solution(model))
 end
 
-function reads(model::AbstractModel, index::Integer)
-    return reads(solution(model), index)
+function reads(model::AbstractModel, i::Integer)
+    return reads(solution(model), i)
 end
 
-function value(model::AbstractModel, index::Integer)
-    return value(solution(model), index)
+function value(model::AbstractModel, i::Integer)
+    return value(solution(model), i)
 end
 
 function value(model::AbstractModel, ψ::State{U}) where {U}
@@ -67,9 +79,20 @@ dimension(model::AbstractModel)      = dimension(form(model))
 linear_size(model::AbstractModel)    = linear_size(form(model))
 quadratic_size(model::AbstractModel) = quadratic_size(form(model))
 
-# Queries: Topology
-topology(model::AbstractModel)             = topology(form(model))
-topology(model::AbstractModel, k::Integer) = adjacency(form(model), k)
+# Queries: Layout, Topology & Geometry
+topology(model::AbstractModel) = topology(form(model))
+geometry(model::AbstractModel) = geometry(topology(model))
+
+function geometry(g::AbstractGraph)
+    return NetworkLayout.layout(NetworkLayout.Shell(; Ptype = Float64), g)
+end
+
+function layout(model::AbstractModel)
+    g = QUBOTools.topology(model)
+    P = QUBOTools.geometry(g)
+
+    return Layout(g, P)
+end
 
 # Queries: Metadata
 function id(model::AbstractModel)
@@ -140,8 +163,8 @@ function Base.show(io::IO, model::AbstractModel)
         )
     else
         sol = solution(model)
-        n = length(sol)
-        z = sense(model) === Min ? value(sol[begin]) : value(sol[end])
+        n   = length(sol)
+        z   = value(sol, 1)
 
         print(
             io,
@@ -155,10 +178,3 @@ function Base.show(io::IO, model::AbstractModel)
 
     return nothing
 end
-
-function layout(model::AbstractModel)
-    g = QUBOTools.topology(model)
-    P = NetworkLayout.layout(NetworkLayout.Shell(; Ptype = Float64), g)
-
-    return Layout(g, P)
-end

src/library/model/model.jl

@@ -27,7 +27,7 @@ mutable struct Model{V,T,U,F<:AbstractForm{T}} <: AbstractModel{V,T,U}
         form::F;
         metadata::Union{Dict{String,Any},Nothing} = nothing,
         solution::Union{SampleSet{T,U},Nothing} = nothing,
-        start::Union{Dict{Int,U},Nothing} = nothing,
+        start::Union{Dict{V,U},Nothing} = nothing,
         # Extra Metadata
         id::Union{Integer,Nothing} = nothing,
         description::Union{String,Nothing} = nothing,
@@ -36,14 +36,6 @@ mutable struct Model{V,T,U,F<:AbstractForm{T}} <: AbstractModel{V,T,U}
             metadata = Dict{String,Any}()
         end
 
-        if isnothing(solution)
-            solution = SampleSet{T,U}()
-        end
-
-        if isnothing(start)
-            start = Dict{Int,U}()
-        end
-
         if !isnothing(id)
             metadata["id"] = id
         end
@@ -52,7 +44,17 @@ mutable struct Model{V,T,U,F<:AbstractForm{T}} <: AbstractModel{V,T,U}
             metadata["description"] = description
         end
 
-        return new{V,T,U,F}(variable_map, form, metadata, solution, start)
+        model = new{V,T,U,F}(variable_map, form, metadata, SampleSet{T,U}(), Dict{Int,U}())
+
+        if !isnothing(solution)
+            attach!(model, solution)
+        end
+
+        if !isnothing(start)
+            attach!(model, start)
+        end
+
+        return model
     end
 end
 
@@ -64,7 +66,7 @@ function Model{V,T,U}(;
     domain::Union{Domain,Symbol} = :bool,
     metadata::Union{Dict{String,Any},Nothing} = nothing,
     solution::Union{SampleSet{T,U},Nothing} = nothing,
-    start::Union{Dict{Int,U},Nothing} = nothing,
+    start::Union{Dict{V,U},Nothing} = nothing,
     # Extra Metadata
     id::Union{Integer,Nothing} = nothing,
     description::Union{String,Nothing} = nothing,

src/library/solution/abstract.jl

@@ -6,6 +6,14 @@ state(s::AbstractSample, i::Integer) = getindex(state(s), i)
 # Solutions
 Base.size(sol::AbstractSolution) = (size(sol, 1),)
 
+function Base.size(sol::AbstractSolution, axis::Integer)
+    if axis == 1
+        return length(sol)
+    else
+        return 1
+    end
+end
+
 # Comparison
 function Base.:(==)(x::S, y::S) where {T,U,S<:AbstractSample{T,U}}
     return value(x) == value(y) && reads(x) == reads(y) && state(x) == state(y)
@@ -17,18 +25,24 @@ function Base.isapprox(x::S, y::S; kws...) where {T,U,S<:AbstractSample{T,U}}
            state(x) == state(y)
 end
 
-function Base.size(sol::AbstractSolution, axis::Integer)
-    if axis == 1
-        return length(sol)
-    else
-        return 1
-    end
-end
-
 Base.firstindex(::AbstractSolution)            = 1
 Base.firstindex(::AbstractSolution, ::Integer) = 1
 Base.lastindex(sol::AbstractSolution)          = length(sol)
 
+function hassample(sol::AbstractSolution, i::Integer)
+    return 1 <= i <= length(sol)
+end
+
+function sample(sol::AbstractSolution, i::Integer)
+    if hassample(sol, i)
+        return getindex(sol, i)
+    else
+        error("Sample with index '$i' does not belong to the solution")
+
+        return nothing
+    end
+end
+
 function Base.lastindex(sol::AbstractSolution, axis::Integer)
     if axis == 1
         return length(sol)
@@ -69,8 +83,8 @@ function Base.show(io::IO, sol::S) where {S<:AbstractSolution}
     return nothing
 end
 
-state(sol::AbstractSolution, i::Integer)             = state(getindex(sol, i))
-state(sol::AbstractSolution, i::Integer, j::Integer) = state(getindex(sol, i), j)
-value(sol::AbstractSolution, i::Integer)             = value(getindex(sol, i))
-reads(sol::AbstractSolution, i::Integer)             = reads(getindex(sol, i))
+state(sol::AbstractSolution, i::Integer)             = state(sample(sol, i))
+state(sol::AbstractSolution, i::Integer, j::Integer) = state(sample(sol, i), j)
+value(sol::AbstractSolution, i::Integer)             = value(sample(sol, i))
+reads(sol::AbstractSolution, i::Integer)             = reads(sample(sol, i))
 reads(sol::AbstractSolution)                         = sum(reads.(sol))

test/Project.toml

@@ -1,4 +1,5 @@
 [deps]
+Graphs = "86223c79-3864-5bf0-83f7-82e725a168b6"
 MathOptInterface = "b8f27783-ece8-5eb3-8dc8-9495eed66fee"
 Printf = "de0858da-6303-5e67-8744-51eddeeeb8d7"
 RecipesBase = "3cdcf5f2-1ef4-517c-9805-6587b60abb01"

test/runtests.jl

@@ -3,6 +3,7 @@ using Printf
 using SparseArrays
 using RecipesBase
 using QUBOTools
+using Graphs
 using MathOptInterface
 
 # using QUBODrivers