LeXtract.AlignmentStatus (lextract v0.1.2)

View Source

Represents the quality/status of text alignment.

Values

  • :exact - Perfect token sequence match
  • :fuzzy - Case-insensitive or minor variation match
  • :partial - Partial/substring match
  • :none - No match found

Examples

iex> LeXtract.AlignmentStatus.exact?(:exact)
true

iex> LeXtract.AlignmentStatus.exact?(:fuzzy)
false

Summary

Types

t()

Functions

confidence(atom)

Returns confidence score for alignment status (0.0 - 1.0).

exact?(arg1)

Returns true if status indicates exact match.

from_string(arg1)

Converts string to alignment status atom.

matched?(arg1)

Returns true if status indicates any match (not :none).

Types

t()

@type t() :: :exact | :fuzzy | :partial | :none

Functions

confidence(atom)

@spec confidence(t()) :: float()

Returns confidence score for alignment status (0.0 - 1.0).

Examples

iex> LeXtract.AlignmentStatus.confidence(:exact)
1.0

iex> LeXtract.AlignmentStatus.confidence(:none)
0.0

exact?(arg1)

@spec exact?(t()) :: boolean()

Returns true if status indicates exact match.

Examples

iex> LeXtract.AlignmentStatus.exact?(:exact)
true

iex> LeXtract.AlignmentStatus.exact?(:partial)
false

from_string(arg1)

@spec from_string(String.t()) :: t()

Converts string to alignment status atom.

Examples

iex> LeXtract.AlignmentStatus.from_string("exact")
:exact

iex> LeXtract.AlignmentStatus.from_string("unknown")
:none

matched?(arg1)

@spec matched?(t()) :: boolean()

Returns true if status indicates any match (not :none).

Examples

iex> LeXtract.AlignmentStatus.matched?(:exact)
true

iex> LeXtract.AlignmentStatus.matched?(:none)
false