1 ! Copyright (C) 2008 Doug Coleman.
2 ! See http://factorcode.org/license.txt for BSD license.
3 USING: help.markup help.syntax sequences math kernel quotations ;
6 HELP: <circular-string>
9 { "circular" circular } }
10 { $description "Creates a new circular string object. A circular string is a string object that can be accessed out of bounds and the index will wrap around to the start of the string." } ;
15 { "circular" circular } }
16 { $description "Creates a new " { $link circular } " object that wraps an existing sequence. By default, the index is set to zero." } ;
18 HELP: <growing-circular>
20 { "capacity" integer }
21 { "growing-circular" growing-circular } }
22 { $description "Creates a new growing-circular object." } ;
24 HELP: change-circular-start
26 { "n" integer } { "circular" circular } }
27 { $description "Changes the start index of a circular object." } ;
30 { $description "A tuple class that stores a sequence and its start index." } ;
32 HELP: growing-circular
33 { $description "A circular sequence that is growable." } ;
37 { "elt" object } { "circular" circular } }
38 { $description "Pushes an element to a " { $link circular } " object." } ;
40 HELP: growing-circular-push
42 { "elt" object } { "circular" circular } }
43 { $description "Pushes an element onto a " { $link growing-circular } " object." } ;
47 { "circular" circular } }
48 { $description "Advances the start index of a circular object by one." } ;
52 { "circular" circular }
55 { $description "Calls " { $snippet "quot" } " on each element of the sequence until each call yields " { $link f } " in succession." } ;
59 { "circular" circular }
62 { $description "Calls " { $snippet "quot" } " on each element of the sequence until one call yields " { $link f } "." }
63 { $notes "This rotates the " { $link circular } " object after each call, so the next element to be applied will always be the first element." } ;
65 ARTICLE: "circular" "Circular sequences"
66 "The " { $vocab-link "circular" } " vocabulary implements the " { $link "sequence-protocol" } " to allow an arbitrary start index and wrap-around indexing." $nl
67 "Creating a new circular object:"
73 "Changing the start index:"
78 "Pushing new elements:"
83 "Iterating over a circular until a stop condition:"
84 { $subsections circular-while circular-loop } ;