<commit_before>USING: help.markup help.syntax kernel sequences ;
IN: compiler.tree.propagation.constraints

HELP: class-constraint
{ $class-description "A class constraint." } ;

HELP: constraints
{ $var-description "A " { $link sequence } " of assocs. They maps constraints to constraints ('A implies B')." } ;

HELP: equivalence
{ $var-description "An equivalence constraint." } ;

HELP: implication
{ $class-description "An implication constraint." } ;

HELP: interval-constraint
{ $class-description "An interval constraint." } ;

HELP: literal-constraint
{ $class-description "A literal constraint" } ;

HELP: satisfied?
{ $values { "constraint" "a constraint" } { "?" boolean } }
{ $description "satisfied? is inaccurate. It's just used to prevent infinite loops so its only implemented for true-constraints and false-constraints." } ;

ARTICLE: "compiler.tree.propagation.constraints" "Support for predicated value info"
"A constraint is a statement about a value."
$nl
"Boolean constraints:"
{ $subsections true-constraint true-constraint }
"Utilities:"
{ $subsections t--> f--> } ;

ABOUT: "compiler.tree.propagation.constraints"<commit_msg>fix a typo in compiler.tree.propagation.constraints documentation<commit_after>USING: help.markup help.syntax kernel sequences ;
IN: compiler.tree.propagation.constraints

HELP: class-constraint
{ $class-description "A class constraint." } ;

HELP: constraints
{ $var-description "A " { $link sequence } " of assocs. They maps constraints to constraints ('A implies B')." } ;

HELP: equivalence
{ $var-description "An equivalence constraint." } ;

HELP: implication
{ $class-description "An implication constraint." } ;

HELP: interval-constraint
{ $class-description "An interval constraint." } ;

HELP: literal-constraint
{ $class-description "A literal constraint." } ;

HELP: satisfied?
{ $values { "constraint" "a constraint" } { "?" boolean } }
{ $description "The name " { $snippet "satisfied?" } " is imprecise. This word is used to prevent infinite loops, so it is only implemented for " { $link true-constraint } " and " { $link false-constraint } "." } ;

ARTICLE: "compiler.tree.propagation.constraints" "Support for predicated value info"
"A constraint is a statement about a value. The " { $vocab-link "compiler.tree.propagation.constraints" } " vocabulary implements these constraints for propagation of values through the compilation process."
$nl
"Boolean constraints:"
{ $subsections true-constraint false-constraint }
"Utilities:"
{ $subsections t--> f--> } ;

ABOUT: "compiler.tree.propagation.constraints"

{'fraction_non_alphanumeric': 0.12456344586728754, 'fraction_numerical': 0.0, 'mean_word_length': 4.967592592592593, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 7, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7660572', 'n_tokens_mistral': 736, 'n_tokens_neox': 715, 'n_words': 238}