[chatter] r11804 - in trunk/documentation/topic/reference/lib: common-dylan common-dylan/common-extensions common-dylan/machine-words common-dylan/threads common-dylan/transcendentals dylan/dylan
housel at mccarthy.opendylan.org
housel at mccarthy.opendylan.org
Sun May 11 07:15:51 CEST 2008
Author: housel
Date: Sun May 11 07:15:48 2008
New Revision: 11804
Modified:
trunk/documentation/topic/reference/lib/common-dylan/common-extensions/Dunfound.xml
trunk/documentation/topic/reference/lib/common-dylan/machine-words/as_unsigned.xml
trunk/documentation/topic/reference/lib/common-dylan/threads.xml
trunk/documentation/topic/reference/lib/common-dylan/threads/LnotificationG.xml
trunk/documentation/topic/reference/lib/common-dylan/threads/Lread_write_lockG.xml
trunk/documentation/topic/reference/lib/common-dylan/threads/sequence_point.xml
trunk/documentation/topic/reference/lib/common-dylan/transcendentals.xml
trunk/documentation/topic/reference/lib/common-dylan/transcendentals/Ddouble_e.xml
trunk/documentation/topic/reference/lib/common-dylan/transcendentals/Dsingle_e.xml
trunk/documentation/topic/reference/lib/common-dylan/transcendentals/acos.xml
trunk/documentation/topic/reference/lib/dylan/dylan/LdequeG.xml
trunk/documentation/topic/reference/lib/dylan/dylan/LintegerG.xml
trunk/documentation/topic/reference/lib/dylan/dylan/Lmutable_collectionG.xml
trunk/documentation/topic/reference/lib/dylan/dylan/Lstretchy_vectorG.xml
trunk/documentation/topic/reference/lib/dylan/dylan/Lunicode_stringG.xml
trunk/documentation/topic/reference/lib/dylan/dylan/concatenate_as.xml
trunk/documentation/topic/reference/lib/dylan/dylan/element.xml
trunk/documentation/topic/reference/lib/dylan/dylan/element_setter.xml
trunk/documentation/topic/reference/lib/dylan/dylan/function_definer.xml
trunk/documentation/topic/reference/lib/dylan/dylan/object_hash.xml
trunk/documentation/topic/reference/lib/dylan/dylan/table_protocol.xml
Log:
Bug: 7249
Correct cross-reference links, and incorporate more text from the
Functional Developer documentation.
Modified: trunk/documentation/topic/reference/lib/common-dylan/common-extensions/Dunfound.xml
==============================================================================
--- trunk/documentation/topic/reference/lib/common-dylan/common-extensions/Dunfound.xml (original)
+++ trunk/documentation/topic/reference/lib/common-dylan/common-extensions/Dunfound.xml Sun May 11 07:15:48 2008
@@ -20,7 +20,7 @@
</dylanConstantDef>
<apiDesc>
- <p>The <apivalue>$unfound</apivalue> constant represents a
+ <p>The <apiname>$unfound</apiname> constant represents a
unique value that can be used to indicate that a search
operation failed.</p>
</apiDesc>
Modified: trunk/documentation/topic/reference/lib/common-dylan/machine-words/as_unsigned.xml
==============================================================================
--- trunk/documentation/topic/reference/lib/common-dylan/machine-words/as_unsigned.xml (original)
+++ trunk/documentation/topic/reference/lib/common-dylan/machine-words/as_unsigned.xml Sun May 11 07:15:48 2008
@@ -36,7 +36,7 @@
<apiDesc>
<p>The value of <parmname>m</parmname> is interpreted as an
unsigned value and converted to an instance of <apiclassifier
- href="../common-extensions/Labstract_integerG.xml"><abstract-integer></apiclassifier>,
+ href="../../c-ffi/c-ffi/Labstract_integerG.xml"><abstract-integer></apiclassifier>,
then the result of that conversion is converted to type
<parmname>t</parmname> using <apioperation
href="../../dylan/dylan/as.xml">as</apioperation>.</p>
Modified: trunk/documentation/topic/reference/lib/common-dylan/threads.xml
==============================================================================
--- trunk/documentation/topic/reference/lib/common-dylan/threads.xml (original)
+++ trunk/documentation/topic/reference/lib/common-dylan/threads.xml Sun May 11 07:15:48 2008
@@ -15,8 +15,8 @@
<dylanModuleDetail>
<apiDesc>
<p>The <apipackage>threads</apipackage> module of the
- <apipackage>common-dylan</apipackage> library provides a
- portable threads interface for Dylan. The
+ <apipackage href="../common-dylan.xml">common-dylan</apipackage>
+ library provides a portable threads interface for Dylan. The
<apipackage>threads</apipackage> module is designed to map
easily and efficiently onto the threads facilities provided by
all common operating systems. </p>
Modified: trunk/documentation/topic/reference/lib/common-dylan/threads/LnotificationG.xml
==============================================================================
--- trunk/documentation/topic/reference/lib/common-dylan/threads/LnotificationG.xml (original)
+++ trunk/documentation/topic/reference/lib/common-dylan/threads/LnotificationG.xml Sun May 11 07:15:48 2008
@@ -69,16 +69,17 @@
which is used to notify other threads that an object is being put
onto an empty queue.</p>
- <pre>define constant *something-queued* =</pre>
-
- <pre>make(<notification>, lock: *lock*);</pre>
+<codeblock>
+define constant *something-queued* =
+ make(<notification>, lock: *lock*);
+</codeblock>
<p>The function <codeph>put-on-queue</codeph> pushes an object onto
the queue. If the queue was initially empty, then all threads which
are waiting for the queue to fill are notified that there is a new
entry.</p>
- <codeblock>
+<codeblock>
define method put-on-queue (object) => ()
with-lock (*lock*)
if (*queue*.empty?)
@@ -96,7 +97,7 @@
again to see if an object is present, in case it was popped by
another thread.</p>
- <codeblock>
+<codeblock>
define method get-from-queue () => (object)
with-lock (*lock*)
while (*queue*.empty?)
Modified: trunk/documentation/topic/reference/lib/common-dylan/threads/Lread_write_lockG.xml
==============================================================================
--- trunk/documentation/topic/reference/lib/common-dylan/threads/Lread_write_lockG.xml (original)
+++ trunk/documentation/topic/reference/lib/common-dylan/threads/Lread_write_lockG.xml Sun May 11 07:15:48 2008
@@ -22,7 +22,7 @@
</dylanClassDef>
<apiDesc>
- <p>The <apiname><;read-write-lock></apiname> class
+ <p>The <apiname><read-write-lock></apiname> class
represents locks that can have multiple readers but only one
writer.</p>
Modified: trunk/documentation/topic/reference/lib/common-dylan/threads/sequence_point.xml
==============================================================================
--- trunk/documentation/topic/reference/lib/common-dylan/threads/sequence_point.xml (original)
+++ trunk/documentation/topic/reference/lib/common-dylan/threads/sequence_point.xml Sun May 11 07:15:48 2008
@@ -3,7 +3,7 @@
<dylanFunction id="lib-common-dylan-threads-sequence_point">
<apiName>sequence-point</apiName>
- <shortdesc>>Tells the compiler that it must consider the possibility
+ <shortdesc>Tells the compiler that it must consider the possibility
of visible side effects from other threads at the point of the
call</shortdesc>
Modified: trunk/documentation/topic/reference/lib/common-dylan/transcendentals.xml
==============================================================================
--- trunk/documentation/topic/reference/lib/common-dylan/transcendentals.xml (original)
+++ trunk/documentation/topic/reference/lib/common-dylan/transcendentals.xml Sun May 11 07:15:48 2008
@@ -15,10 +15,12 @@
<dylanModuleDetail>
<apiDesc>
<p>The <apiname>transcendentals</apiname> module, exported from
- the <apipackage>common-dylan</apipackage> library, provides a
- set of open generic functions for ANSI C-like behavior over real
- numbers. The restrictions and error cases described in this
- chapter are intended to be the same as they are in ANSI C.</p>
+ the <apipackage
+ href="../common-dylan.xml">common-dylan</apipackage> library,
+ provides a set of open generic functions for ANSI C-like
+ behavior over real numbers. The restrictions and error cases
+ described in this chapter are intended to be the same as they
+ are in ANSI C.</p>
<p>Because implementation of these functions might be by a
standard library for transcendentals accessed by a foreign
Modified: trunk/documentation/topic/reference/lib/common-dylan/transcendentals/Ddouble_e.xml
==============================================================================
--- trunk/documentation/topic/reference/lib/common-dylan/transcendentals/Ddouble_e.xml (original)
+++ trunk/documentation/topic/reference/lib/common-dylan/transcendentals/Ddouble_e.xml Sun May 11 07:15:48 2008
@@ -20,7 +20,7 @@
</dylanConstantDef>
<apiDesc>
- <p>The value of <codeph>e</codeph>, the base of natural
+ <p>The value of <i>e</i>, the base of natural
logarithms, as a double precision floating point number.</p>
</apiDesc>
</dylanConstantDetail>
Modified: trunk/documentation/topic/reference/lib/common-dylan/transcendentals/Dsingle_e.xml
==============================================================================
--- trunk/documentation/topic/reference/lib/common-dylan/transcendentals/Dsingle_e.xml (original)
+++ trunk/documentation/topic/reference/lib/common-dylan/transcendentals/Dsingle_e.xml Sun May 11 07:15:48 2008
@@ -20,7 +20,7 @@
</dylanConstantDef>
<apiDesc>
- <p>The value of <codeph>e</codeph>, the base of natural logarithms,
+ <p>The value of <i>e</i>, the base of natural logarithms,
as a single-precision floating point number.</p>
</apiDesc>
</dylanConstantDetail>
Modified: trunk/documentation/topic/reference/lib/common-dylan/transcendentals/acos.xml
==============================================================================
--- trunk/documentation/topic/reference/lib/common-dylan/transcendentals/acos.xml (original)
+++ trunk/documentation/topic/reference/lib/common-dylan/transcendentals/acos.xml Sun May 11 07:15:48 2008
@@ -33,10 +33,12 @@
precision of the result is given by the precision of
<varname>x</varname>. The result is a
<apiclassifier><single-float></apiclassifier> if
- <varname>x</varname> is an
- <apiclassifier><integer></apiclassifier>.</p>
+ <varname>x</varname> is an <apiclassifier
+ href="../../dylan/dylan/LintegerG.xml"><integer></apiclassifier>.
+ </p>
</apiDesc>
</dylanGenericFunctionDetail>
+
<related-links>
<link href="asin.xml">
<linktext>The <apiname>asin</apiname> function</linktext>
Modified: trunk/documentation/topic/reference/lib/dylan/dylan/LdequeG.xml
==============================================================================
--- trunk/documentation/topic/reference/lib/dylan/dylan/LdequeG.xml (original)
+++ trunk/documentation/topic/reference/lib/dylan/dylan/LdequeG.xml Sun May 11 07:15:48 2008
@@ -16,7 +16,8 @@
<dylanClassDef>
<dylanOpenClass/>
<dylanAbstractClass value="abstract-uninstantiable"/>
- <dylanSuperClass href="../dylan-extensions/Lstretchy_mutable_sequenceG.xml"><stretchy-mutable-sequence></dylanSuperClass>
+ <dylanSuperClass href="Lmutable_sequenceG.xml"><mutable-sequence></dylanSuperClass>
+ <dylanSuperClass href="Lstretchy_collectionG.xml"><stretchy-collection></dylanSuperClass>
</dylanClassDef>
<apiDesc>
Modified: trunk/documentation/topic/reference/lib/dylan/dylan/LintegerG.xml
==============================================================================
--- trunk/documentation/topic/reference/lib/dylan/dylan/LintegerG.xml (original)
+++ trunk/documentation/topic/reference/lib/dylan/dylan/LintegerG.xml Sun May 11 07:15:48 2008
@@ -14,7 +14,7 @@
<dylanClassDetail>
<dylanClassDef>
- <dylanSuperClass href="../../common-dylan/common-extensions/Labstract_integerG.xml"><abstract-integer></dylanSuperClass>
+ <dylanSuperClass href="../../c-ffi/c-ffi/Labstract_integerG.xml"><abstract-integer></dylanSuperClass>
</dylanClassDef>
<apiDesc>
Modified: trunk/documentation/topic/reference/lib/dylan/dylan/Lmutable_collectionG.xml
==============================================================================
--- trunk/documentation/topic/reference/lib/dylan/dylan/Lmutable_collectionG.xml (original)
+++ trunk/documentation/topic/reference/lib/dylan/dylan/Lmutable_collectionG.xml Sun May 11 07:15:48 2008
@@ -17,7 +17,6 @@
<dylanOpenClass/>
<dylanAbstractClass value="abstract-uninstantiable"/>
<dylanSuperClass href="LcollectionG.xml"><collection></dylanSuperClass>
- <dylanSuperClass href="../dylan-extensions/Lmutable_object_with_elementsG.xml"><mutable-object-with-elements></dylanSuperClass>
</dylanClassDef>
<apiDesc>
Modified: trunk/documentation/topic/reference/lib/dylan/dylan/Lstretchy_vectorG.xml
==============================================================================
--- trunk/documentation/topic/reference/lib/dylan/dylan/Lstretchy_vectorG.xml (original)
+++ trunk/documentation/topic/reference/lib/dylan/dylan/Lstretchy_vectorG.xml Sun May 11 07:15:48 2008
@@ -16,8 +16,8 @@
<dylanClassDef>
<dylanOpenClass/>
<dylanAbstractClass value="abstract-uninstantiable"/>
- <dylanSuperClass href="../dylan-extensions/Lstretchy_sequenceG.xml"><stretchy-sequence></dylanSuperClass>
<dylanSuperClass href="LvectorG.xml"><vector></dylanSuperClass>
+ <dylanSuperClass href="Lstretchy_collectionG.xml"><stretchy-collection></dylanSuperClass>
</dylanClassDef>
<apiDesc>
Modified: trunk/documentation/topic/reference/lib/dylan/dylan/Lunicode_stringG.xml
==============================================================================
--- trunk/documentation/topic/reference/lib/dylan/dylan/Lunicode_stringG.xml (original)
+++ trunk/documentation/topic/reference/lib/dylan/dylan/Lunicode_stringG.xml Sun May 11 07:15:48 2008
@@ -19,7 +19,7 @@
<dylanSuperClass href="LvectorG.xml"><vector></dylanSuperClass>
<dylanInitKeyword>
<apiItemName>fill:</apiItemName>
- <apiOtherClassifier href="../dylan-extensions/Lunicode_characterG.xml"><unicode-character></apiOtherClassifier>
+ <apiOtherClassifier href="../../io/streams/Lunicode_characterG.xml"><unicode-character></apiOtherClassifier>
<apiDefNote></apiDefNote>
</dylanInitKeyword>
</dylanClassDef>
Modified: trunk/documentation/topic/reference/lib/dylan/dylan/concatenate_as.xml
==============================================================================
--- trunk/documentation/topic/reference/lib/dylan/dylan/concatenate_as.xml (original)
+++ trunk/documentation/topic/reference/lib/dylan/dylan/concatenate_as.xml Sun May 11 07:15:48 2008
@@ -16,7 +16,8 @@
<dylanGenericFunctionDef>
<dylanFunctionParam>
<apiItemName>type</apiItemName>
- <apiOperationClassifier href="../internal/Lmutable_sequence_typeG.xml"><mutable-sequence-type></apiOperationClassifier>
+ <!-- <mutable-sequence-type> -->
+ <apiOperationClassifier href="LtypeG.xml"><type></apiOperationClassifier>
<apiDefNote></apiDefNote>
</dylanFunctionParam>
<dylanFunctionParam>
Modified: trunk/documentation/topic/reference/lib/dylan/dylan/element.xml
==============================================================================
--- trunk/documentation/topic/reference/lib/dylan/dylan/element.xml (original)
+++ trunk/documentation/topic/reference/lib/dylan/dylan/element.xml Sun May 11 07:15:48 2008
@@ -17,7 +17,7 @@
<dylanGenericFunctionSealing value='open'/>
<dylanFunctionParam>
<apiItemName>collection</apiItemName>
- <apiOperationClassifier href="../dylan-extensions/Lobject_with_elementsG.xml"><object-with-elements></apiOperationClassifier>
+ <apiOperationClassifier href="LcollectionG.xml"><collection></apiOperationClassifier>
<apiDefNote></apiDefNote>
</dylanFunctionParam>
<dylanFunctionParam>
Modified: trunk/documentation/topic/reference/lib/dylan/dylan/element_setter.xml
==============================================================================
--- trunk/documentation/topic/reference/lib/dylan/dylan/element_setter.xml (original)
+++ trunk/documentation/topic/reference/lib/dylan/dylan/element_setter.xml Sun May 11 07:15:48 2008
@@ -22,7 +22,7 @@
</dylanFunctionParam>
<dylanFunctionParam>
<apiItemName>collection</apiItemName>
- <apiOperationClassifier href="../dylan-extensions/Lmutable_object_with_elementsG.xml"><mutable-object-with-elements></apiOperationClassifier>
+ <apiOperationClassifier href="../dylan-extensions/Lmutable_collection.xml"><mutable-collection></apiOperationClassifier>
<apiDefNote></apiDefNote>
</dylanFunctionParam>
<dylanFunctionParam>
Modified: trunk/documentation/topic/reference/lib/dylan/dylan/function_definer.xml
==============================================================================
--- trunk/documentation/topic/reference/lib/dylan/dylan/function_definer.xml (original)
+++ trunk/documentation/topic/reference/lib/dylan/dylan/function_definer.xml Sun May 11 07:15:48 2008
@@ -2,7 +2,9 @@
<!DOCTYPE dylanMacro PUBLIC "-//Gwydion//DTD DITA Dylan API Macro//EN" "../../../../dtd/dylanMacro.dtd" []>
<dylanMacro id="lib-dylan-dylan-function_definer">
<apiName>function-definer</apiName>
- <shortdesc></shortdesc>
+
+ <shortdesc>Defines a constant binding in the current module and
+ initializes it to a new function.</shortdesc>
<prolog>
<author></author>
@@ -14,11 +16,68 @@
<dylanMacroDetail>
<apiSyntax>
- <apiSyntaxText></apiSyntaxText>
+ <apiSyntaxText>define {<apiItemName>adjective</apiItemName>}* function <apiItemName>name</apiItemName> <apiItemName>parameter-list</apiItemName>
+ [ <apiItemName>body</apiItemName> ]
+end [ function ] [ <apiItemName>name</apiItemName> ]</apiSyntaxText>
+ <apiSyntaxItem>
+ <apiItemName>adjective</apiItemName>
+ <apiDefNote>A Dylan unreserved-name.</apiDefNote>
+ </apiSyntaxItem>
+ <apiSyntaxItem>
+ <apiItemName>name</apiItemName>
+ <apiDefNote>A Dylan variable-name.</apiDefNote>
+ </apiSyntaxItem>
+ <apiSyntaxItem>
+ <apiItemName>parameter-list</apiItemName>
+ <apiDefNote>A Dylan parameter-list.</apiDefNote>
+ </apiSyntaxItem>
+ <apiSyntaxItem>
+ <apiItemName>body</apiItemName>
+ <apiDefNote>A Dylan body.</apiDefNote>
+ </apiSyntaxItem>
</apiSyntax>
<apiDesc>
- <p></p>
+ <p>Creates a constant module binding with the name
+ <apiname>name</apiname>, and initializes it to a new function
+ described by <apiname>parameter-list</apiname>,
+ <apiname>options</apiname>, and any
+ <apiname>adjectives</apiname>.</p>
+
+ <p>The adjectives permitted depend on the implementation. </p>
+
+ <p>The <apiname>parameter-list</apiname> describes the number
+ and types of the function’s arguments and return values. It is
+ an error to supply <codeph>#next</codeph> in the parameter list,
+ and there is no implicit <codeph>#next</codeph> parameter.</p>
</apiDesc>
+
+ <section>
+ <title>Operations</title>
+
+ <p>The following functions return the same values as they would
+ if the function had been defined as a bare method with the same
+ signature:</p>
+
+ <ul>
+ <li><apioperation href="function_specializers.xml">function-specializers</apioperation></li>
+ <li><apioperation href="function_arguments.xml">function-arguments</apioperation></li>
+ <li><apioperation href="function_return_values.xml">function-return-values</apioperation></li>
+ </ul>
+
+ <p>Calling some of the following reflective operations on a
+ function defined with <codeph>define function</codeph> may be an
+ error:</p>
+
+ <ul>
+ <li><apioperation href="generic_function_methods.xml">generic-function-methods</apioperation></li>
+ <li><apioperation href="add_method.xml">add-method</apioperation></li>
+ <li><apioperation href="generic_function_mandatory_keywords.xml">generic-function-mandatory-keywords</apioperation></li>
+ <li><apioperation href="sorted_applicable_methods.xml">sorted-applicable-methods</apioperation></li>
+ <li><apioperation href="find_method.xml">find-method</apioperation></li>
+ <li><apioperation href="remove_method.xml">remove-method</apioperation></li>
+ <li><apioperation href="applicable_methodQ.xml">applicable-method?</apioperation></li>
+ </ul>
+ </section>
</dylanMacroDetail>
</dylanMacro>
Modified: trunk/documentation/topic/reference/lib/dylan/dylan/object_hash.xml
==============================================================================
--- trunk/documentation/topic/reference/lib/dylan/dylan/object_hash.xml (original)
+++ trunk/documentation/topic/reference/lib/dylan/dylan/object_hash.xml Sun May 11 07:15:48 2008
@@ -2,7 +2,9 @@
<!DOCTYPE dylanGenericFunction PUBLIC "-//Gwydion//DTD DITA Dylan API Generic Function//EN" "../../../../dtd/dylanGenericFunction.dtd" []>
<dylanGenericFunction id="lib-dylan-dylan-object_hash">
<apiName>object-hash</apiName>
- <shortdesc>Returns .</shortdesc>
+
+ <shortdesc>Returns a hash code corresponding to the equivalence
+ predicate <apiname>==</apiname>.</shortdesc>
<prolog>
<author></author>
@@ -37,7 +39,17 @@
</dylanGenericFunctionDef>
<apiDesc>
- <p></p>
+ <p>Returns a hash code for <parmname>object</parmname> that
+ corresponds to the equivalence predicate <apioperation
+ href="EE.xml">==</apioperation>.</p>
+
+ <p>This function can be called from hash functions in which the
+ object identity of some component of a key is to be used in
+ computing the hash code. </p>
+
+ <p>It returns a hash ID (an integer) and the result of merging
+ the initial state with the associated hash state for the object,
+ computed in an implementation-dependent manner. </p>
</apiDesc>
</dylanGenericFunctionDetail>
</dylanGenericFunction>
Modified: trunk/documentation/topic/reference/lib/dylan/dylan/table_protocol.xml
==============================================================================
--- trunk/documentation/topic/reference/lib/dylan/dylan/table_protocol.xml (original)
+++ trunk/documentation/topic/reference/lib/dylan/dylan/table_protocol.xml Sun May 11 07:15:48 2008
@@ -2,7 +2,9 @@
<!DOCTYPE dylanGenericFunction PUBLIC "-//Gwydion//DTD DITA Dylan API Generic Function//EN" "../../../../dtd/dylanGenericFunction.dtd" []>
<dylanGenericFunction id="lib-dylan-dylan-table_protocol">
<apiName>table-protocol</apiName>
- <shortdesc>Returns .</shortdesc>
+
+ <shortdesc>Returns functions used to implement the iteration
+ protocol for tables.</shortdesc>
<prolog>
<author></author>
@@ -16,7 +18,7 @@
<dylanGenericFunctionDef>
<dylanGenericFunctionSealing value='open'/>
<dylanFunctionParam>
- <apiItemName>t</apiItemName>
+ <apiItemName>table</apiItemName>
<apiOperationClassifier href="LtableG.xml"><table></apiOperationClassifier>
<apiDefNote></apiDefNote>
</dylanFunctionParam>
@@ -33,7 +35,41 @@
</dylanGenericFunctionDef>
<apiDesc>
- <p></p>
+ <p>Returns the functions used to iterate over tables. These
+ functions are in turn used to implement the other collection
+ operations on <apiclassifier
+ href="lTableG.xml"><table></apiclassifier>.</p>
+
+ <p>The <parmname>test-function</parmname> argument is for the
+ table test function, which is used to compare table keys. It
+ returns true if, according to the table’s equivalence predicate,
+ the keys are members of the same equivalence class. Its
+ signature must be:</p>
+
+
+ <codeblock>test-function <parmname>key1</parmname> <parmname>key2</parmname> => <parmname>boolean</parmname></codeblock>
+
+ <p>The <parmname>hash-function</parmname> argument is for the table hash
+ function, which computes the hash code of a key. Its signature
+ must be:</p>
+
+ <codeblock>hash-function <parmname>key</parmname> <parmname>initial-state</parmname> => <parmname>id</parmname> <parmname>result-state</parmname></codeblock>
+
+ <p>In this signature, <parmname>initial-state</parmname> is an
+ instance of <apiclassifier
+ href="../../collections/table-extensions/Lhash_stateG.xml"><hash-state></apiclassifier>. The
+ hash function computes the hash code of
+ <parmname>key</parmname>, using the hash function that is
+ associated with the table’s equivalence predicate. The hash code
+ is returned as two values: an integer <parmname>id</parmname>
+ and a hash-state <parmname>result-state</parmname>. This
+ <parmname>result-state</parmname> is obtained by merging the
+ <parmname>initial-state</parmname> with the hash-state that
+ results from hashing <parmname>key</parmname>. The
+ <parmname>result-state</parmname> may or may not be == to
+ <parmname>initial-state</parmname>. The
+ <parmname>initial-state</parmname> could be modified by this
+ operation. </p>
</apiDesc>
</dylanGenericFunctionDetail>
</dylanGenericFunction>
More information about the chatter
mailing list