Map and Set

Jusqu’à présent, nous avons découvert les structures de données complexes suivantes :

• Les objets sont utilisés pour stocker des collections de clés.
• Les tableaux sont utilisés pour stocker des collections ordonnées.

Map

Une Map (dictionnaire de donnée) permet, comme pour un Object, de stocker plusieurs éléments sous la forme de clés valeurs. Sauf que cette fois, les clés peuvent être de n’importe qu’elle type.

Voici les méthodes et les propriétés d’une Map :

• new Map() – crée la map.
• map.set(key, value) – stocke la valeur par la clé.
• map.get(key) – renvoie la valeur par la clé, undefined si key n’existe pas dans la carte.
• map.has(key) – renvoie true si la key existe, false sinon.
• map.delete(key) – supprime la valeur par la clé.
• map.clear() – supprime tout de la map.
• map.size – renvoie le nombre actuel d’éléments.

Par exemple :

let map = new Map();

map.set('1', 'str1');   // une clé de type chaîne de caractère
map.set(1, 'num1');     // une clé de type numérique
map.set(true, 'bool1'); // une clé de type booléenne

// souvenez-vous, dans un `Object`, les clés sont converties en chaîne de caractères
// alors que `Map` conserve le type d'origine de la clé,
// c'est pourquoi les deux appels suivants retournent des valeurs différentes:

alert( map.get(1)   ); // 'num1'
alert( map.get('1') ); // 'str1'

alert( map.size ); // 3

Au travers de cet exemple nous pouvons voir, qu’à la différence des Objects, les clés ne sont pas converties en chaîne de caractère. Il est donc possible d’utiliser n’importe quel type.

Map peut également utiliser des objets comme clés.

Par exemple:

let john = { name: "John" };

// pour chaque utilisateur, nous stockons le nombre de visites
let visitsCountMap = new Map();

// john est utilisé comme clé dans la map
visitsCountMap.set(john, 123);

alert( visitsCountMap.get(john) ); // 123

Utiliser des objets comme clés est l’une des fonctionnalités les plus notables et les plus importantes de Map. La même chose ne compte pas pour Object. Une chaîne de caractères comme clé dans Object est très bien, mais nous ne pouvons pas utiliser un autre Object comme clé dans Object.

Essayons de faire comme l’exemple précédent directement avec un Object:

let john = { name: "John" };
let ben = { name: "Ben" };

let visitsCountObj = {}; // on créé notre object

visitsCountObj[ben] = 234; // essayez d'utiliser l'objet ben comme clé
visitsCountObj[john] = 123; // essayez d'utiliser l'objet john comme clé, l'objet ben sera remplacé

// C'est ce qui a été écrit!
alert( visitsCountObj["[object Object]"] ); // 123

Comme visitesCountObj est un objet, il convertit toutes les clés Object, telles que john et ben ci-dessus, en la même chaîne de caractères "[object Object]". Certainement pas ce que nous voulons.

map.set('1', 'str1')
  .set(1, 'num1')
  .set(true, 'bool1');

Parcourir les éléments d’une Map

Il existe 3 façons de parcourir les éléments d’une map :

• map.keys() – renvoie un itérable pour les clés,
• map.values() – renvoie un itérable pour les valeurs,
• map.entries() – renvoie un itérable pour les entrées [key, value], il est utilisé par défaut dans for..of.

Par exemple :

let recipeMap = new Map([
  ['cucumber', 500],
  ['tomatoes', 350],
  ['onion',    50]
]);

// on parcourt les clés (les légumes)
for (let vegetable of recipeMap.keys()) {
  alert(vegetable); // cucumber, tomatoes, onion
}

// on parcourt les valeurs (les montants)
for (let amount of recipeMap.values()) {
  alert(amount); // 500, 350, 50
}

// on parcourt les entries (couple [clé, valeur])
for (let entry of recipeMap) { // équivalent à : recipeMap.entries()
  alert(entry); // cucumber,500 (etc...)
}

Il est aussi possible d’utiliser forEach avec Map comme on pourrait le faire avec un tableau :

// exécute la fonction pour chaque couple (key, value)
recipeMap.forEach( (value, key, map) => {
  alert(`${key}: ${value}`); // cucumber: 500 etc
});

Object.entries: Map from Object

When a Map is created, we can pass an array (or another iterable) with key/value pairs for initialization, like this:

// array of [key, value] pairs
let map = new Map([
  ['1',  'str1'],
  [1,    'num1'],
  [true, 'bool1']
]);

alert( map.get('1') ); // str1

If we have a plain object, and we’d like to create a Map from it, then we can use built-in method Object.entries(obj) that returns an array of key/value pairs for an object exactly in that format.

So we can create a map from an object like this:

let obj = {
  name: "John",
  age: 30
};

let map = new Map(Object.entries(obj));

alert( map.get('name') ); // John

Here, Object.entries returns the array of key/value pairs: [ ["name","John"], ["age", 30] ]. That’s what Map needs.

Object.fromEntries: Object from Map

We’ve just seen how to create Map from a plain object with Object.entries(obj).

There’s Object.fromEntries method that does the reverse: given an array of [key, value] pairs, it creates an object from them:

let prices = Object.fromEntries([
  ['banana', 1],
  ['orange', 2],
  ['meat', 4]
]);

