Ctrl+K

rics.mapping.score_functions#

Functions which return a likeness score.

See also

The HeuristicScore class.

Module Attributes

VERBOSE

If True enable optional DEBUG-level log messages on each score function invocation.

Functions

disabled(value, candidates, context)

Special value to indicate that scoring logic has been disabled.

equality(value, candidates, context)

Return 1.0 if k == c_i, 0.0 otherwise.

modified_hamming(name, candidates, context)

Compute hamming distance modified by length ratio, from the back.
VERBOSE: bool = False#

If True enable optional DEBUG-level log messages on each score function invocation.

Notes

Not all functions have verbose messages.

modified_hamming(name: str, candidates: Iterable[str], context: ContextType | None, add_length_ratio_term: bool = True, positional_penalty: float = 0.001) → Iterable[float][source]#

Compute hamming distance modified by length ratio, from the back. Score range is [0, 1].

Keyword Arguments:

  • add_length_ratio_term – If True, score is divided by abs(len(name) - len(candidate)).

  • positional_penalty – A penalty applied to prefer earlier candidates, according to the formulare penalty = index(candidate) * positional_penalty).

Examples

>>> from rics.mapping.score_functions import modified_hamming
>>> print(list(modified_hamming('aa', ['aa', 'a', 'ab', 'aa'], context=None)))
[1.0, 0.499, 0.498, 0.997]
>>> print(list(modified_hamming('aa', ['aa', 'a', 'ab', 'aa'], context=None, positional_penalty=0)))
[1.0, 0.5, 0.5, 1.0]
>>> print(list(modified_hamming('face', ['face', 'FAce', 'race', 'place'], context=None)))
[1.0, 0.499, 0.748, 0.372]
equality(value: ValueType, candidates: Iterable[CandidateType], context: ContextType | None) → Iterable[float][source]#

Return 1.0 if k == c_i, 0.0 otherwise.

Examples

>>> from rics.mapping.score_functions import equality
>>> print(list(equality('a', 'aAb', context=None)))
[1.0, 0.0, 0.0]
disabled(value: ValueType, candidates: Iterable[CandidateType], context: ContextType | None) → Iterable[float][source]#

Special value to indicate that scoring logic has been disabled.

This is a workaround to allow users to indicate that the scoring logic is disabled, and that overrides should be used instead. The disabled-function has no special meaning to the mapper, and will be called as any other scoring function. This in turn will immediately raise a ScoringDisabledError.

Raises:

ScoringDisabledError – Always.

On this page