remove

Remove dictionary entries

Since R2023b

Syntax

d2 = remove(d1,key)

Description

d2 = remove(d1,key) removes the entry corresponding to key from dictionary, d1.

d = remove(d,key) is equivalent to d(key) = [ ].

Examples

Remove Dictionary Entry

Create a dictionary containing several key-value pairs.

names = ["Unicycle" "Bicycle" "Tricycle"];
wheels = [1 2 3];
d = dictionary(wheels,names)

d =

  dictionary (double ⟼ string) with 3 entries:

    1 ⟼ "Unicycle"
    2 ⟼ "Bicycle"
    3 ⟼ "Tricycle"

Remove the entry corresponding to 2.

d = remove(d,2)

d =

  dictionary (double ⟼ string) with 2 entries:

    1 ⟼ "Unicycle"
    3 ⟼ "Tricycle"

Remove Multiple Entries

Create a dictionary containing several key-value pairs.

names = ["Unicycle" "Bicycle" "Tricycle"];
wheels = [1 2 3];
d = dictionary(wheels,names)

d =

  dictionary (double ⟼ string) with 3 entries:

    1 ⟼ "Unicycle"
    2 ⟼ "Bicycle"
    3 ⟼ "Tricycle"

Remove the entries corresponding to [2,3].

d = remove(d,[2,3])

d =

  dictionary (double ⟼ string) with 1 entry:

    1 ⟼ "Unicycle"

Input Arguments

d1 — Input dictionary

dictionary object

Input dictionary, specified as a dictionary object.

key — Key set

array

Key set, specified as an array. The data type of key must match or be convertible to the data type of keys in d1.

Extended Capabilities

C/C++ Code Generation
Generate C and C++ code using MATLAB® Coder™.

Version History

Introduced in R2023b

R2024b: Code generation support

You can generate C/C++ code for the dictionary remove function.