Class: FzyScore::Match

Inherits:

Struct

• Object
• Struct
• FzyScore::Match

Defined in:

lib/fzy_score/match.rb

Overview

Result of a scored fuzzy match.

score Float relevance score. Higher is better. SCORE_MAX for an

exact (case-insensitive) match, {SCORE_MIN} for no match / empty
needle / oversized candidate.

positions Array<Integer> of the indices in haystack that the needle

matched, suitable for highlighting. +nil+ unless positions were
requested.

Instance Attribute Summary

• #positions ⇒ Object

  Returns the value of attribute positions.

• #score ⇒ Object

  Returns the value of attribute score.

Instance Method Summary

• #matched? ⇒ Boolean

  True when the candidate actually matched.

Instance Attribute Details

#positions ⇒ Object

Returns the value of attribute positions

Returns:

• (Object) —

  the current value of positions

# File 'lib/fzy_score/match.rb', line 12

def positions
  @positions
end

#score ⇒ Object

Returns the value of attribute score

Returns:

• (Object) —

  the current value of score

# File 'lib/fzy_score/match.rb', line 12

def score
  @score
end

Instance Method Details

#matched? ⇒ Boolean

Returns true when the candidate actually matched.

Returns:

• (Boolean) —

  true when the candidate actually matched.

# File 'lib/fzy_score/match.rb', line 14

def matched?
  score > SCORE_MIN
end