module Fzy

Overview

This class should be used if you plan to do more than one search on the same haystack.

It's the same of doing collection.map { |e| Hay.new(e) }

haystack = %w(dog cat bat tiger)
prepared_haystack = PreparedHaystack.new(haystack)
Fzy.search(prepared_haystack).each do |match|
  puts "found #{match.value} with score #{match.score}"
end

Extended Modules

• Fzy

Defined in:

Constant Summary

BonusProc = Proc(String, Array(Float32))

VERSION = {{ (`shards version /srv/crystaldoc.info/github-hugopl-fzy-v0.6.0/src`).strip.stringify }}

Instance Method Summary

• #filepath_bonus(key : String) : Array(Float32)

  Match bonus used when doign fzy search on file paths.

• #search(needle : String, haystack : Enumerable(Hay(T)), *, store_positions : Bool = false) : Array(Match(T)) forall T
• #search(needle : String, haystack : Enumerable(String), *, store_positions : Bool = false) : Array(Match(String))

  Search a needle in a haystack and returns an array of matches.

• #search(needle : String, haystack : Array(Match(T)), *, store_positions : Bool = false) : Array(Match(T)) forall T
• #search(needle : String, haystack : Fzy::PreparedHaystack(T), *, store_positions : Bool = false) : Array(Match(T)) forall T

Instance Method Detail

results = Fzy.search("hey", %w(Hey Halley Whatever), store_positions: true)
results.each do |result|
  puts "value: #{result.value}"
  puts "score: #{result.score}"
  puts "  pos: #{result.positions.inspect}"
end