steve
/
factor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

More doc fixes

db4
Slava Pestov 2008-03-29 23:48:06 -05:00
parent f9779f5c38
commit 8eb55b4c59
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
core/kernel/kernel-docs.factor
View File

@ -295,12 +295,12 @@ HELP: hashcode*
{ $values { "depth" integer } { "obj" object } { "code" fixnum } } { $values { "depth" integer } { "obj" object } { "code" fixnum } }
{ $contract "Outputs the hashcode of an object. The hashcode operation must satisfy the following properties:" { $contract "Outputs the hashcode of an object. The hashcode operation must satisfy the following properties:"
{ $list { $list
{ "if two objects are equal under " { $link = } ", they must have equal hashcodes" } { "If two objects are equal under " { $link = } ", they must have equal hashcodes." }
{ "if the hashcode of an object depends on the values of its slots, the hashcode of the slots must be computed recursively by calling " { $link hashcode* } " with a " { $snippet "level" } " parameter decremented by one. This avoids excessive work while still computing well-distributed hashcodes. The " { $link recursive-hashcode } " combinator can help with implementing this logic" } { "If the hashcode of an object depends on the values of its slots, the hashcode of the slots must be computed recursively by calling " { $link hashcode* } " with a " { $snippet "level" } " parameter decremented by one. This avoids excessive work while still computing well-distributed hashcodes. The " { $link recursive-hashcode } " combinator can help with implementing this logic," }
{ "the hashcode should be a " { $link fixnum } ", however returning a " { $link bignum } " will not cause any problems other than potential performance degradation." { "The hashcode should be a " { $link fixnum } ", however returning a " { $link bignum } " will not cause any problems other than potential performance degradation." }
"the hashcode is only permitted to change between two invocations if the object was mutated in some way" } { "The hashcode is only permitted to change between two invocations if the object or one of its slot values was mutated." }
} }
"If mutable objects are used as hashtable keys, they must not be mutated in such a way that their hashcode changes. Doing so will violate bucket sorting invariants and result in undefined behavior." } ; "If mutable objects are used as hashtable keys, they must not be mutated in such a way that their hashcode changes. Doing so will violate bucket sorting invariants and result in undefined behavior. See " { $link "hashtables.keys" } " for details." } ;
HELP: hashcode HELP: hashcode
{ $values { "obj" object } { "code" fixnum } } { $values { "obj" object } { "code" fixnum } }