dict_del

Abstract

Remove a key:value pair from a hashtable

Description

A hashtable is a mapping from a key to a value. The dict_ family of opcodes implement a hashtable mapping either strings or integers to strings or floats. dict_del removes a key:value pair from the hashtable. If both dict and key are i- variables, dict_del executes only at i-time. Otherwise it executes at every k- cycle. Use an if guard to prevent this, if so needed. To delete a key at the end of an event, use defer

Syntax

dict_del idict, ikey      ; execution at i- time
dict_del idict, kkey      ; execution at k- time
dict_del idict, Skey      ; execution at k- time

Arguments

idict: the handle of the dict, as returned by dict_new
ikey / kkey / Skey: the key to remove

Execution Time

Init
Performance

Example

<CsoundSynthesizer>
<CsOptions>
; -odac  -iadc    ;;;RT audio out and in

</CsOptions>
<CsInstruments>

sr = 44100
ksmps = 32
nchnls = 2

instr 1
  ; create a local dict, mapping strings to numbers
  idict dict_new "sf"
  dict_free idict

  ; set key a key:value pair
  dict_set idict, "bar", 123

  dict_print idict

  dict_del idict, "bar"

  dict_print idict

  turnoff
endin


</CsInstruments>
<CsScore>

i 1 0 2

</CsScore>
</CsoundSynthesizer>

Credits

Eduardo Moguillansky, 2019 Last update: 2021