extra/game/models/util/util-docs.factor

   1 ! Copyright (C) 2010 Erik Charlebois
   2 ! See https://factorcode.org/license.txt for BSD license.
   3 USING: help.markup help.crossref help.stylesheet help.topics help.syntax
   4 definitions io prettyprint summary arrays math sequences vocabs strings
   5 see xml.data hashtables assocs ;
   6 IN: game.models.util
   7
   8 HELP: indexed-seq
   9 { $class-description "A sequence described by a sequence of unique elements and a sequence of indices. The sequence can only be appended to. An associative map is used as a reverse lookup table when appending." } ;
  10
  11 HELP: <indexed-seq>
  12 { $values { "dseq-exemplar" sequence } { "iseq-exemplar" sequence } { "rassoc-exemplar" assoc } { "indexed-seq" indexed-seq } }
  13 { $description "Construct an " { $link indexed-seq } " using the given exemplars for the underlying data structures." } ;