allows that the hints procedure also populates several points into th…

…e beam

src/searchgraph/beamsearch.jl

@@ -22,14 +22,14 @@ Base.copy(bsearch::BeamSearch; bsize=bsearch.bsize, Δ=bsearch.Δ, maxvisits=bse
 
 ### local search algorithm
 
-function beamsearch_init(bs::BeamSearch, index::SearchGraph, q, res::KnnResult, hints, vstate, bsize)
-    visited_ = approx_by_hints(index, q, hints, res, vstate)
+function beamsearch_init(bs::BeamSearch, index::SearchGraph, q, res::KnnResult, hints, vstate, bsize, beam)
+    visited_ = approx_by_hints(index, q, hints, res, vstate, beam)
 
     if length(res) == 0
         _range = 1:length(index)
         for _ in 1:bsize
            objID = rand(_range)
-           visited_ += enqueue_item!(index, q, database(index, objID), res, objID, vstate)
+           visited_ += enqueue_item!(index, q, database(index, objID), res, objID, vstate, beam)
         end
     end
 
@@ -86,7 +86,7 @@ Optional arguments (defaults to values in `bs`)
 function search(bs::BeamSearch, index::SearchGraph, context::SearchGraphContext, q, res, hints; bsize::Int32=bs.bsize, Δ::Float32=bs.Δ, maxvisits::Int=bs.maxvisits, vstate::Vector{UInt64}=getvstate(length(index), context))
     # k is the number of neighbors in res
     vstate = PtrArray(vstate)
-    visited_ = beamsearch_init(bs, index, q, res, hints, vstate, bsize)
     beam = getbeam(bsize, context)
+    visited_ = beamsearch_init(bs, index, q, res, hints, vstate, bsize, beam)
     beamsearch_inner(bs, index, q, res, vstate, beam, Δ, maxvisits, visited_)
 end

src/searchgraph/graph.jl

@@ -41,14 +41,16 @@ Base.copy(G::SearchGraph;
 @inline Base.length(g::SearchGraph)::Int64 = g.len[]
 
 """
-    enqueue_item!(index::SearchGraph, q, obj, res::KnnResult, objID, vstate)
+    enqueue_item!(index::SearchGraph, q, obj, res::KnnResult, objID, vstate, beam)
 
 Internal function that evaluates the distance between a database object `obj` with id `objID` and the query `q`.
 It helps to evaluate, mark as visited, and enqueue in the result set.
 """
-@inline function enqueue_item!(index::SearchGraph, q, obj, res::KnnResult, objID, vstate)::Int
+@inline function enqueue_item!(index::SearchGraph, q, obj, res::KnnResult, objID, vstate, beam)::Int
     check_visited_and_visit!(vstate, convert(UInt64, objID)) && return 0
-    push_item!(res, objID, evaluate(distance(index), q, database(index, objID)))
+    d = evaluate(distance(index), q, database(index, objID))
+    push_item!(res, objID, d)
+    beam !== nothing && push_item!(beam, objID, d)
     1
 end
 

src/searchgraph/hints.jl

@@ -1,15 +1,15 @@
 # This file is a part of SimilaritySearch.jl
 #
 """
-    approx_by_hints(index::SearchGraph, q, hints, res::KnnResult, vstate)
+    approx_by_hints(index::SearchGraph, q, hints, res::KnnResult, vstate, beam)
 
 Approximate the result using a set of hints (the set of identifiers (integers)) behints  `hints`
 """
-function approx_by_hints(index::SearchGraph, q, hints::T, res::KnnResult, vstate) where T<:Union{AbstractVector,Tuple,Integer,Set}
+function approx_by_hints(index::SearchGraph, q, hints::T, res::KnnResult, vstate, beam) where T<:Union{AbstractVector,Tuple,Integer,Set}
     visited = 0
     for objID in hints
         obj = database(index, objID)
-        visited += enqueue_item!(index, q, obj, res, objID, vstate)
+        visited += enqueue_item!(index, q, obj, res, objID, vstate, beam)
     end
 
     visited
@@ -30,11 +30,11 @@ end
 
 
 
-function approx_by_hints(index::SearchGraph, q, h::AdjacentStoredHints, res::KnnResult, vstate)
+function approx_by_hints(index::SearchGraph, q, h::AdjacentStoredHints, res::KnnResult, vstate, beam)
     visited = 0
     for (i, objID) in enumerate(h.map)
         obj = h.hints[i]
-        visited += enqueue_item!(index, q, obj, res, objID, vstate)
+        visited += enqueue_item!(index, q, obj, res, objID, vstate, beam)
     end
 
     visited