Fuzler.Comparison (Fuzler v0.1.3)

Copy Markdown View Source

Detailed result returned by Fuzler.compare/2 and Fuzler.compare/3.

Component scores are rounded to two decimal places. token_score and character_score describe the full-input comparison. matched_text is the normalised window selected by partial matching, or nil when the full score wins.

Summary

Types

t()

Types

t()

@type t() :: %Fuzler.Comparison{
  algorithm_version: String.t(),
  character_score: Fuzler.score(),
  full_score: Fuzler.score(),
  matched_text: String.t() | nil,
  partial_score: Fuzler.score(),
  score: Fuzler.score(),
  token_score: Fuzler.score() | nil
}