unmaintained/adsoda/combinators/combinators-docs.factor

   1 ! Copyright (C) 2008 Your name.
   2 ! See http://factorcode.org/license.txt for BSD license.
   3 USING: arrays help.markup help.syntax kernel sequences ;
   4 IN: adsoda.combinators
   5
   6 HELP: among
   7 { $values
   8      { "array" array } { "n" null }
   9      { "array" array }
  10 }
  11 { $description "returns an array containings every possibilities of n choices among a given sequence" } ;
  12
  13 HELP: columnize
  14 { $values
  15      { "array" array }
  16      { "array" array }
  17 }
  18 { $description "flip a sequence into a sequence of 1 element sequences" } ;
  19
  20 HELP: concat-nth
  21 { $values
  22      { "seq1" sequence } { "seq2" sequence }
  23      { "seq" sequence }
  24 }
  25 { $description "merges 2 sequences of sequences appending corresponding elements" } ;
  26
  27 HELP: do-cycle
  28 { $values
  29      { "array" array }
  30      { "array" array }
  31 }
  32 { $description "Copy the first element at the end of the sequence in order to close the cycle." } ;
  33
  34
  35 ARTICLE: "adsoda.combinators" "adsoda.combinators"
  36 { $vocab-link "adsoda.combinators" }
  37 ;
  38
  39 ABOUT: "adsoda.combinators"