extra/sequences/n-based/n-based-docs.factor

   1 ! (c)2008 Joe Groff, see BSD license etc.
   2 USING: help.markup help.syntax math sequences ;
   3 IN: sequences.n-based
   4
   5 HELP: <n-based-assoc>
   6 { $values { "seq" sequence } { "base" integer } { "n-based-assoc" n-based-assoc } }
   7 { $description "Wraps " { $snippet "seq" } " in an " { $link n-based-assoc } " wrapper." }
   8 { $examples
   9 { $example "
  10 USING: assocs prettyprint kernel sequences.n-based ;
  11 IN: scratchpad
  12
  13 : months ( -- assoc )
  14     {
  15         \"January\"
  16         \"February\"
  17         \"March\"
  18         \"April\"
  19         \"May\"
  20         \"June\"
  21         \"July\"
  22         \"August\"
  23         \"September\"
  24         \"October\"
  25         \"November\"
  26         \"December\"
  27     } 1 <n-based-assoc> ;
  28
  29 10 months at .
  30 " "\"October\"" } } ;
  31
  32 HELP: n-based-assoc
  33 { $class-description "An adaptor class that allows a sequence to be treated as an assoc with non-zero-based keys." }
  34 { $examples
  35 { $example "
  36 USING: assocs prettyprint kernel sequences.n-based ;
  37 IN: scratchpad
  38
  39 : months ( -- assoc )
  40     {
  41         \"January\"
  42         \"February\"
  43         \"March\"
  44         \"April\"
  45         \"May\"
  46         \"June\"
  47         \"July\"
  48         \"August\"
  49         \"September\"
  50         \"October\"
  51         \"November\"
  52         \"December\"
  53     } 1 <n-based-assoc> ;
  54
  55 10 months at .
  56 " "\"October\"" } } ;
  57
  58 { n-based-assoc <n-based-assoc> } related-words
  59
  60 ARTICLE: "sequences.n-based" "N-based sequences"
  61 "The " { $vocab-link "sequences.n-based" } " vocabulary provides a sequence adaptor that allows a sequence to be treated as an assoc with non-zero-based keys."
  62 { $subsections
  63     n-based-assoc
  64     <n-based-assoc>
  65 }
  66 ;
  67
  68 ABOUT: "sequences.n-based"