factor/basis/compiler/tree/propagation/constraints/constraints-docs.factor

36 lines
1.3 KiB
Factor

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"