HFST-PAIR-TEST(1)

📦
version 3.17.1 · 2 versions
  • 3.17.1 · debian bookworm, debian trixie, nixos 26.05, opensuse-leap 16.0, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking (latest)
  • 3.17.3 · nixpkgs unstable
, in debian bookworm, debian trixie, nixos 26.05, opensuse-leap 16.0, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 hfst-pair-test 💖

bestie. you clicked on the User Commands page for hfst-pair-test(1) and honestly? good choice. sit down, grab a strawberry, let's get into it 🍓

✨ NAME ✨

hfst-pair-test — pair test for a twolc rule file.

🦋 SYNOPSIS 🦋

hfst-pair-test [OPTIONS...] [INFILE]

🌸 DESCRIPTION 🌸

pair test for a twolc rule file. that's the whole vibe. we run pair strings against your rules and see who's behaving and who is NOT 💅

👑 Common options:

  • -h, --help — print the help message, your lil map of everything 🗺️
  • -V, --version — print version info, so everyone knows which era of the software you're living in
  • -v, --verbose — print verbosely while processing, aka it tells you EVERYTHING, main character energy
  • -q, --quiet — only print fatal erros and requested output (yes "erros" is the canon spelling in here, we are not fixing her, we respect her 😭)
  • -s, --silent — alias of --quiet, same energy, different name 🫶

🌈 Input/Output options:

  • -i, --input=INFILE — read input rule file from INFILE
  • -o, --output=OUTFILE — write test output to OUTFILE
  • -N, --negative-test — test fails if any of the pair strings is accepted. yes, backwards on purpose, it's giving chaos but it's correct 💀
  • -X, --xerox-mode — in xerox mode, test cases are harvested from a twolc source file

🎀 Pair test options:

  • -I, --input-strings=SFILE — read pair test strings from SFILE

okay so. if SFILE is missing, the test pair strings are read from STDIN. and if OUTFILE is missing, test output is written to STDOUT. classic, no cap.

The rule file is tested using correspondences given as pair strings, e.g. "e a r l y:i e r". Every pair string is tested using every rule and the program prints information about correspondences that are incorrectly allowed or disallowed. it's basically a vibe check for your rules ✨

The test pair string files contain one pair string/line. Lines where the first non-white-space character is "!" are considered comment lines and skipped. so you can leave lil notes for yourself, iconic.

💜 the three test modes 💜

There are three test modes: positive, negative and Xerox mode.

  • In positive mode, all of the pair strings should be allowed.
  • In negative mode they should be disallowed.
  • In Xerox mode the cases are read from a twolc source file and both positive and negative cases can occur.

Ordinarily, positive test mode is in use. Option -N switches to negative test mode. The exit code for a successful test is 0. The exit code is 1 otherwise. A successful test will print "Test passed". A failing test prints "Test failed" and information about pair strings that are handled incorrectly.

In positive test mode (i.e. without option -N), if a pair string is not accepted, the names of the rules that reject it are printed as well as the positions in the string where the rules run out of possible transitions. In negative mode, only the strings that are allowed are printed. receipts, basically 🧾

In Xerox mode, the input should be a twolc file. Tests consist of two lines: an input form and an output form. The test cases are specialized comments prefixed with either '!!???' or '!!$' depeding on whether the pair should succeed or fail. An example of a positive test:

!!??? earlYer !!??? earlier

An example of a negative test:

!!$ earlYer !!$ earlyer

In silent mode (-s), the program won't print anything. Only the exit code tells whether the test was successful or not. mysterious. lowkey powerful. 🤫

😭 REPORTING BUGS 😭

found something cursed? Report bugs to <hfst-bugs@helsinki.fi> or directly to our bug tracker at: <https://github.com/hfst/hfst/issues>

Copyright © 2017 University of Helsinki, License GPLv3: GNU GPL version 3 <http://gnu.org/licenses/gpl.html>

This is free software: you are free to change and redistribute it.

There is NO WARRANTY, to the extent permitted by law. fr fr, zero warranty, none, don't come for her 🙈

and that's the whole page bestie 💖 this lil beauty comes to you from HFST, dated August 2018 — yes she's a 2018 baby and she still ate 👑 go run your pair tests, you're doing amazing, periodt ✨🦋💅

📦 where this page comes from