Aller au contenu

tilttek/dice-jail

✅ publié

La prison des dés malchanceux et les statistiques qui la fondent : un test d'adéquation honnête, expliqué simplement.

Un dé qui n'arrête pas de faire des un va en prison : un joueur l'y envoie pour une soirée ou jusqu'à ce qu'il le libère, et la prison garde l'historique de chaque dé. C'est un geste de jeu : emprisonner un dé ne demande aucune preuve et ne change rien à la façon dont il roule.

Les statistiques sont ce qu'un joueur montre à la table. GoodnessOfFit exécute le test du khi carré de Pearson sur les lancers d'un dé, contre les probabilités exactes d'un dé équitable — un dé uniforme, ou toute distribution que tilttek/dice-probability calcule —, refuse de juger avant que chaque face soit attendue cinq fois, et donne une valeur p et un verdict : « pas assez de lancers », « rien d'inhabituel », « plutôt inhabituel » ou « très inhabituel ». Explanation le dit en français ou en anglais simples, avec le lancer moyen à côté de celui qui était attendu. Aucune phrase ne dit jamais qu'un dé est pipé : le verdict le plus inhabituel demande d'examiner le dé, ou de refaire des lancers, et les lancers des dés numériques sont dits venir d'un générateur qui sert tous les dés de la même façon.

Le paquet s'adresse à une table qui joue en ligne ou note ses lancers physiques : l'écran d'un meneur de jeu, une tour à dés, une feuille de personnage. C'est une bibliothèque PHP simple, bâtie sur tilttek/dice et tilttek/dice-probability ; l'application garde l'historique et les lancers au moyen de deux ports.

État

PartieÉtat
Jail\Warden : emprisonner pour une peine ou jusqu'à la libération, libérer, les dés en prison, l'historiqueImplémenté et testé
Jail\Inmate, Jail\JailEvent, Jail\EventKind, Jail\Evidence : la peine, l'historique et les statistiques montréesImplémenté et testé
Statistics\GoodnessOfFit, Statistics\FitResult, Statistics\FaceCount, Statistics\Verdict : le test du khi carréImplémenté et testé
Statistics\Tally, Statistics\ExpectedFaces : les lancers comptés, le dé équitable à partir d'un intervalle ou d'une distributionImplémenté et testé
Statistics\Explanation, Statistics\Language, Statistics\Origin : le verdict en français et en anglais simplesImplémenté et testé
Statistics\DieAssessor, Contract\RollSource, Store\InMemoryRollSource : le test à partir des lancers enregistrésImplémenté et testé
Contract\JailStore, Store\InMemoryJailStoreImplémenté et testé
Une source de lancers qui lit le journal des lancers de tilttek/dice-bundlePas commencé

Documentation

DocumentContenu
InstallationLes prérequis, l'installation et le câblage.
La prisonEmprisonner, les peines, les libérations, l'historique, et ce que la prison n'est pas.
Les statistiquesLe test du khi carré, le minimum de lancers, les verdicts et la façon de les lire honnêtement.
Les explicationsLes phrases en français et en anglais, et ce qu'elles ne disent jamais.
Points d'extensionCe qu'une application donne à la bibliothèque.
ExceptionsDiceJailException et ses exceptions.
TestsLes tests de la bibliothèque, sa cible de fuzzing et ses bancs d'essai.
RéférenceChaque type public, avec son rôle.

Démarrage rapide

use Symfony\Component\Clock\NativeClock;
use Tilttek\DiceJail\Jail\Evidence;
use Tilttek\DiceJail\Jail\Warden;
use Tilttek\DiceJail\Statistics\ExpectedFaces;
use Tilttek\DiceJail\Statistics\Explanation;
use Tilttek\DiceJail\Statistics\GoodnessOfFit;
use Tilttek\DiceJail\Statistics\Language;
use Tilttek\DiceJail\Statistics\Tally;
use Tilttek\DiceJail\Store\InMemoryJailStore;

$result = new GoodnessOfFit()->test(Tally::of($rollsOfTheBlueD20), ExpectedFaces::uniform(20));
$result->verdict;                                       // Verdict::NothingUnusual, most of the time
new Explanation()->explain($result, Language::French);  // « Rien d’inhabituel sur 120 lancers : … »

$warden = new Warden(new InMemoryJailStore(), new NativeClock());
$warden->jail('member-7', 'd20:blue', 'Three natural ones in a row.', evidence: Evidence::of($result));
$warden->release('member-7', 'd20:blue', 'It has served its time.');

Prérequis

PHP 8.5 ou une version plus récente, avec mbstring ; tilttek/dice 0.2 ou 0.3 et tilttek/dice-probability 0.1 ; une implémentation de psr/clock.

Contribuer

Les contributions sont les bienvenues sur le monodépôt de PHIL : lisez le guide de contribution et le code de conduite, en anglais. Signalez une vulnérabilité en privé, comme l'explique la politique de sécurité, jamais dans un ticket public.

Licence

MIT, © Philippe Gamache, doing business as Le Gnome Archiviste; a Tilttek project. Voir LICENSE.