// now prices = { banana: 1, orange: 2, meat: 4 }

alert(prices.orange); // 2

We can use Object.fromEntries to get a plain object from Map.

E.g. we store the data in a Map, but we need to pass it to a 3rd-party code that expects a plain object.

Here we go:

let map = new Map();
map.set('banana', 1);
map.set('orange', 2);
map.set('meat', 4);

let obj = Object.fromEntries(map.entries()); // make a plain object (*)

// done!
// obj = { banana: 1, orange: 2, meat: 4 }

alert(obj.orange); // 2

A call to map.entries() returns an iterable of key/value pairs, exactly in the right format for Object.fromEntries.

We could also make line (*) shorter:

let obj = Object.fromEntries(map); // omit .entries()

That’s the same, because Object.fromEntries expects an iterable object as the argument. Not necessarily an array. And the standard iteration for map returns same key/value pairs as map.entries(). So we get a plain object with same key/values as the map.

Set

Set est une liste sans doublons.

Ses principales méthodes sont :

• new Set(iterable) – crée le set et si un objet iterable est fourni (généralement un tableau), copie les valeurs de celui-ci dans le set.
• set.add(value) – ajoute une valeur, renvoie le set lui-même.
• set.delete(value) – supprime la valeur, renvoie true si value existait au moment de l’appel, sinon false.
• set.has(value) – renvoie true si la valeur existe dans l’ensemble, sinon false.
• set.clear() – supprime tout du set.
• set.size – est le nombre d’éléments.

Ce qu’il faut surtout savoir c’est que lorsque l’on appelle plusieurs fois set.add(value) avec la même valeur, la méthode ne fait rien. C’est pourquoi chaque valeur est unique dans un Set.

Par exemple, nous souhaitons nous souvenir de tous nos visiteurs. Mais chaque visiteurs doit être unique.

Set est exactement ce qu’il nous faut :

let set = new Set();

let john = { name: "John" };
let pete = { name: "Pete" };
let mary = { name: "Mary" };

// visites, certains utilisateurs viennent plusieurs fois
set.add(john);
set.add(pete);
set.add(mary);
set.add(john);
set.add(mary);

// set conserve une fois chaque visiteurs
alert( set.size ); // 3

for (let user of set) {
  alert(user.name); // John (puis Pete et Mary)
}

Nous aurions aussi pu utiliser un tableau (Array) en vérifiant avant chaque insertion que l’élément n’existe pas en utilisant arr.find. Cependant les performances auraient été moins bonnes car cette méthode parcours chaque élément du tableau. Set est beaucoup plus efficace car il est optimisé en interne pour vérifier l’unicité des valeurs.

Parcourir un Set

Nous pouvons parcourir les éléments d’un Set avec for..of ou en utilisant forEach

let set = new Set(["oranges", "apples", "bananas"]);

for (let value of set) alert(value);

// même chose en utilisant forEach:
set.forEach((value, valueAgain, set) => {
  alert(value);
});

A noter que la fonction de callback utilisée par forEach prend 3 arguments en paramètres: une value, puis la même valeur valueAgain, et enfin le set lui-même.

C’est pour la compatibilité avec Map où le callback forEach passé possède trois arguments. Ça a l’air un peu étrange, c’est sûr. Mais cela peut aider à remplacer facilement Map par Set dans certains cas, et vice versa.

Les méthodes pour parcourir les éléments d’une Map peuvent être utilisées :

• set.keys() – renvoie un objet itérable pour les valeurs,
• set.values() – identique à set.keys(), pour compatibilité avec Map,
• set.entries() – renvoie un objet itérable pour les entrées [value, value], existe pour la compatibilité avec Map.

Summary

Map – est une collection de clé valeurs.

Méthodes et propriétés:

• new Map([iterable]) – crée la map, avec un iterable facultatif (par exemple un tableau) de paires [key,value] pour l’initialisation.
• map.set(key, value) – stocke la valeur par la clé, renvoie la map elle-même.
• map.get(key) – renvoie la valeur par la clé, undefined si key n’existe pas dans la map.
• map.has(key) – renvoie true si la key existe, false sinon.
• map.delete(key) – supprime la valeur par la clé, retourne true si key existait au moment de l’appel, sinon false.
• map.clear() – supprime tout de la map.
• map.size – renvoie le nombre actuel d’éléments.

La différence entre Map avec un objet traditionel :

• N’importe quel type peut être utilisé comme clé
• Accès à des méthodes tels que size.

Set – est une collection de valeurs uniques

Méthodes et propriétés :

• new Set([iterable]) – crée le set avec un iterable facultatif (par exemple un tableau) de valeurs pour l’initialisation.
• set.add(value) – ajoute une valeur (ne fait rien si value existe), renvoie le set lui-même.
• set.delete(value) – supprime la valeur, renvoie true si value existait au moment de l’appel, sinon false.
• set.has(value) – renvoie true si la valeur existe dans le set sinon false.
• set.clear() – supprime tout du set.
• set.size – est le nombre d’éléments.

On ne peut pas dire que les éléments dans une Map ou un Set sont désordonnés car ils sont toujours parcourut par ordre d’insertion. Il est cependant impossible de réorganiser les éléments ou bien de les retrouver par leur index.