[Gd-chatter] r11283 - in trunk/documentation/gwydion/gdcore: . project text
agent at gwydiondylan.org
agent at gwydiondylan.org
Mon Apr 23 09:15:49 CEST 2007
Author: agent
Date: Mon Apr 23 09:15:43 2007
New Revision: 11283
Modified:
trunk/documentation/gwydion/gdcore/README
trunk/documentation/gwydion/gdcore/project/Topics.txt
trunk/documentation/gwydion/gdcore/text/name.Lbit-vectorR.txt
trunk/documentation/gwydion/gdcore/text/name.LbitR.txt
trunk/documentation/gwydion/gdcore/text/name.LintegerR.txt
trunk/documentation/gwydion/gdcore/text/name.Lobject-setR.txt
trunk/documentation/gwydion/gdcore/text/name.LobjectR.txt
trunk/documentation/gwydion/gdcore/text/name.LsetR.txt
trunk/documentation/gwydion/gdcore/text/name.bit-count.txt
trunk/documentation/gwydion/gdcore/text/name.bit-vector-and.txt
trunk/documentation/gwydion/gdcore/text/name.bit-vector-andX.txt
trunk/documentation/gwydion/gdcore/text/name.bit-vector-andc2.txt
trunk/documentation/gwydion/gdcore/text/name.bit-vector-andc2X.txt
trunk/documentation/gwydion/gdcore/text/name.bit-vector-not.txt
trunk/documentation/gwydion/gdcore/text/name.bit-vector-notX.txt
trunk/documentation/gwydion/gdcore/text/name.bit-vector-or.txt
trunk/documentation/gwydion/gdcore/text/name.bit-vector-orX.txt
trunk/documentation/gwydion/gdcore/text/name.bit-vector-word.txt
trunk/documentation/gwydion/gdcore/text/name.bit-vector-xor.txt
trunk/documentation/gwydion/gdcore/text/name.bit-vector-xorX.txt
trunk/documentation/gwydion/gdcore/text/name.split.txt
trunk/documentation/gwydion/gdcore/text/name.word-size.txt
Log:
Job: gd
Documented <set> and <bit-vector>. Additional minor edits.
Modified: trunk/documentation/gwydion/gdcore/README
==============================================================================
--- trunk/documentation/gwydion/gdcore/README (original)
+++ trunk/documentation/gwydion/gdcore/README Mon Apr 23 09:15:43 2007
@@ -17,6 +17,10 @@
- Library and Module API Layout
- Macro API Layout
- Other Conventions
+
+Scanning the NaturalDocs pages at http://naturaldocs.org might clear up any
+confusion I cause below. The documentation kit is downloadable from
+http://homepage.mac.com/d_j_v/FileSharing5.html.
=====
@@ -139,7 +143,7 @@
Variable / Slot
These are formatted like Topic headings (e.g. "Function: choose"), and show up
-like topics that in the generated HTML as well. These all create link targets.
+like topics in the generated HTML as well. These all create link targets.
If one of these is the first line in the text file, it will be formatted like
a title. That is generally what I do, rather than using an explicit Title
@@ -162,7 +166,7 @@
Italics
Bullet lists
Term/definition lists
- Code blocks and preformatted text
+ Code blocks and pre-formatted text
Headings
Links
@@ -197,7 +201,7 @@
with a hanging indent to make the text file easier to read.
o A blank line between makes no difference in the HTML, but is another way
- to improve readability.
+ to improve readability in the text file itself.
To make a term/definition list, put a hyphen with spaces around it:
Modified: trunk/documentation/gwydion/gdcore/project/Topics.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/project/Topics.txt (original)
+++ trunk/documentation/gwydion/gdcore/project/Topics.txt Mon Apr 23 09:15:43 2007
@@ -6,7 +6,7 @@
# instead.
-Ignore Keywords: key, note, object, target
+Ignore Keywords: key, note, object, target, setter
#-------------------------------------------------------------------------------
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 Mon Apr 23 09:15:43 2007
@@ -1,7 +1,18 @@
Class: <bit-vector>
==============================
-A class.
+A vector that contains #<bit>#s. The vector may be treated as a series of
+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:
+
+(diagram)
+Element 0 1 ... 30 31 32 33 ... 62 63 64 65 ...
+ +---------------+---------------+----------
+Word | LSB 0 MSB | LSB 1 MSB | LSB 2
+ +---------------+---------------+----------
+(end)
Exported from:
@@ -11,7 +22,26 @@
Modifiers:
------------------------------
-abstract primary open
+abstract primary open instantiable
+
+
+Make keywords:
+------------------------------
+size: - An instance of #<integer># specifying the size of the bit
+ vector in bits. The default is 0.
+
+fill: - An instance of #<bit># specifying an initial value for each
+ element of the bit vector. The default is 0.
+
+round-up-size?: - An instance of #<boolean>#. If true, the bit vector is sized
+ in 32-bit increments, sufficient to contain _size_ bits. For
+ example, a _size_ of 40 would result in a vector of 64 bits.
+ If false, the vector is sized to _size_ bits exactly. The
+ default is #f.
+
+copy-from: - An instance of #<bit-vector># that is copied to the new
+ instance. If the _copy-from_ instance is shorter than this
+ instance, remaining bits are filled as specified by _fill_.
Superclasses:
@@ -33,6 +63,7 @@
- #bit-vector-word#
- #bit-vector-xor#
- #bit-vector-xor!#
+- #word-size#
Functions returning <bit-vector>:
Modified: trunk/documentation/gwydion/gdcore/text/name.LbitR.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.LbitR.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.LbitR.txt Mon Apr 23 09:15:43 2007
@@ -1,7 +1,7 @@
Constant: <bit>
==============================
-A constant.
+An integer with a value of 0 or 1.
Exported from:
@@ -12,10 +12,38 @@
Type:
------------------------------
-#<object>#
+#<type>#
Value:
------------------------------
limited(<integer>, min: 0, max: 1)
+
+Functions on <bit>:
+------------------------------
+- #bit-count#
+- #bit-vector-and#
+- #bit-vector-and!#
+- #bit-vector-andc2#
+- #bit-vector-andc2!#
+- #bit-vector-not#
+- #bit-vector-not!#
+- #bit-vector-or#
+- #bit-vector-or!#
+- #bit-vector-xor#
+- #bit-vector-xor!#
+
+
+Function returning <bit>:
+------------------------------
+- #bit-vector-and#
+- #bit-vector-and!#
+- #bit-vector-andc2#
+- #bit-vector-andc2!#
+- #bit-vector-not#
+- #bit-vector-not!#
+- #bit-vector-or#
+- #bit-vector-or!#
+- #bit-vector-xor#
+- #bit-vector-xor!#
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 Mon Apr 23 09:15:43 2007
@@ -133,6 +133,7 @@
- #system#
- #value-hash#
- #values-hash#
+- #word-size#
Modified: trunk/documentation/gwydion/gdcore/text/name.Lobject-setR.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.Lobject-setR.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.Lobject-setR.txt Mon Apr 23 09:15:43 2007
@@ -1,7 +1,12 @@
Class: <object-set>
==============================
-A class.
+The class of sets of objects. Sets may contain or not contain a given key. Each key has itself as its value.
+
+In the following code, #t is ignored, but the set will subsequently contain
+#"red".
+
+: set[#"red"] := #t;
Exported from:
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 Mon Apr 23 09:15:43 2007
@@ -368,7 +368,6 @@
- #values#
- #values-hash#
- #vector#
-- #word-size#
- #writable-file-stream-position-setter#
- #write#
- #write-element#
@@ -590,7 +589,6 @@
- #uppercase?#
- #value#
- #values#
-- #word-size#
- #writable-file-stream-position-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 Mon Apr 23 09:15:43 2007
@@ -1,7 +1,15 @@
Class: <set>
==============================
-A class.
+The class of sets. Sets may contain or not contain a given key. Each key has
+itself as its value.
+
+In the following code, #t is ignored, but the set will subsequently contain
+#"red".
+
+: set[#"red"] := #t;
+
+#make# on #<set># returns an instance of #<object-set>#.
Exported from:
Modified: trunk/documentation/gwydion/gdcore/text/name.bit-count.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.bit-count.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.bit-count.txt Mon Apr 23 09:15:43 2007
@@ -1,7 +1,7 @@
Function: bit-count
==============================
-A function.
+Returns the number of bits set to 0 or 1 in a #<bit-vector>#.
Exported from:
@@ -11,13 +11,14 @@
Arguments:
------------------------------
-arg - An instance of #<bit-vector>#.
-bit-value: - An instance of limited(<integer>, min. The default is 1.
+vector - An instance of #<bit-vector>#.
+bit-value: - An instance of #<bit># specifying whether 0 bits or 1 bits should
+ be counted. The default is 1.
Values:
------------------------------
-val - An instance of #<integer>#.
+count - An instance of #<integer>#.
Modified: trunk/documentation/gwydion/gdcore/text/name.bit-vector-and.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.bit-vector-and.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.bit-vector-and.txt Mon Apr 23 09:15:43 2007
@@ -1,7 +1,16 @@
Function: bit-vector-and
==============================
-A function.
+Returns the bitwise AND of two bit vectors. The two vectors need not be the
+same size; the shorter vector is brought up to the length of the longer vector
+by virtually padding the shorter vector with bits set to _pad1_ or _pad2_.
+
+(code)
+let bv1 = as(<bit-vector>, #(1, 1));
+let bv2 = as(<bit-vector>, #(1, 1, 1, 0));
+bit-vector-and(bv1, bv2, pad1: 1);
+ ⇒ #(1, 1, 1, 0)
+(end)
Exported from:
@@ -11,16 +20,19 @@
Arguments:
------------------------------
-arg - An instance of #<bit-vector>#.
-arg - An instance of #<bit-vector>#.
-pad1: - An instance of limited(<integer>, min. The default is 0.
-pad2: - An instance of limited(<integer>, min. The default is 0.
+vector1 - An instance of #<bit-vector>#.
+vector2 - An instance of #<bit-vector>#.
+pad1: - An instance of #<bit>#, used if needed to expand the effective size
+ of _vector1_. The default is 0.
+pad2: - An instance of #<bit>#, used if needed to expand the effective size
+ of _vector2_. The default is 0.
Values:
------------------------------
-val - An instance of #<bit-vector>#.
-val - An instance of limited(<integer>, min.
+result - An instance of #<bit-vector>#.
+pad - An instance of #<bit>#. Any bits past the size of _result_ would have
+ this value.
Modified: trunk/documentation/gwydion/gdcore/text/name.bit-vector-andX.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.bit-vector-andX.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.bit-vector-andX.txt Mon Apr 23 09:15:43 2007
@@ -1,7 +1,7 @@
Function: bit-vector-and!
==============================
-A function.
+As #bit-vector-and#, but _vector1_ may be modified.
Exported from:
@@ -11,16 +11,19 @@
Arguments:
------------------------------
-arg - An instance of #<bit-vector>#.
-arg - An instance of #<bit-vector>#.
-pad1: - An instance of limited(<integer>, min. The default is 0.
-pad2: - An instance of limited(<integer>, min. The default is 0.
+vector1 - An instance of #<bit-vector>#.
+vector2 - An instance of #<bit-vector>#.
+pad1: - An instance of #<bit>#, used if needed to expand the effective size
+ of _vector1_. The default is 0.
+pad2: - An instance of #<bit>#, used if needed to expand the effective size
+ of _vector2_. The default is 0.
Values:
------------------------------
-val - An instance of #<bit-vector>#.
-val - An instance of limited(<integer>, min.
+result - An instance of #<bit-vector>#.
+pad - An instance of #<bit>#. Any bits past the size of _result_ would be
+ set to this value.
Modified: trunk/documentation/gwydion/gdcore/text/name.bit-vector-andc2.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.bit-vector-andc2.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.bit-vector-andc2.txt Mon Apr 23 09:15:43 2007
@@ -1,7 +1,7 @@
Function: bit-vector-andc2
==============================
-A function.
+As #bit-vector-and#, but _vector2_ is complemented beforehand.
Exported from:
@@ -11,16 +11,19 @@
Arguments:
------------------------------
-arg - An instance of #<bit-vector>#.
-arg - An instance of #<bit-vector>#.
-pad1: - An instance of limited(<integer>, min. The default is 0.
-pad2: - An instance of limited(<integer>, min. The default is 0.
+vector1 - An instance of #<bit-vector>#.
+vector2 - An instance of #<bit-vector>#.
+pad1: - An instance of #<bit>#, used if needed to expand the effective size
+ of _vector1_. The default is 0.
+pad2: - An instance of #<bit>#, used if needed to expand the effective size
+ of _vector2_ before it is complemented. The default is 0.
Values:
------------------------------
-val - An instance of #<bit-vector>#.
-val - An instance of limited(<integer>, min.
+result - An instance of #<bit-vector>#.
+pad - An instance of #<bit>#. Any bits past the size of _result_ would be
+ set to this value.
Modified: trunk/documentation/gwydion/gdcore/text/name.bit-vector-andc2X.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.bit-vector-andc2X.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.bit-vector-andc2X.txt Mon Apr 23 09:15:43 2007
@@ -1,7 +1,7 @@
Function: bit-vector-andc2!
==============================
-A function.
+As #bit-vector-andc2#, but _vector1_ may be modified.
Exported from:
@@ -11,16 +11,19 @@
Arguments:
------------------------------
-arg - An instance of #<bit-vector>#.
-arg - An instance of #<bit-vector>#.
-pad1: - An instance of limited(<integer>, min. The default is 0.
-pad2: - An instance of limited(<integer>, min. The default is 0.
+vector1 - An instance of #<bit-vector>#.
+vector2 - An instance of #<bit-vector>#.
+pad1: - An instance of #<bit>#, used if needed to expand the effective size
+ of _vector1_. The default is 0.
+pad2: - An instance of #<bit>#, used if needed to expand the effective size
+ of _vector2_ before it is complemented. The default is 0.
Values:
------------------------------
-val - An instance of #<bit-vector>#.
-val - An instance of limited(<integer>, min.
+result - An instance of #<bit-vector>#.
+pad - An instance of #<bit>#. Any bits past the size of _result_ would be
+ set to this value.
Modified: trunk/documentation/gwydion/gdcore/text/name.bit-vector-not.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.bit-vector-not.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.bit-vector-not.txt Mon Apr 23 09:15:43 2007
@@ -1,7 +1,7 @@
Function: bit-vector-not
==============================
-A function.
+Returns the complement of a bit vector.
Exported from:
@@ -11,14 +11,14 @@
Arguments:
------------------------------
-arg - An instance of #<bit-vector>#.
-pad: - An instance of limited(<integer>, min. The default is 0.
+vector - An instance of #<bit-vector>#.
+pad: - An instance of #<bit>#. The default is 0.
Values:
------------------------------
-val - An instance of #<bit-vector>#.
-val - An instance of limited(<integer>, min.
+result - An instance of #<bit-vector>#.
+result-pad - An instance of #<bit>#. The complement of _pad_.
Modified: trunk/documentation/gwydion/gdcore/text/name.bit-vector-notX.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.bit-vector-notX.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.bit-vector-notX.txt Mon Apr 23 09:15:43 2007
@@ -1,7 +1,7 @@
Function: bit-vector-not!
==============================
-A function.
+As #bit-vector-not#, but _vector_ is modified.
Exported from:
@@ -11,14 +11,14 @@
Arguments:
------------------------------
-arg - An instance of #<bit-vector>#.
-pad: - An instance of limited(<integer>, min. The default is 0.
+vector - An instance of #<bit-vector>#.
+pad: - An instance of #<bit>#. The default is 0.
Values:
------------------------------
-val - An instance of #<bit-vector>#.
-val - An instance of limited(<integer>, min.
+result - An instance of #<bit-vector>#.
+result-pad - An instance of #<bit>#. The complement of _pad_.
Modified: trunk/documentation/gwydion/gdcore/text/name.bit-vector-or.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.bit-vector-or.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.bit-vector-or.txt Mon Apr 23 09:15:43 2007
@@ -1,7 +1,16 @@
Function: bit-vector-or
==============================
-A function.
+Returns the bitwise OR of two bit vectors. The two vectors need not be the
+same size; the shorter vector is brought up to the length of the longer vector
+by virtually padding the shorter vector with bits set to _pad1_ or _pad2_.
+
+(code)
+let bv1 = as(<bit-vector>, #(1, 1));
+let bv2 = as(<bit-vector>, #(1, 1, 1, 0));
+bit-vector-or(bv1, bv2, pad1: 0);
+ ⇒ #(1, 1, 1, 0)
+(end)
Exported from:
@@ -11,16 +20,19 @@
Arguments:
------------------------------
-arg - An instance of #<bit-vector>#.
-arg - An instance of #<bit-vector>#.
-pad1: - An instance of limited(<integer>, min. The default is 0.
-pad2: - An instance of limited(<integer>, min. The default is 0.
+vector1 - An instance of #<bit-vector>#.
+vector2 - An instance of #<bit-vector>#.
+pad1: - An instance of #<bit>#, used if needed to expand the effective size
+ of _vector1_. The default is 0.
+pad2: - An instance of #<bit>#, used if needed to expand the effective size
+ of _vector2_. The default is 0.
Values:
------------------------------
-val - An instance of #<bit-vector>#.
-val - An instance of limited(<integer>, min.
+result - An instance of #<bit-vector>#.
+pad - An instance of #<bit>#. Any bits past the size of _result_ would have
+ this value.
Modified: trunk/documentation/gwydion/gdcore/text/name.bit-vector-orX.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.bit-vector-orX.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.bit-vector-orX.txt Mon Apr 23 09:15:43 2007
@@ -1,7 +1,7 @@
Function: bit-vector-or!
==============================
-A function.
+As #bit-vector-or#, but _vector1_ may be modified.
Exported from:
@@ -11,16 +11,19 @@
Arguments:
------------------------------
-arg - An instance of #<bit-vector>#.
-arg - An instance of #<bit-vector>#.
-pad1: - An instance of limited(<integer>, min. The default is 0.
-pad2: - An instance of limited(<integer>, min. The default is 0.
+vector1 - An instance of #<bit-vector>#.
+vector2 - An instance of #<bit-vector>#.
+pad1: - An instance of #<bit>#, used if needed to expand the effective size
+ of _vector1_. The default is 0.
+pad2: - An instance of #<bit>#, used if needed to expand the effective size
+ of _vector2_. The default is 0.
Values:
------------------------------
-val - An instance of #<bit-vector>#.
-val - An instance of limited(<integer>, min.
+result - An instance of #<bit-vector>#.
+pad - An instance of #<bit>#. Any bits past the size of _result_ would have
+ this value.
Modified: trunk/documentation/gwydion/gdcore/text/name.bit-vector-word.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.bit-vector-word.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.bit-vector-word.txt Mon Apr 23 09:15:43 2007
@@ -1,7 +1,8 @@
Generic: bit-vector-word
==============================
-A generic function.
+Returns a word of the bit vector. See #<bit-vector># for the mapping between
+elements and words.
Exported from:
@@ -16,13 +17,13 @@
Arguments:
------------------------------
-arg - An instance of #<bit-vector>#.
-arg - An instance of #<integer>#.
+vector - An instance of #<bit-vector>#.
+index - An instance of #<integer>#. The index of a word in _vector_.
Values:
------------------------------
-val - An instance of #<machine-word>#.
+word - An instance of #<machine-word>#.
Modified: trunk/documentation/gwydion/gdcore/text/name.bit-vector-xor.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.bit-vector-xor.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.bit-vector-xor.txt Mon Apr 23 09:15:43 2007
@@ -1,7 +1,16 @@
Function: bit-vector-xor
==============================
-A function.
+Returns the bitwise XOR of two bit vectors. The two vectors need not be the
+same size; the shorter vector is brought up to the length of the longer vector
+by virtually padding the shorter vector with bits set to _pad1_ or _pad2_.
+
+(code)
+let bv1 = as(<bit-vector>, #(0, 1));
+let bv2 = as(<bit-vector>, #(1, 1, 1, 0));
+bit-vector-xor(bv1, bv2, pad1: 1);
+ ⇒ #(1, 0, 0, 1)
+(end)
Exported from:
@@ -11,16 +20,19 @@
Arguments:
------------------------------
-arg - An instance of #<bit-vector>#.
-arg - An instance of #<bit-vector>#.
-pad1: - An instance of limited(<integer>, min. The default is 0.
-pad2: - An instance of limited(<integer>, min. The default is 0.
+vector1 - An instance of #<bit-vector>#.
+vector2 - An instance of #<bit-vector>#.
+pad1: - An instance of #<bit>#, used if needed to expand the effective size
+ of _vector1_. The default is 0.
+pad2: - An instance of #<bit>#, used if needed to expand the effective size
+ of _vector2_. The default is 0.
Values:
------------------------------
-val - An instance of #<bit-vector>#.
-val - An instance of limited(<integer>, min.
+result - An instance of #<bit-vector>#.
+pad - An instance of #<bit>#. Any bits past the size of _result_ would have
+ this value.
Modified: trunk/documentation/gwydion/gdcore/text/name.bit-vector-xorX.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.bit-vector-xorX.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.bit-vector-xorX.txt Mon Apr 23 09:15:43 2007
@@ -1,7 +1,7 @@
Function: bit-vector-xor!
==============================
-A function.
+As #bit-vector-xor#, but _vector1_ may be modified.
Exported from:
@@ -11,16 +11,19 @@
Arguments:
------------------------------
-arg - An instance of #<bit-vector>#.
-arg - An instance of #<bit-vector>#.
-pad1: - An instance of limited(<integer>, min. The default is 0.
-pad2: - An instance of limited(<integer>, min. The default is 0.
+vector1 - An instance of #<bit-vector>#.
+vector2 - An instance of #<bit-vector>#.
+pad1: - An instance of #<bit>#, used if needed to expand the effective size
+ of _vector1_. The default is 0.
+pad2: - An instance of #<bit>#, used if needed to expand the effective size
+ of _vector2_. The default is 0.
Values:
------------------------------
-val - An instance of #<bit-vector>#.
-val - An instance of limited(<integer>, min.
+result - An instance of #<bit-vector>#.
+pad - An instance of #<bit>#. Any bits past the size of _result_ would have
+ this value.
Modified: trunk/documentation/gwydion/gdcore/text/name.split.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.split.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.split.txt Mon Apr 23 09:15:43 2007
@@ -11,24 +11,24 @@
> split("The summer chair / rocking by itself / in the blizzard", '/')
> ⇒ #("The summer chair ",
-> " rocking by itself ",
-> " in the blizzard")
+> " rocking by itself ",
+> " in the blizzard")
_trim?:_ specifies whether spaces surrounding _character_ should be removed.
> split("The summer chair / rocking by itself / in the blizzard",
> '/', trim?: #t)
> ⇒ #("The summer chair",
-> "rocking by itself",
-> "in the blizzard")
+> "rocking by itself",
+> "in the blizzard")
Consecutive separator characters result in empty strings.
> split("Who are you? Who am I?!", ' ')
> ⇒ #("Who", "are", "you?", "", "Who", "am", "I?!")
-The only defined method is on #<byte-string>#. This method defaults _trim:?_
-to #t.
+_Note:_ The only defined method is on #<byte-string>#, and it defaults
+_trim:?_ to #t.
Exported from:
@@ -44,11 +44,11 @@
Arguments:
------------------------------
-collection - An instance of #<string>#.
-character - An instance of #<character>#.
-start: - An instance of #<integer>#. Required.
-end: - An instance of #<integer>#. Required.
-trim?: - An instance of #<boolean>#. The default is #f.
+string - An instance of #<string>#. The string to split.
+character - An instance of #<character>#. The character to split around.
+start: - An instance of #<integer>#. Required.
+end: - An instance of #<integer>#. Required.
+trim?: - An instance of #<boolean>#. The default is #f.
Values:
@@ -76,7 +76,7 @@
returns values("long", "with", "multiple", "dashes"). _Count_ is the maximum
number of strings to return. If there are _n_ strings and _count_ is
specified, the first _count_ - 1 strings are returned as usual, and the
-_count_th string is the remainder, unsplit. So
+_count_ th string is the remainder, unsplit. So
: split("-", "really-long-dylan-identifier", count: 3)
@@ -90,7 +90,11 @@
returns values("really-long", "dylan", "identifier").
-Note: Unlike Perl, empty regular expressions are never legal regular
+The values returned can be stored in a collection as follows.
+
+: let (#rest parts) = split(...)
+
+_Note:_ Unlike Perl, empty regular expressions are never legal regular
expressions, so there is no way to split a string into a bunch of single
character strings. Of course, in Dylan this is not a useful thing to do (as
one can get each character of the string by iteration or by indexing), so this
Modified: trunk/documentation/gwydion/gdcore/text/name.word-size.txt
==============================================================================
--- trunk/documentation/gwydion/gdcore/text/name.word-size.txt (original)
+++ trunk/documentation/gwydion/gdcore/text/name.word-size.txt Mon Apr 23 09:15:43 2007
@@ -1,7 +1,8 @@
Generic: word-size
==============================
-A generic function.
+Treating a bit vector as 32-bit words, returns the number of words in the
+vector.
Exported from:
@@ -16,12 +17,12 @@
Arguments:
------------------------------
-arg - An instance of #<object>#.
+vector - An instance of #<bit-vector>#.
Values:
------------------------------
-#rest more - Instances of #<object>#.
+size - An instance of #<integer>#.
More information about the chatter
mailing list