array-set.js 2.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108
  1. /* -*- Mode: js; js-indent-level: 2; -*- */
  2. /*
  3. * Copyright 2011 Mozilla Foundation and contributors
  4. * Licensed under the New BSD license. See LICENSE or:
  5. * http://opensource.org/licenses/BSD-3-Clause
  6. */
  7. if (typeof define !== 'function') {
  8. var define = require('amdefine')(module, require);
  9. }
  10. define(function (require, exports, module) {
  11. var util = require('./util');
  12. /**
  13. * A data structure which is a combination of an array and a set. Adding a new
  14. * member is O(1), testing for membership is O(1), and finding the index of an
  15. * element is O(1). Removing elements from the set is not supported. Only
  16. * strings are supported for membership.
  17. */
  18. function ArraySet() {
  19. this._array = [];
  20. this._set = {};
  21. }
  22. /**
  23. * Static method for creating ArraySet instances from an existing array.
  24. */
  25. ArraySet.fromArray = function ArraySet_fromArray(aArray, aAllowDuplicates) {
  26. var set = new ArraySet();
  27. for (var i = 0, len = aArray.length; i < len; i++) {
  28. set.add(aArray[i], aAllowDuplicates);
  29. }
  30. return set;
  31. };
  32. /**
  33. * Return how many unique items are in this ArraySet. If duplicates have been
  34. * added, than those do not count towards the size.
  35. *
  36. * @returns Number
  37. */
  38. ArraySet.prototype.size = function ArraySet_size() {
  39. return Object.getOwnPropertyNames(this._set).length;
  40. };
  41. /**
  42. * Add the given string to this set.
  43. *
  44. * @param String aStr
  45. */
  46. ArraySet.prototype.add = function ArraySet_add(aStr, aAllowDuplicates) {
  47. var isDuplicate = this.has(aStr);
  48. var idx = this._array.length;
  49. if (!isDuplicate || aAllowDuplicates) {
  50. this._array.push(aStr);
  51. }
  52. if (!isDuplicate) {
  53. this._set[util.toSetString(aStr)] = idx;
  54. }
  55. };
  56. /**
  57. * Is the given string a member of this set?
  58. *
  59. * @param String aStr
  60. */
  61. ArraySet.prototype.has = function ArraySet_has(aStr) {
  62. return Object.prototype.hasOwnProperty.call(this._set,
  63. util.toSetString(aStr));
  64. };
  65. /**
  66. * What is the index of the given string in the array?
  67. *
  68. * @param String aStr
  69. */
  70. ArraySet.prototype.indexOf = function ArraySet_indexOf(aStr) {
  71. if (this.has(aStr)) {
  72. return this._set[util.toSetString(aStr)];
  73. }
  74. throw new Error('"' + aStr + '" is not in the set.');
  75. };
  76. /**
  77. * What is the element at the given index?
  78. *
  79. * @param Number aIdx
  80. */
  81. ArraySet.prototype.at = function ArraySet_at(aIdx) {
  82. if (aIdx >= 0 && aIdx < this._array.length) {
  83. return this._array[aIdx];
  84. }
  85. throw new Error('No element indexed by ' + aIdx);
  86. };
  87. /**
  88. * Returns the array representation of this set (which has the proper indices
  89. * indicated by indexOf). Note that this is a copy of the internal array used
  90. * for storing the members so that no one can mess with internal state.
  91. */
  92. ArraySet.prototype.toArray = function ArraySet_toArray() {
  93. return this._array.slice();
  94. };
  95. exports.ArraySet = ArraySet;
  96. });