HELP: <circular-string>
{ $values
- { "n" integer }
- { "circular" circular } }
+ { "n" integer }
+ { "circular" circular } }
{ $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." } ;
HELP: <circular>
{ $values
- { "seq" sequence }
- { "circular" circular } }
+ { "seq" sequence }
+ { "circular" circular } }
{ $description "Creates a new " { $link circular } " object that wraps an existing sequence. By default, the index is set to zero." } ;
HELP: <growing-circular>
{ $values
- { "capacity" integer }
- { "growing-circular" growing-circular } }
+ { "capacity" integer }
+ { "growing-circular" growing-circular } }
{ $description "Creates a new growing-circular object." } ;
HELP: change-circular-start
{ $values
- { "n" integer } { "circular" circular } }
+ { "n" integer } { "circular" circular } }
{ $description "Changes the start index of a circular object." } ;
HELP: circular
HELP: circular-push
{ $values
- { "elt" object } { "circular" circular } }
+ { "elt" object } { "circular" circular } }
{ $description "Pushes an element to a " { $link circular } " object." } ;
HELP: growing-circular-push
{ $values
- { "elt" object } { "circular" circular } }
+ { "elt" object } { "circular" circular } }
{ $description "Pushes an element onto a " { $link growing-circular } " object." } ;
HELP: rotate-circular