mirror/guile
mirror/guile
1
Fork 0
mirror of https://git.savannah.gnu.org/git/guile.git synced 2025-04-30 11:50:28 +02:00
Code Activity

Add weak hash table documentation

Browse source 
* doc/ref/api-memory.texi (Weak hash tables): Update documentation.
  Fixes #20551.
This commit is contained in:
Andy Wingo 2016-06-23 22:37:23 +02:00
parent 498cd58cb4
commit 8a072fc2d6
1 changed files with 10 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

12
doc/ref/api-memory.texi
View file

@ -309,10 +309,18 @@ Return a weak hash table with @var{size} buckets. As with any
hash table, choosing a good size for the table requires some
caution.
You can modify weak hash tables in exactly the same way you
would modify regular hash tables. (@pxref{Hash Tables})
You can modify weak hash tables in exactly the same way you would modify
regular hash tables, with the exception of the routines that act on
handles. Weak tables have a different implementation behind the scenes
that doesn't have handles. @pxref{Hash Tables}, for more on
@code{hashq-ref} et al.
@end deffn
Note that in a weak-key hash table, the reference to the value is
strong. This means that if the value references the key, even
indirectly, the key will never be collected, which can lead to a memory
leak. The reverse is true for weak value tables.
@deffn {Scheme Procedure} weak-key-hash-table? obj
@deffnx {Scheme Procedure} weak-value-hash-table? obj
@deffnx {Scheme Procedure} doubly-weak-hash-table? obj