summaryrefslogtreecommitdiff
path: root/js/util/memoize.js
blob: 796c060e379fbcb84f9c5556032bb43613f25604 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
/*
 * Helper function for memoization
 *
 * The passed labeller function must generate unique and exact names for entries that are naturally equal.
 * IDs are persistent.
 *
 * names, idByName, and entries are accessible fields from the memoizer.
 * Behaviour on external modification of these fields is undefined.
 *
 * An entry object passed to the memoizer has its field "id" set to the memoized id by default.
 * The name of the ID field can be modified by calling the getter/setter idField() from the memoizer.
 * Behaviour on changing the ID field used while the memoizer has already performed memoization is undefined.
 */
function memoize(labeller) {
  var idField = "id";
  var names = [];
  var idByName = {};
  var entries = [];
  var _memoizer = function(entry) {
    var name = labeller(entry);
    if (name in idByName) {
        /* We already have a suitable entry. */
        var id = idByName[name];
        return entries[id];
    }
    /* New entry. */
    /* Set the entry's ID. */
    entry[idField] = entries.length;
    /* Index the new entry. */
    idByName[name] = entry[idField];
    names[entry[idField]] = name;
    entries.push(entry);

    return entry;
  }
  _memoizer.names = function() { return names; };
  _memoizer.idByName = function() { return idByName; };
  _memoizer.entries = function() { return entries; };
  _memoizer.idField = function(x) {
    if (!arguments.length) return idField;
    idField = x;
    return _memoizer;
  };
  return _memoizer;
}