View Source Akin.Task behaviour (Akin v0.2.0)

API for all string comparison modules.

Summary

Callbacks

Link to this callback

compare(%Akin.Corpus{}, %Akin.Corpus{})

View Source (optional)
@callback compare(
  %Akin.Corpus{
    list: term(),
    original: term(),
    set: term(),
    stems: term(),
    string: term()
  },
  %Akin.Corpus{
    list: term(),
    original: term(),
    set: term(),
    stems: term(),
    string: term()
  }
) :: number() | map()
Link to this callback

compare(%Akin.Corpus{}, %Akin.Corpus{}, t)

View Source
@callback compare(
  %Akin.Corpus{
    list: term(),
    original: term(),
    set: term(),
    stems: term(),
    string: term()
  },
  %Akin.Corpus{
    list: term(),
    original: term(),
    set: term(),
    stems: term(),
    string: term()
  },
  Keyword.t(any())
) :: number() | map()