[Gd-chatter] r11292 - in trunk/documentation/gwydion/gdcore: project text
agent at gwydiondylan.org
agent at gwydiondylan.org
Wed Apr 25 09:49:21 CEST 2007
Author: agent
Date: Wed Apr 25 09:49:15 2007
New Revision: 11292
Modified:
trunk/documentation/gwydion/gdcore/project/Menu.txt
trunk/documentation/gwydion/gdcore/text/name.Lbit-setR.txt
trunk/documentation/gwydion/gdcore/text/name.Lbit-vectorR.txt
trunk/documentation/gwydion/gdcore/text/name.LbooleanR.txt
trunk/documentation/gwydion/gdcore/text/name.LintegerR.txt
trunk/documentation/gwydion/gdcore/text/name.LobjectR.txt
trunk/documentation/gwydion/gdcore/text/name.LsetR.txt
trunk/documentation/gwydion/gdcore/text/name.copy-bit-setX.txt
trunk/documentation/gwydion/gdcore/text/name.empty-bit-setX.txt
trunk/documentation/gwydion/gdcore/text/name.infiniteQ.txt
trunk/documentation/gwydion/gdcore/text/name.set-add.txt
trunk/documentation/gwydion/gdcore/text/name.set-addX.txt
trunk/documentation/gwydion/gdcore/text/name.set-complement.txt
trunk/documentation/gwydion/gdcore/text/name.set-complementX.txt
trunk/documentation/gwydion/gdcore/text/name.set-difference.txt
trunk/documentation/gwydion/gdcore/text/name.set-differenceX.txt
trunk/documentation/gwydion/gdcore/text/name.set-intersection.txt
trunk/documentation/gwydion/gdcore/text/name.set-intersectionX.txt
trunk/documentation/gwydion/gdcore/text/name.set-remove.txt
trunk/documentation/gwydion/gdcore/text/name.set-removeX.txt
trunk/documentation/gwydion/gdcore/text/name.set-union.txt
trunk/documentation/gwydion/gdcore/text/name.set-unionX.txt
trunk/documentation/gwydion/gdcore/text/name.universal-bit-setX.txt
Log:
Job: gd
Documented bit-set module.
Modified: trunk/documentation/gwydion/gdcore/project/Menu.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/project/Menu.txt (original)
+++ trunk/documentation/gwydion/gdcore/project/Menu.txt Wed Apr 25 09:49:15 2007
@@ -1114,7 +1114,7 @@
File: defargparser-init (name.defargparser-init.txt)
File: defargparser-rec (name.defargparser-rec.txt)
File: defargparser-synopsis (name.defargparser-synopsis.txt)
- File: name.designator-class-definer.txt (name.designator-class-definer.txt)
+ File: designator-class-definer (name.designator-class-definer.txt)
File: domain-definer (name.domain-definer.txt)
File: dynamic-bind (name.dynamic-bind.txt)
File: for (name.for.txt)
@@ -1178,6 +1178,5 @@
Constant Index: Constants
Dylan Class Index: Classes
Macro Index: Macros
- Property Index: Properties
} # Group: Indexes
Modified: trunk/documentation/gwydion/gdcore/text/name.Lbit-setR.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.Lbit-setR.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.Lbit-setR.txt Wed Apr 25 09:49:15 2007
@@ -1,7 +1,17 @@
Class: <bit-set>
==============================
-A class.
+A collection of bit indices. Each index present in the set is assumed to have
+a bit value of 1. All other indices are assumed to have a bit value of _pad_,
+unless explicitly removed from the set, in which case they have a value of 0.
+
+#element-setter# behavior differs from that of #<set>#. Setting a key to
+itself adds the index to the set. Setting a key to any other value removes it.
+In the following code, the first line adds the index and the others remove it.
+
+: bitset[3] := 3; /* Adds */
+: bitset[3] := #f; /* Removes */
+: bitset[3] := 17; /* Removes */
Exported from:
@@ -14,6 +24,27 @@
concrete primary sealed
+Make keywords:
+------------------------------
+member-vector: - An instance of #<bit-vector>#. The backing store for the
+ set. Optional.
+
+pad: - An instance of #<bit>#. This is the value assumed for all
+ bits not added to or removed from the set. Ignored if
+ _all-members-from_ is supplied. The default value is 0.
+
+upper-bound-hint: - An instance of #<integer># indicating the highest index
+ typically added to the set. The default value is 0.
+
+members: - An instance of #<collection># containing #<integer>#
+ values. These values are indices added to the set.
+ Optional.
+
+all-members-from: - An instance of #<integer>#. All indices higher than the
+ specified value are assumed to be included in the set.
+ Optional.
+
+
Superclasses:
------------------------------
- #<set>#
@@ -23,7 +54,34 @@
------------------------------
- #copy-bit-set!#
- #empty-bit-set!#
+- #infinite?#
+- #set-add#
+- #set-add!#
+- #set-complement#
+- #set-complement!#
+- #set-difference#
+- #set-difference!#
+- #set-intersection#
+- #set-intersection!#
+- #set-remove#
+- #set-remove!#
+- #set-union#
+- #set-union!#
- #universal-bit-set!#
+Functions returning <bit-set>:
+------------------------------
+- #set-add#
+- #set-add!#
+- #set-complement#
+- #set-complement!#
+- #set-difference#
+- #set-difference!#
+- #set-intersection#
+- #set-intersection!#
+- #set-remove#
+- #set-remove!#
+- #set-union#
+- #set-union!#
Modified: trunk/documentation/gwydion/gdcore/text/name.Lbit-vectorR.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.Lbit-vectorR.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.Lbit-vectorR.txt Wed Apr 25 09:49:15 2007
@@ -5,7 +5,8 @@
32-bit words, and may have Boolean operations performed over all its contents
at once.
-When treated as a series of words, each word is structured as follows:
+When treated as a series of words, each word is structured as
+follows:
(diagram)
Element 0 1 ... 30 31 32 33 ... 62 63 64 65 ...
Modified: trunk/documentation/gwydion/gdcore/text/name.LbooleanR.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.LbooleanR.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.LbooleanR.txt Wed Apr 25 09:49:15 2007
@@ -76,6 +76,7 @@
- #function-arguments#
- #graphic?#
- #hex-digit?#
+- #infinite?#
- #input-available-at-source?#
- #instance?#
- #integral?#
Modified: trunk/documentation/gwydion/gdcore/text/name.LintegerR.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.LintegerR.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.LintegerR.txt Wed Apr 25 09:49:15 2007
@@ -69,6 +69,10 @@
- #regexp-position#
- #regexp-replace#
- #scale-float#
+- #set-add#
+- #set-add!#
+- #set-remove#
+- #set-remove!#
- #split#
- #stream-position-setter#
- #string-to-integer#
Modified: trunk/documentation/gwydion/gdcore/text/name.LobjectR.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.LobjectR.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.LobjectR.txt Wed Apr 25 09:49:15 2007
@@ -176,7 +176,6 @@
- #ignore#
- #indent#
- #index#
-- #infinite?#
- #initialize#
- #initialized?#
- #instance?#
@@ -295,18 +294,6 @@
- #second#
- #second-setter#
- #sequence-diff#
-- #set-add#
-- #set-add!#
-- #set-complement#
-- #set-complement!#
-- #set-difference#
-- #set-difference!#
-- #set-intersection#
-- #set-intersection!#
-- #set-remove#
-- #set-remove!#
-- #set-union#
-- #set-union!#
- #shallow-copy#
- #short-option-names#
- #short-option-names-setter#
@@ -458,7 +445,6 @@
- #identity#
- #indent#
- #index#
-- #infinite?#
- #initialize#
- #initialized?#
- #invoke-debugger#
@@ -539,18 +525,6 @@
- #second#
- #second-setter#
- #sequence-diff#
-- #set-add#
-- #set-add!#
-- #set-complement#
-- #set-complement!#
-- #set-difference#
-- #set-difference!#
-- #set-intersection#
-- #set-intersection!#
-- #set-remove#
-- #set-remove!#
-- #set-union#
-- #set-union!#
- #shallow-copy#
- #short-option-names#
- #short-option-names-setter#
Modified: trunk/documentation/gwydion/gdcore/text/name.LsetR.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.LsetR.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.LsetR.txt Wed Apr 25 09:49:15 2007
@@ -20,7 +20,7 @@
Modifiers:
------------------------------
-abstract primary open
+abstract primary open instantiable
Superclasses:
Modified: trunk/documentation/gwydion/gdcore/text/name.copy-bit-setX.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.copy-bit-setX.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.copy-bit-setX.txt Wed Apr 25 09:49:15 2007
@@ -1,7 +1,7 @@
Function: copy-bit-set!
==============================
-A function.
+Replaces the contents of one bit set with the contents of another.
Exported from:
@@ -11,8 +11,8 @@
Arguments:
------------------------------
-arg - An instance of #<bit-set>#.
-arg - An instance of #<bit-set>#.
+set1 - An instance of #<bit-set>#. The destination.
+set2 - An instance of #<bit-set>#. The source.
Modified: trunk/documentation/gwydion/gdcore/text/name.empty-bit-setX.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.empty-bit-setX.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.empty-bit-setX.txt Wed Apr 25 09:49:15 2007
@@ -1,7 +1,7 @@
Function: empty-bit-set!
==============================
-A function.
+Alters a bit set to exclude all possible indices.
Exported from:
@@ -11,7 +11,7 @@
Arguments:
------------------------------
-arg - An instance of #<bit-set>#.
+set - An instance of #<bit-set>#.
Modified: trunk/documentation/gwydion/gdcore/text/name.infiniteQ.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.infiniteQ.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.infiniteQ.txt Wed Apr 25 09:49:15 2007
@@ -1,7 +1,8 @@
Generic: infinite?
==============================
-A generic function.
+Returns true if a bit set is assumed to include any indices not explicitly
+removed.
Exported from:
@@ -16,12 +17,12 @@
Arguments:
------------------------------
-arg - An instance of #<object>#.
+set - An instance of #<bit-set>#.
Values:
------------------------------
-#rest more - Instances of #<object>#.
+result - An instance of #<boolean>#.
Modified: trunk/documentation/gwydion/gdcore/text/name.set-add.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.set-add.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.set-add.txt Wed Apr 25 09:49:15 2007
@@ -1,7 +1,7 @@
Generic: set-add
==============================
-A generic function.
+Adds an index to a bit set.
Exported from:
@@ -16,13 +16,13 @@
Arguments:
------------------------------
-arg - An instance of #<object>#.
-arg - An instance of #<object>#.
+set - An instance of #<bit-set>#.
+arg - An instance of #<integer>#.
Values:
------------------------------
-#rest more - Instances of #<object>#.
+new-set - An instance of #<bit-set>#.
Modified: trunk/documentation/gwydion/gdcore/text/name.set-addX.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.set-addX.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.set-addX.txt Wed Apr 25 09:49:15 2007
@@ -1,7 +1,7 @@
Generic: set-add!
==============================
-A generic function.
+As #set-add#, but may modify _set_.
Exported from:
@@ -16,13 +16,13 @@
Arguments:
------------------------------
-arg - An instance of #<object>#.
-arg - An instance of #<object>#.
+set - An instance of #<bit-set>#.
+arg - An instance of #<integer>#.
Values:
------------------------------
-#rest more - Instances of #<object>#.
+set - An instance of #<bit-set>#.
Modified: trunk/documentation/gwydion/gdcore/text/name.set-complement.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.set-complement.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.set-complement.txt Wed Apr 25 09:49:15 2007
@@ -1,7 +1,8 @@
Generic: set-complement
==============================
-A generic function.
+Complement the indices of a bit set. All indices in the set are removed, and
+all indices not in the set are added.
Exported from:
@@ -16,12 +17,12 @@
Arguments:
------------------------------
-arg - An instance of #<object>#.
+set - An instance of #<bit-set>#.
Values:
------------------------------
-#rest more - Instances of #<object>#.
+new-set - An instance of #<bit-set>#.
Modified: trunk/documentation/gwydion/gdcore/text/name.set-complementX.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.set-complementX.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.set-complementX.txt Wed Apr 25 09:49:15 2007
@@ -1,7 +1,7 @@
Generic: set-complement!
==============================
-A generic function.
+As #set-complement#, but modifies _set_.
Exported from:
@@ -16,12 +16,12 @@
Arguments:
------------------------------
-arg - An instance of #<object>#.
+set - An instance of #<bit-set>#.
Values:
------------------------------
-#rest more - Instances of #<object>#.
+set - An instance of #<bit-set>#.
Modified: trunk/documentation/gwydion/gdcore/text/name.set-difference.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.set-difference.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.set-difference.txt Wed Apr 25 09:49:15 2007
@@ -1,7 +1,15 @@
Generic: set-difference
==============================
-A generic function.
+Returns the difference between two bit sets.
+
+: let a = make(<bit-set>, members: #(1, 2, 3));
+: let b = make(<bit-set>, members: #(3, 4, 5));
+: set-difference(a, b);
+
+This function employs the difference operation of set theory. The result of
+the above code is a set containing 1 and 2 rather than 1, 2, 4, and 5 as might
+otherwise be assumed.
Exported from:
@@ -16,13 +24,13 @@
Arguments:
------------------------------
-arg - An instance of #<object>#.
-arg - An instance of #<object>#.
+set1 - An instance of #<bit-set>#.
+set2 - An instance of #<bit-set>#.
Values:
------------------------------
-#rest more - Instances of #<object>#.
+new-set - An instance of #<bit-set>#.
Modified: trunk/documentation/gwydion/gdcore/text/name.set-differenceX.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.set-differenceX.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.set-differenceX.txt Wed Apr 25 09:49:15 2007
@@ -1,7 +1,7 @@
Generic: set-difference!
==============================
-A generic function.
+As #set-difference#, but may modify _set1_.
Exported from:
@@ -16,13 +16,13 @@
Arguments:
------------------------------
-arg - An instance of #<object>#.
-arg - An instance of #<object>#.
+set1 - An instance of #<bit-set>#.
+set2 - An instance of #<bit-set>#.
Values:
------------------------------
-#rest more - Instances of #<object>#.
+set1 - An instance of #<bit-set>#.
Modified: trunk/documentation/gwydion/gdcore/text/name.set-intersection.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.set-intersection.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.set-intersection.txt Wed Apr 25 09:49:15 2007
@@ -1,7 +1,7 @@
Generic: set-intersection
==============================
-A generic function.
+Returns the intersection of two bit sets.
Exported from:
@@ -16,13 +16,13 @@
Arguments:
------------------------------
-arg - An instance of #<object>#.
-arg - An instance of #<object>#.
+set1 - An instance of #<bit-set>#.
+set2 - An instance of #<bit-set>#.
Values:
------------------------------
-#rest more - Instances of #<object>#.
+new-set - An instance of #<bit-set>#.
Modified: trunk/documentation/gwydion/gdcore/text/name.set-intersectionX.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.set-intersectionX.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.set-intersectionX.txt Wed Apr 25 09:49:15 2007
@@ -1,7 +1,7 @@
Generic: set-intersection!
==============================
-A generic function.
+As #set-intersection#, but may modify _set1_.
Exported from:
@@ -16,13 +16,13 @@
Arguments:
------------------------------
-arg - An instance of #<object>#.
-arg - An instance of #<object>#.
+set1 - An instance of #<bit-set>#.
+set2 - An instance of #<bit-set>#.
Values:
------------------------------
-#rest more - Instances of #<object>#.
+set1 - An instance of #<bit-set>#.
Modified: trunk/documentation/gwydion/gdcore/text/name.set-remove.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.set-remove.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.set-remove.txt Wed Apr 25 09:49:15 2007
@@ -1,7 +1,7 @@
Generic: set-remove
==============================
-A generic function.
+Removes an index from a bit set.
Exported from:
@@ -16,13 +16,13 @@
Arguments:
------------------------------
-arg - An instance of #<object>#.
-arg - An instance of #<object>#.
+set - An instance of #<bit-set>#.
+arg - An instance of #<integer>#.
Values:
------------------------------
-#rest more - Instances of #<object>#.
+new-set - An instance of #<bit-set>#.
Modified: trunk/documentation/gwydion/gdcore/text/name.set-removeX.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.set-removeX.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.set-removeX.txt Wed Apr 25 09:49:15 2007
@@ -1,7 +1,7 @@
Generic: set-remove!
==============================
-A generic function.
+As #set-remove#, but _set_ may be modified.
Exported from:
@@ -16,13 +16,13 @@
Arguments:
------------------------------
-arg - An instance of #<object>#.
-arg - An instance of #<object>#.
+set - An instance of #<bit-set>#.
+arg - An instance of #<integer>#.
Values:
------------------------------
-#rest more - Instances of #<object>#.
+set - An instance of #<bit-set>#.
Modified: trunk/documentation/gwydion/gdcore/text/name.set-union.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.set-union.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.set-union.txt Wed Apr 25 09:49:15 2007
@@ -1,7 +1,7 @@
Generic: set-union
==============================
-A generic function.
+Returns the union of two bit sets.
Exported from:
@@ -16,13 +16,13 @@
Arguments:
------------------------------
-arg - An instance of #<object>#.
-arg - An instance of #<object>#.
+set1 - An instance of #<bit-set>#.
+set2 - An instance of #<bit-set>#.
Values:
------------------------------
-#rest more - Instances of #<object>#.
+new-set - An instance of #<bit-set>#.
Modified: trunk/documentation/gwydion/gdcore/text/name.set-unionX.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.set-unionX.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.set-unionX.txt Wed Apr 25 09:49:15 2007
@@ -1,7 +1,7 @@
Generic: set-union!
==============================
-A generic function.
+As #set-union#, but may modify _set1_.
Exported from:
@@ -16,13 +16,13 @@
Arguments:
------------------------------
-arg - An instance of #<object>#.
-arg - An instance of #<object>#.
+set1 - An instance of #<bit-set>#.
+set2 - An instance of #<bit-set>#.
Values:
------------------------------
-#rest more - Instances of #<object>#.
+set1 - An instance of #<bit-set>#.
Modified: trunk/documentation/gwydion/gdcore/text/name.universal-bit-setX.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.universal-bit-setX.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.universal-bit-setX.txt Wed Apr 25 09:49:15 2007
@@ -1,7 +1,7 @@
Function: universal-bit-set!
==============================
-A function.
+Alters a bit set to include all possible indices.
Exported from:
@@ -11,7 +11,7 @@
Arguments:
------------------------------
-arg - An instance of #<bit-set>#.
+set - An instance of #<bit-set>#.
More information about the chatter
mailing list