factor: about: to ABOUT:
Doug Coleman
parent
79fa561214
commit
1faeab2df7
|
|
@ -31,4 +31,4 @@ ARTICLE: "assoc-heaps" "Associative heaps"
|
|||
<unique-max-heap>
|
||||
} ;
|
||||
|
||||
about: "assoc-heaps"
|
||||
ABOUT: "assoc-heaps"
|
||||
|
|
|
|||
|
|
@ -38,4 +38,4 @@ $nl
|
|||
"Converting existing assocs to biassocs:"
|
||||
{ $subsections >biassoc } ;
|
||||
|
||||
about: "biassocs"
|
||||
ABOUT: "biassocs"
|
||||
|
|
|
|||
|
|
@ -31,7 +31,7 @@ $nl
|
|||
"Bit array literal syntax:"
|
||||
{ $subsections postpone\ ?{ } ;
|
||||
|
||||
about: "bit-arrays"
|
||||
ABOUT: "bit-arrays"
|
||||
|
||||
HELP: \ ?{
|
||||
{ $syntax "?{ elements... }" }
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ ARTICLE: "bit-sets" "Bit sets"
|
|||
"Constructing new bit sets:"
|
||||
{ $subsection <bit-set> } ;
|
||||
|
||||
about: "bit-sets"
|
||||
ABOUT: "bit-sets"
|
||||
|
||||
HELP: bit-set
|
||||
{ $class-description "The class of bit-array-based " { $link "sets" } "." } ;
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ $nl
|
|||
"If you don't care about initial capacity, a more elegant way to create a new bit vector is to write:"
|
||||
{ $code "?V{ } clone" } ;
|
||||
|
||||
about: "bit-vectors"
|
||||
ABOUT: "bit-vectors"
|
||||
|
||||
HELP: bit-vector
|
||||
{ $description "The class of resizable bit vectors. See " { $link "bit-vectors" } " for information." } ;
|
||||
|
|
|
|||
|
|
@ -37,4 +37,4 @@ $nl
|
|||
bloom-filter-member?
|
||||
} ;
|
||||
|
||||
about: "bloom-filters"
|
||||
ABOUT: "bloom-filters"
|
||||
|
|
|
|||
|
|
@ -84,4 +84,4 @@ ARTICLE: "circular" "Circular sequences"
|
|||
"Iterating over a circular until a stop condition:"
|
||||
{ $subsections circular-while circular-loop } ;
|
||||
|
||||
about: "circular"
|
||||
ABOUT: "circular"
|
||||
|
|
|
|||
|
|
@ -32,4 +32,4 @@ ARTICLE: "columns" "Column sequences"
|
|||
"A utility word:"
|
||||
{ $subsections <flipped> } ;
|
||||
|
||||
about: "columns"
|
||||
ABOUT: "columns"
|
||||
|
|
|
|||
|
|
@ -173,4 +173,4 @@ $nl
|
|||
}
|
||||
"When using a deque as a queue, the convention is to queue elements with " { $link push-front } " and deque them with " { $link pop-back } "." ;
|
||||
|
||||
about: "deques"
|
||||
ABOUT: "deques"
|
||||
|
|
|
|||
|
|
@ -59,4 +59,4 @@ $nl
|
|||
{ $subsections equate }
|
||||
"Additionally, disjoint sets implement the " { $link clone } " generic word." ;
|
||||
|
||||
about: "disjoint-sets"
|
||||
ABOUT: "disjoint-sets"
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@ $nl
|
|||
"Search deque implementation:"
|
||||
{ $subsections <hashed-dlist> } ;
|
||||
|
||||
about: "dlists"
|
||||
ABOUT: "dlists"
|
||||
|
||||
HELP: <dlist>
|
||||
{ $values { "list" dlist } }
|
||||
|
|
|
|||
|
|
@ -135,4 +135,4 @@ ARTICLE: "document-locs" "Document locations"
|
|||
validate-loc
|
||||
} ;
|
||||
|
||||
about: "documents"
|
||||
ABOUT: "documents"
|
||||
|
|
|
|||
|
|
@ -51,4 +51,4 @@ $nl
|
|||
next-elt
|
||||
} ;
|
||||
|
||||
about: "documents.elements"
|
||||
ABOUT: "documents.elements"
|
||||
|
|
|
|||
|
|
@ -10,4 +10,4 @@ ARTICLE: "env" "Accessing the environment via the assoc protocol"
|
|||
{ $subsections env }
|
||||
;
|
||||
|
||||
about: "env"
|
||||
ABOUT: "env"
|
||||
|
|
|
|||
|
|
@ -42,7 +42,7 @@ $nl
|
|||
"Processing heaps:"
|
||||
{ $subsections slurp-heap } ;
|
||||
|
||||
about: "heaps"
|
||||
ABOUT: "heaps"
|
||||
|
||||
HELP: <min-heap>
|
||||
{ $values { "min-heap" min-heap } }
|
||||
|
|
|
|||
|
|
@ -43,4 +43,4 @@ $nl
|
|||
coalesce
|
||||
} ;
|
||||
|
||||
about: "interval-maps"
|
||||
ABOUT: "interval-maps"
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
USING: help.syntax help.markup math ;
|
||||
IN: interval-sets
|
||||
|
||||
about: "interval-sets"
|
||||
ABOUT: "interval-sets"
|
||||
|
||||
ARTICLE: "interval-sets" "Interval sets"
|
||||
"The " { $vocab-link "interval-sets" } " vocabulary implements an efficient data structure for sets of positive, machine word-sized integers, specified by ranges. The space taken by the data structure is proportional to the number of intervals contained. Membership testing is O(log n), and creation is O(n log n), where n is the number of ranges. Boolean operations are O(n). Interval sets are immutable."
|
||||
|
|
|
|||
|
|
@ -22,4 +22,4 @@ $nl
|
|||
<linked-assoc>
|
||||
} ;
|
||||
|
||||
about: "linked-assocs"
|
||||
ABOUT: "linked-assocs"
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ USING: help.markup help.syntax kernel lists math sequences
|
|||
strings ;
|
||||
IN: lists.lazy
|
||||
|
||||
about: "lists.lazy"
|
||||
ABOUT: "lists.lazy"
|
||||
|
||||
ARTICLE: "lists.lazy" "Lazy lists"
|
||||
"The " { $vocab-link "lists.lazy" } " vocabulary implements lazy lists and standard operations to manipulate them."
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
USING: kernel help.markup help.syntax arrays sequences math quotations ;
|
||||
IN: lists
|
||||
|
||||
about: "lists"
|
||||
ABOUT: "lists"
|
||||
|
||||
ARTICLE: "lists" "Lists"
|
||||
"The " { $vocab-link "lists" } " vocabulary implements linked lists. There are simple strict linked lists, but a generic list protocol allows the implementation of lazy lists as well."
|
||||
|
|
|
|||
|
|
@ -63,4 +63,4 @@ ARTICLE: "memory.piles" "Piles"
|
|||
}
|
||||
"An example of the utility of piles is in video games. For example, the game Abuse was scripted with a Lisp dialect. In order to avoid stalls from traditional GC or heap-based allocators, the Abuse Lisp VM would allocate values from a preallocated pile over the course of a frame, and release the entire pile at the end of the frame." ;
|
||||
|
||||
about: "memory.piles"
|
||||
ABOUT: "memory.piles"
|
||||
|
|
|
|||
|
|
@ -75,4 +75,4 @@ ARTICLE: "memory.pools" "Pools"
|
|||
free-to-pool
|
||||
} ;
|
||||
|
||||
about: "memory.pools"
|
||||
ABOUT: "memory.pools"
|
||||
|
|
|
|||
|
|
@ -59,4 +59,4 @@ ARTICLE: "persistent-heaps" "Persistent heaps"
|
|||
pheap>values
|
||||
} ;
|
||||
|
||||
about: "persistent-heaps"
|
||||
ABOUT: "persistent-heaps"
|
||||
|
|
|
|||
|
|
@ -22,4 +22,4 @@ ARTICLE: "persistent.sequences" "Persistent sequence protocol"
|
|||
}
|
||||
"The default implementations of the above run in " { $snippet "O(n)" } " time; the " { $vocab-link "persistent.vectors" } " vocabulary provides an implementation of these operations in " { $snippet "O(1)" } " time." ;
|
||||
|
||||
about: "persistent.sequences"
|
||||
ABOUT: "persistent.sequences"
|
||||
|
|
|
|||
|
|
@ -25,4 +25,4 @@ $nl
|
|||
$nl
|
||||
"This implementation of persistent vectors is based on the " { $snippet "clojure.lang.PersistentVector" } " class from Rich Hickey's Clojure language for the JVM (" { $url "http://clojure.org" } ")." ;
|
||||
|
||||
about: "persistent.vectors"
|
||||
ABOUT: "persistent.vectors"
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ ARTICLE: "quadtrees" "Quadtrees"
|
|||
"Quadtrees can be used to \"swizzle\" a sequence to improve the locality of spatial data in memory:"
|
||||
{ $subsections swizzle } ;
|
||||
|
||||
about: "quadtrees"
|
||||
ABOUT: "quadtrees"
|
||||
|
||||
HELP: <quadtree>
|
||||
{ $values { "bounds" rect } { "quadtree" quadtree } }
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ $nl
|
|||
"Creating a search deque:"
|
||||
{ $subsections <search-deque> } ;
|
||||
|
||||
about: "search-deques"
|
||||
ABOUT: "search-deques"
|
||||
|
||||
HELP: <search-deque>
|
||||
{ $values { "assoc" assoc } { "deque" deque } { "search-deque" search-deque } }
|
||||
|
|
|
|||
|
|
@ -25,4 +25,4 @@ ARTICLE: "sequences.abbrev" "Examples of abbrev usage"
|
|||
}
|
||||
;
|
||||
|
||||
about: "sequences.abbrev"
|
||||
ABOUT: "sequences.abbrev"
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ ARTICLE: "sequences.complex-components" "Complex component virtual sequences"
|
|||
<complex-components>
|
||||
} ;
|
||||
|
||||
about: "sequences.complex-components"
|
||||
ABOUT: "sequences.complex-components"
|
||||
|
||||
HELP: complex-components
|
||||
{ $class-description "Sequence wrapper class that transforms a sequence of " { $link complex } " number values into a sequence of " { $link real } " values, interleaving the real and imaginary parts of the complex values in the original sequence." }
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ ARTICLE: "sequences.complex" "Complex virtual sequences"
|
|||
<complex-sequence>
|
||||
} ;
|
||||
|
||||
about: "sequences.complex"
|
||||
ABOUT: "sequences.complex"
|
||||
|
||||
HELP: complex-sequence
|
||||
{ $class-description "Sequence wrapper class that transforms a sequence of " { $link real } " number values into a sequence of " { $link complex } " values, treating the underlying sequence as pairs of alternating real and imaginary values." }
|
||||
|
|
|
|||
|
|
@ -61,4 +61,4 @@ ARTICLE: "sequences.deep" "Deep sequence combinators"
|
|||
"A utility word to collapse nested subsequences:"
|
||||
{ $subsections flatten } ;
|
||||
|
||||
about: "sequences.deep"
|
||||
ABOUT: "sequences.deep"
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ ARTICLE: "sequences-merge" "Merging sequences"
|
|||
<3merged>
|
||||
} ;
|
||||
|
||||
about: "sequences-merge"
|
||||
ABOUT: "sequences-merge"
|
||||
|
||||
HELP: merged
|
||||
{ $class-description "A virtual sequence which presents a merged view of its underlying elements. New instances are created by calling one of " { $link <merged> } ", " { $link <2merged> } ", or " { $link <3merged> } "." }
|
||||
|
|
|
|||
|
|
@ -65,4 +65,4 @@ ARTICLE: "sequences.n-based" "N-based sequences"
|
|||
}
|
||||
;
|
||||
|
||||
about: "sequences.n-based"
|
||||
ABOUT: "sequences.n-based"
|
||||
|
|
|
|||
|
|
@ -70,4 +70,4 @@ ARTICLE: "sequences.product" "Product sequences"
|
|||
product-each
|
||||
} ;
|
||||
|
||||
about: "sequences.product"
|
||||
ABOUT: "sequences.product"
|
||||
|
|
|
|||
|
|
@ -93,4 +93,4 @@ $nl
|
|||
unrolled-collect
|
||||
} ;
|
||||
|
||||
about: "sequences.unrolled"
|
||||
ABOUT: "sequences.unrolled"
|
||||
|
|
|
|||
|
|
@ -33,4 +33,4 @@ ARTICLE: "sequences.windowed" "Windowed sequences"
|
|||
"Helper words for creating bounds-checked slices:"
|
||||
{ $subsections in-bound in-bounds } ;
|
||||
|
||||
about: "sequences.windowed"
|
||||
ABOUT: "sequences.windowed"
|
||||
|
|
|
|||
|
|
@ -30,4 +30,4 @@ $nl
|
|||
"To take the element-wise xor of two sequences as if they were sets:"
|
||||
{ $subsections setwise-xor } ;
|
||||
|
||||
about: "sets.extras"
|
||||
ABOUT: "sets.extras"
|
||||
|
|
|
|||
|
|
@ -128,4 +128,4 @@ $nl
|
|||
}
|
||||
"The " { $vocab-link "specialized-vectors" } " vocabulary provides a resizable version of this abstraction." ;
|
||||
|
||||
about: "specialized-arrays"
|
||||
ABOUT: "specialized-arrays"
|
||||
|
|
|
|||
|
|
@ -58,4 +58,4 @@ $nl
|
|||
}
|
||||
"The " { $vocab-link "specialized-arrays" } " vocabulary provides a fixed-length version of this abstraction." ;
|
||||
|
||||
about: "specialized-vectors"
|
||||
ABOUT: "specialized-vectors"
|
||||
|
|
|
|||
|
|
@ -95,4 +95,4 @@ ARTICLE: "splitting.monotonic" "Splitting trending sequences"
|
|||
trends
|
||||
} ;
|
||||
|
||||
about: "splitting.monotonic"
|
||||
ABOUT: "splitting.monotonic"
|
||||
|
|
|
|||
|
|
@ -35,4 +35,4 @@ ARTICLE: "suffix-arrays" "Suffix arrays"
|
|||
"Querying suffix arrays:"
|
||||
{ $subsections query } ;
|
||||
|
||||
about: "suffix-arrays"
|
||||
ABOUT: "suffix-arrays"
|
||||
|
|
|
|||
|
|
@ -26,4 +26,4 @@ ARTICLE: "trees.avl" "AVL trees"
|
|||
postpone\ AVL{
|
||||
} ;
|
||||
|
||||
about: "trees.avl"
|
||||
ABOUT: "trees.avl"
|
||||
|
|
|
|||
|
|
@ -26,4 +26,4 @@ ARTICLE: "trees.splay" "Splay trees"
|
|||
postpone\ SPLAY{
|
||||
} ;
|
||||
|
||||
about: "trees.splay"
|
||||
ABOUT: "trees.splay"
|
||||
|
|
|
|||
|
|
@ -26,4 +26,4 @@ ARTICLE: "trees" "Binary search trees"
|
|||
\ TREE{
|
||||
} ;
|
||||
|
||||
about: "trees"
|
||||
ABOUT: "trees"
|
||||
|
|
|
|||
|
|
@ -21,4 +21,4 @@ ARTICLE: "unrolled-lists" "Unrolled lists"
|
|||
<hashed-unrolled-list>
|
||||
} ;
|
||||
|
||||
about: "unrolled-lists"
|
||||
ABOUT: "unrolled-lists"
|
||||
|
|
|
|||
|
|
@ -368,4 +368,4 @@ $nl
|
|||
"embedding"
|
||||
} ;
|
||||
|
||||
about: "alien"
|
||||
ABOUT: "alien"
|
||||
|
|
|
|||
|
|
@ -181,4 +181,4 @@ $nl
|
|||
}
|
||||
;
|
||||
|
||||
about: "c-types-specs"
|
||||
ABOUT: "c-types-specs"
|
||||
|
|
|
|||
|
|
@ -17,4 +17,4 @@ HELP: string>symbol
|
|||
$nl
|
||||
"On all platforms, symbols are ASCII strings." } ;
|
||||
|
||||
about: "c-strings"
|
||||
ABOUT: "c-strings"
|
||||
|
|
|
|||
|
|
@ -40,7 +40,7 @@ $nl
|
|||
"Arrays can be accessed without bounds checks in a pointer unsafe way."
|
||||
{ $subsections "arrays-unsafe" } ;
|
||||
|
||||
about: "arrays"
|
||||
ABOUT: "arrays"
|
||||
|
||||
HELP: array
|
||||
{ $description "The class of fixed-length arrays. See " { $link "syntax-arrays" } " for syntax and " { $link "arrays" } " for general information." } ;
|
||||
|
|
|
|||
|
|
@ -196,7 +196,7 @@ $nl
|
|||
"assocs-conversions"
|
||||
} ;
|
||||
|
||||
about: "assocs"
|
||||
ABOUT: "assocs"
|
||||
|
||||
HELP: assoc
|
||||
{ $class-description "A mixin class whose instances are associative mappings. Custom implementations of the assoc protocol should be declared as instances of this mixin for all assoc functionality to work correctly:"
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ IN: bootstrap.primitives
|
|||
ARTICLE: "bootstrap.primitives" "Bootstrap primitives"
|
||||
"A script file run to create the bootstrap image. Also see the vocab " { $link "bootstrap.image.primitives" } "." ;
|
||||
|
||||
about: "bootstrap.primitives"
|
||||
ABOUT: "bootstrap.primitives"
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ $nl
|
|||
"Resizing byte arrays:"
|
||||
{ $subsections resize-byte-array } ;
|
||||
|
||||
about: "byte-arrays"
|
||||
ABOUT: "byte-arrays"
|
||||
|
||||
HELP: byte-array
|
||||
{ $description "The class of byte arrays. See " { $link "syntax-byte-arrays" } " for syntax and " { $link "byte-arrays" } " for general information." } ;
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ $nl
|
|||
"If you don't care about initial capacity, a more elegant way to create a new byte vector is to write:"
|
||||
{ $code "BV{ } clone" } ;
|
||||
|
||||
about: "byte-vectors"
|
||||
ABOUT: "byte-vectors"
|
||||
|
||||
HELP: byte-vector
|
||||
{ $description "The class of resizable byte vectors. See " { $link "byte-vectors" } " for information." } ;
|
||||
|
|
|
|||
|
|
@ -70,4 +70,4 @@ $nl
|
|||
{ $vocab-subsection "OpenSSL checksums" "checksums.openssl" }
|
||||
{ $vocab-subsection "Internet checksum" "checksums.internet" } ;
|
||||
|
||||
about: "checksums"
|
||||
ABOUT: "checksums"
|
||||
|
|
|
|||
|
|
@ -8,4 +8,4 @@ ARTICLE: "checksums.crc32" "CRC32 checksum"
|
|||
"The CRC32 checksum algorithm provides a quick but unreliable way to detect changes in data."
|
||||
{ $subsections crc32 } ;
|
||||
|
||||
about: "checksums.crc32"
|
||||
ABOUT: "checksums.crc32"
|
||||
|
|
|
|||
|
|
@ -67,7 +67,7 @@ $nl
|
|||
}
|
||||
{ $see-also "class-index" } ;
|
||||
|
||||
about: "classes"
|
||||
ABOUT: "classes"
|
||||
|
||||
HELP: class
|
||||
{ $class-description "The class of all class words." } ;
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@ ARTICLE: "intersections" "Intersection classes"
|
|||
}
|
||||
"Intersection classes are used to associate a method with objects which are simultaneously instances of multiple different classes, as well as to conveniently define predicates." ;
|
||||
|
||||
about: "intersections"
|
||||
ABOUT: "intersections"
|
||||
|
||||
HELP: define-intersection-class
|
||||
{ $values { "class" class } { "participants" "a sequence of classes" } }
|
||||
|
|
|
|||
|
|
@ -35,4 +35,4 @@ HELP: add-mixin-instance
|
|||
|
||||
{ mixin-class define-mixin-class add-mixin-instance postpone\ mixin: postpone\ INSTANCE: } related-words
|
||||
|
||||
about: "mixins"
|
||||
ABOUT: "mixins"
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ ARTICLE: "predicates" "Predicate classes"
|
|||
predicate-class?
|
||||
} ;
|
||||
|
||||
about: "predicates"
|
||||
ABOUT: "predicates"
|
||||
|
||||
HELP: define-predicate-class
|
||||
{ $values { "class" class } { "superclass" class } { "definition" { $quotation ( superclass -- ? ) } } }
|
||||
|
|
|
|||
|
|
@ -24,4 +24,4 @@ HELP: define-singleton-class
|
|||
HELP: singleton-class
|
||||
{ $class-description "The class of singleton classes." } ;
|
||||
|
||||
about: "singletons"
|
||||
ABOUT: "singletons"
|
||||
|
|
|
|||
|
|
@ -346,7 +346,7 @@ $nl
|
|||
{ $subsections "tuple-redefinition" }
|
||||
"Tuple literal syntax is documented in " { $link "syntax-tuples" } "." ;
|
||||
|
||||
about: "tuples"
|
||||
ABOUT: "tuples"
|
||||
|
||||
HELP: tuple-class
|
||||
{ $class-description "The class of tuple class words." }
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ ARTICLE: "unions" "Union classes"
|
|||
"Unions are used to define behavior shared between a fixed set of classes, as well as to conveniently define predicates."
|
||||
{ $see-also "mixins" "tuple-subclassing" } ;
|
||||
|
||||
about: "unions"
|
||||
ABOUT: "unions"
|
||||
|
||||
HELP: define-union-class
|
||||
{ $values { "class" class } { "members" "a sequence of classes" } }
|
||||
|
|
|
|||
|
|
@ -226,7 +226,7 @@ ARTICLE: "combinators" "Combinators"
|
|||
"More combinators are defined for working on data structures, such as " { $link "sequences-combinators" } " and " { $link "assocs-combinators" } "."
|
||||
{ $see-also "quotations" } ;
|
||||
|
||||
about: "combinators"
|
||||
ABOUT: "combinators"
|
||||
|
||||
HELP: call-effect
|
||||
{ $values { "quot" quotation } { "effect" effect } }
|
||||
|
|
|
|||
|
|
@ -71,4 +71,4 @@ ARTICLE: "combinators.short-circuit" "Short-circuit combinators"
|
|||
}
|
||||
;
|
||||
|
||||
about: "combinators.short-circuit"
|
||||
ABOUT: "combinators.short-circuit"
|
||||
|
|
|
|||
|
|
@ -35,4 +35,4 @@ $nl
|
|||
"Generalized OR:"
|
||||
{ $subsections || } ;
|
||||
|
||||
about: "combinators.short-circuit.smart"
|
||||
ABOUT: "combinators.short-circuit.smart"
|
||||
|
|
|
|||
|
|
@ -173,4 +173,4 @@ HELP: run-script
|
|||
{ $description "Parses the Factor source code stored in a file and runs it. The initial vocabulary search path is used. If the source file contains a " { $link postpone\ main: } " declaration, the main entry point of the file will be also be executed. Loading messages will be suppressed." }
|
||||
{ $errors "Throws an error if loading the file fails, there input is malformed, or if a runtime error occurs while calling the parsed quotation or executing the main entry point." } ;
|
||||
|
||||
about: "command-line"
|
||||
ABOUT: "command-line"
|
||||
|
|
|
|||
|
|
@ -2,4 +2,4 @@ IN: compiler.errors
|
|||
USING: help.markup help.syntax vocabs.loader words io
|
||||
quotations words.symbol ;
|
||||
|
||||
about: "compiler-errors"
|
||||
ABOUT: "compiler-errors"
|
||||
|
|
|
|||
|
|
@ -39,7 +39,7 @@ $nl
|
|||
"Additional topics:"
|
||||
{ $subsections "compilation-units-internals" } ;
|
||||
|
||||
about: "compilation-units"
|
||||
ABOUT: "compilation-units"
|
||||
|
||||
HELP: bump-effect-counter?
|
||||
{ $values { "?" boolean } }
|
||||
|
|
|
|||
|
|
@ -106,7 +106,7 @@ $nl
|
|||
"Continuations serve as the building block for a number of higher-level abstractions, such as " { $link "errors" } " and " { $link "threads" } "."
|
||||
{ $subsections "continuations.private" } ;
|
||||
|
||||
about: "continuations"
|
||||
ABOUT: "continuations"
|
||||
|
||||
HELP: (get-catchstack)
|
||||
{ $values { "catchstack" "a vector of continuations" } }
|
||||
|
|
|
|||
|
|
@ -403,4 +403,4 @@ $nl
|
|||
"Spilling:"
|
||||
{ $subsections gc-root-offset } ;
|
||||
|
||||
about: "cpu.architecture"
|
||||
ABOUT: "cpu.architecture"
|
||||
|
|
|
|||
|
|
@ -71,7 +71,7 @@ $nl
|
|||
{ $subsections postpone\ forget: }
|
||||
{ $see-also "see" "parser" "source-files" "words" "generic" "help-impl" } ;
|
||||
|
||||
about: "definitions"
|
||||
ABOUT: "definitions"
|
||||
|
||||
HELP: changed-effects
|
||||
{ $var-description "A set that contains all words whose stack effects have changed in the compilation unit." } ;
|
||||
|
|
|
|||
|
|
@ -65,4 +65,4 @@ $nl
|
|||
}
|
||||
"Every tuple class has an associated protocol consisting of all of its slot accessor methods. The " { $vocab-link "delegate.protocols" } " vocabulary defines formal protocols for the various informal protocols used in the Factor core, such as " { $link "sequence-protocol" } ", " { $link "assocs-protocol" } " or " { $link "stream-protocol" } ;
|
||||
|
||||
about: "delegate"
|
||||
ABOUT: "delegate"
|
||||
|
|
|
|||
|
|
@ -110,4 +110,4 @@ ARTICLE: "destructors" "Deterministic resource disposal"
|
|||
}
|
||||
{ $see-also "tools.destructors" } ;
|
||||
|
||||
about: "destructors"
|
||||
ABOUT: "destructors"
|
||||
|
|
|
|||
|
|
@ -115,7 +115,7 @@ ARTICLE: "effects-variables" "Stack effect row variables"
|
|||
{ $synopsis if* }
|
||||
"Stack effect variables can only occur as the first input or first output of a stack effect; names starting in " { $snippet ".." } " cause a syntax error if they occur elsewhere in the effect. For words that are not " { $link postpone\ inline } ", effect variables are currently ignored by the stack checker." ;
|
||||
|
||||
about: "effects"
|
||||
ABOUT: "effects"
|
||||
|
||||
HELP: effect
|
||||
{ $class-description "An object representing a stack effect. Holds a sequence of inputs, a sequence of outputs and a flag indicating if an error is thrown unconditionally." } ;
|
||||
|
|
|
|||
|
|
@ -97,4 +97,4 @@ $nl
|
|||
{ $subsections fry }
|
||||
"Fried quotations are an abstraction on top of the " { $link "compositional-combinators" } "; their use is encouraged over the combinators, because often the fry form is shorter and clearer than the combinator form." ;
|
||||
|
||||
about: "fry"
|
||||
ABOUT: "fry"
|
||||
|
|
|
|||
|
|
@ -316,4 +316,4 @@ ARTICLE: "generalizations" "Generalized shuffle words and combinators"
|
|||
}
|
||||
"Also see the " { $vocab-link "sequences.generalizations" } " vocabulary for generalized sequence operations." ;
|
||||
|
||||
about: "generalizations"
|
||||
ABOUT: "generalizations"
|
||||
|
|
|
|||
|
|
@ -109,7 +109,7 @@ $nl
|
|||
}
|
||||
"Generic words specialize behavior based on the class of an object; sometimes behavior needs to be specialized on the object's " { $emphasis "structure" } "; this is known as " { $emphasis "pattern matching" } " and is implemented in the " { $vocab-link "match" } " vocabulary." ;
|
||||
|
||||
about: "generic"
|
||||
ABOUT: "generic"
|
||||
|
||||
HELP: generic
|
||||
{ $class-description "The class of generic words, documented in " { $link "generic" } "." } ;
|
||||
|
|
|
|||
|
|
@ -7,4 +7,4 @@ HELP: generic-effect
|
|||
|
||||
ARTICLE: "generic.parser" "Utilities for generic word and method defining parsing words" "This vocab creates method words." ;
|
||||
|
||||
about: "generic.parser"
|
||||
ABOUT: "generic.parser"
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ $nl
|
|||
{ $subsections closure }
|
||||
"Directed graphs are used to maintain cross-referencing information for " { $link "definitions" } "." ;
|
||||
|
||||
about: "graphs"
|
||||
ABOUT: "graphs"
|
||||
|
||||
HELP: add-vertex
|
||||
{ $values { "vertex" object } { "edges" sequence } { "graph" "an " { $link assoc } " mapping vertices to " { $link hash-set } " of edges" } }
|
||||
|
|
|
|||
|
|
@ -68,7 +68,7 @@ $nl
|
|||
"Testing how elements are related:"
|
||||
{ $subsections all-eq? all-equal? } ;
|
||||
|
||||
about: "grouping"
|
||||
ABOUT: "grouping"
|
||||
|
||||
HELP: groups
|
||||
{ $class-description "Instances are virtual sequences whose elements are disjoint fixed-length subsequences of an underlying sequence. Groups are mutable and resizable if the underlying sequence is mutable and resizable, respectively."
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@ $nl
|
|||
{ $subsections resize }
|
||||
{ $link "vectors" } " and " { $link "sbufs" } " are implemented using the resizable sequence facility." ;
|
||||
|
||||
about: "growable"
|
||||
ABOUT: "growable"
|
||||
|
||||
HELP: capacity
|
||||
{ $values { "seq" "a vector or string buffer" } { "n" "the capacity of the sequence" } }
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ ARTICLE: "hash-sets" "Hash sets"
|
|||
{ $subsections <hash-set> >hash-set }
|
||||
"The syntax for hash sets is described in " { $link "syntax-hash-sets" } "." ;
|
||||
|
||||
about: "hash-sets"
|
||||
ABOUT: "hash-sets"
|
||||
|
||||
HELP: hash-set
|
||||
{ $class-description "The class of hashtable-like sets. These implement the " { $link set } " mixin." } ;
|
||||
|
|
|
|||
|
|
@ -55,7 +55,7 @@ ARTICLE: "hashtables.utilities" "Hashtable utilities"
|
|||
?set-at
|
||||
} ;
|
||||
|
||||
about: "hashtables"
|
||||
ABOUT: "hashtables"
|
||||
|
||||
HELP: hashtable
|
||||
{ $description "The class of hashtables. See " { $link "syntax-hashtables" } " for syntax and " { $link "hashtables" } " for general information." } ;
|
||||
|
|
|
|||
|
|
@ -45,4 +45,4 @@ $nl
|
|||
}
|
||||
} ;
|
||||
|
||||
about: "hints"
|
||||
ABOUT: "hints"
|
||||
|
|
|
|||
|
|
@ -50,4 +50,4 @@ ARTICLE: "init" "Initialization and startup"
|
|||
"When quitting Factor, shutdown hooks are called:"
|
||||
{ $subsection do-shutdown-hooks } ;
|
||||
|
||||
about: "init"
|
||||
ABOUT: "init"
|
||||
|
|
|
|||
|
|
@ -33,7 +33,7 @@ $nl
|
|||
h>b/b
|
||||
} ;
|
||||
|
||||
about: "stream-binary"
|
||||
ABOUT: "stream-binary"
|
||||
|
||||
HELP: be>
|
||||
{ $values { "seq" { $sequence "bytes" } } { "x" "a non-negative integer" } }
|
||||
|
|
|
|||
|
|
@ -8,4 +8,4 @@ ARTICLE: "io.encodings.ascii" "ASCII encoding"
|
|||
"By default, if there's a non-ASCII character in an input stream, it will be replaced with a replacement character (U+FFFD), and if a non-ASCII character is used in output, an exception is thrown."
|
||||
{ $subsections ascii } ;
|
||||
|
||||
about: "io.encodings.ascii"
|
||||
ABOUT: "io.encodings.ascii"
|
||||
|
|
|
|||
|
|
@ -152,4 +152,4 @@ ARTICLE: "io.encodings" "I/O encodings"
|
|||
}
|
||||
{ $see-also "encodings-introduction" } ;
|
||||
|
||||
about: "io.encodings"
|
||||
ABOUT: "io.encodings"
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ ARTICLE: "io.encodings.utf16" "UTF-16 encoding"
|
|||
utf16be
|
||||
} ;
|
||||
|
||||
about: "io.encodings.utf16"
|
||||
ABOUT: "io.encodings.utf16"
|
||||
|
||||
HELP: utf16le
|
||||
{ $class-description "The encoding descriptor for UTF-16LE, that is, UTF-16 in little endian, without a byte order mark. Streams can be made which read or write wth this encoding." }
|
||||
|
|
|
|||
|
|
@ -8,4 +8,4 @@ ARTICLE: "io.encodings.utf8" "UTF-8 encoding"
|
|||
"UTF-8 is a variable-width encoding. 7-bit ASCII characters are encoded as single bytes, and other Unicode code points are encoded as 2 to 4 byte sequences."
|
||||
{ $subsections utf8 } ;
|
||||
|
||||
about: "io.encodings.utf8"
|
||||
ABOUT: "io.encodings.utf8"
|
||||
|
|
|
|||
|
|
@ -37,7 +37,7 @@ ARTICLE: "io.files" "Reading and writing files"
|
|||
with-file-appender
|
||||
} ;
|
||||
|
||||
about: "io.files"
|
||||
ABOUT: "io.files"
|
||||
|
||||
HELP: <file-reader>
|
||||
{ $values { "path" "a pathname string" } { "encoding" "an encoding descriptor" } { "stream" "an input stream" } }
|
||||
|
|
|
|||
|
|
@ -518,4 +518,4 @@ ARTICLE: "streams" "Streams"
|
|||
}
|
||||
{ $see-also "io.streams.string" "io.streams.plain" "io.streams.duplex" } ;
|
||||
|
||||
about: "streams"
|
||||
ABOUT: "streams"
|
||||
|
|
|
|||
|
|
@ -166,4 +166,4 @@ $nl
|
|||
"Additional topics:"
|
||||
{ $subsections "io.pathnames.presentations" "io.pathnames.special" } ;
|
||||
|
||||
about: "io.pathnames"
|
||||
ABOUT: "io.pathnames"
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
USING: help.syntax help.markup io byte-arrays quotations ;
|
||||
IN: io.streams.byte-array
|
||||
|
||||
about: "io.streams.byte-array"
|
||||
ABOUT: "io.streams.byte-array"
|
||||
|
||||
ARTICLE: "io.streams.byte-array" "Byte-array streams"
|
||||
"Byte array streams:"
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ ARTICLE: "io.streams.c" "ANSI C streams"
|
|||
stderr-handle
|
||||
} ;
|
||||
|
||||
about: "io.streams.c"
|
||||
ABOUT: "io.streams.c"
|
||||
|
||||
HELP: <c-reader>
|
||||
{ $values { "handle" "a C FILE* handle" } { "stream" "a new stream" } }
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
USING: help.markup help.syntax io ;
|
||||
IN: io.streams.plain
|
||||
|
||||
about: "io.streams.plain"
|
||||
ABOUT: "io.streams.plain"
|
||||
|
||||
HELP: plain-writer
|
||||
{ $class-description "An output stream mixin providing an implementation of the extended stream output protocol in a trivial way." }
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ ARTICLE: "io.streams.string" "String streams"
|
|||
with-string-writer
|
||||
} ;
|
||||
|
||||
about: "io.streams.string"
|
||||
ABOUT: "io.streams.string"
|
||||
|
||||
HELP: <string-writer>
|
||||
{ $values { "stream" "an output stream" } }
|
||||
|
|
|
|||
|
|
@ -133,4 +133,4 @@ ARTICLE: "layouts" "VM memory layouts"
|
|||
"layouts-bootstrap"
|
||||
} ;
|
||||
|
||||
about: "layouts"
|
||||
ABOUT: "layouts"
|
||||
|
|
|
|||
|
|
@ -303,4 +303,4 @@ ARTICLE: "locals" "Lexical variables"
|
|||
}
|
||||
"Lexical variables complement " { $link "namespaces" } "." ;
|
||||
|
||||
about: "locals"
|
||||
ABOUT: "locals"
|
||||
|
|
|
|||
|
|
@ -24,4 +24,4 @@ $nl
|
|||
"Parsers for word and method definitions:"
|
||||
{ $subsections (::) (M::) } ;
|
||||
|
||||
about: "locals.parser"
|
||||
ABOUT: "locals.parser"
|
||||
|
|
|
|||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue