clear: Removes all key-value pairs from a hash

In hash: Full Featured Implementation of Hash Tables/Associative Arrays/Dictionaries

Removes all key-value pairs from a hash

Description

clear removes all key-values from a hash.

Usage

   clear(x)

Arguments

x	A hash object.

Details

Currently clear removes (rm) the key-value pairs on the hash. For large hashes it might be faster to reinitialize the hash, though this might cause memory leaks.

Value

None. Method clear exists entirely for its side effects.

Note

clear should be called prior to removing a hash. This ensures that the memory from the environment is freed.

Author(s)

Christopher Brown

See Also

del to remove specific key-values from the hash. hash.

Examples

  h <- hash( letters, 1:26 )
  h # An object of type 'hash' containing 26 key-value pairs.
  clear(h)  
  h # An object of type 'hash' containing 0 key-value pairs.

hash documentation built on Aug. 20, 2023, 1:08 a.m.