JavaScript Map class

Java like Map class for JavaScript, a wrapper arround JavaScript’s native key value hash tree storage inside objects.

If you are familiar with Java Map this shouldn’t be news to you. The idea is this: enable the key value storage with some additional functionality, speed up iteration, and harvest the speed of native hash table key value storage.
When I say speed up iteration, I really mean it would be really neat to have getFirst and getLast property of an object, or a way to quickly get the list of the keys, or to know the number of properties at any time. To do that we need to keep an always updated array of keys, an object to hold keys and values and a length property that has the same value as the length of the array that holds keys. Keys are suposed to be small so holding a list of them wouldnt take up much of memory, but making a reverse map, that is reversely mapping keys by values would make a lot of confusion.
We have to remember that objects have unordered properties so the order of the properties will be defined in the array that keeps keys (property names), cause it is an ordered data structure.

The concept usage should be something like this:

var map = new Map();
var map1 = new Map({a:1, b:2});

alert(map.length); //0
alert(map1.length); //2

map.put(‘foo’: 1);
alert(map.length); //1
alert(map.keys()); //[‘foo’];
alert(map1.keys());//[‘a’,’b’];
map1.remove(‘a’);
alert(map1.get(‘b’)); //2
alert(map1.keys());//[‘b’];
map1.incorporate({c:3,d:4,e:5});
alert(map1.keys()); //[‘b’,’c’,’d’,’e’];
alert(map1.lenght); //4
alert(map1.getFirst()); // 2
alert(map1.getLast()); // 5
map1.put(‘b’,15)
alert(map1.getById(0)); // 15
alert(map.equals(map1)); //false
map1.clear();
map1.put(‘foo’:1);
alert(map.equals(map1)); //true

The following code enables the above described functiality. Helper functions are described in prevous posts, so for their complete understanding please refer to the older posts. Note that put and remove time is obviously slower than a regular native hash table just because of updating the array of keys.

* There was a bug in remove, made due to refactoring without thinking to much, that caused Map to get empty. It is fixed now.

/**
* @file IVARTECH Map data class
* @author Nikola Stamatovic Stamat <stamat@ivartech.com>
* @copyright IVARTECH http://ivartech.com
* @version 20130313
*
* @namespace ivar.data
*/
/**
* @class
* @classdesc Map class similar to Java Map, providing methods for efficient usage of traditional key-value hash table storage
*
* @constructor
* @property {number} length Length of the map, like array length. Even though keys.length would do fine, this is kept for elegance
* @property {object} object Object that contains key-value pairs
* @property {array} keys Array containing key names used as keys in object to enable getFirst and getLast functionality
*/
var Map = function Map(o) {
this.length = 0;
var object = {};
var keys = [];
this.incorporate = function(obj) {
var new_keys = [];
for(var i in obj) {
if(!this.hasKey(i))
new_keys.push(i);
object[i] = obj[i];
}
for(var i = 0; i < new_keys.length; i++) {
keys.push(new_keys[i]);
}
this.length = keys.length;
};
/**
* Stores key and value to map object
*
* @this {Map}
* @param {string|number} key A value that represents key for value retrieval
* @param {any} value A value marked with the correspondent key
* @return {string|number} Returns the key value
*/
this.put = function(key, value) {
var o = {};
o[key] = value;
this.incorporate(o);
return key;
};
/**
* Clones another map's values to this map
*
* @this {Map}
* @param {Map} map Map to which values should be cloned
*/
this.putAll = function(map) {
this.length = map.length;
object = map.entrySet();
keys = map.keys();
};
/**
* Removes the map entry by given key
*
* @this {Map}
* @param {string|number} key Name of the key under which a value is stored
* @return {any|array} Returns the value of removed entry, or array of values
*/
this.remove = function(k) {
var res = [];
if (ivar.whatis(k) !== 'array') {
k = [k];
}
for (var i = 0; i < k.length; i++) {
res.push(this._remove(k[i]));
}
if (res.length > 1) {
return res;
} else {
return res[0];
}
}
this._remove = function(key) {
var value;
if(this.hasKey(key)) {
this._removeKeyFromArray(key);
this.length = keys.length;
value = object[key];
delete object[key];
}
return value;
};
this._removeKeyFromArray = function(key) {
var id = 1;
for(var i = 0; i < keys.length; i++) {
if(keys[i] === key) {
id = i;
break;
}
}
if(id > 1)
keys.splice(id, 1);
};
/**
* Gets the value stored under given key
*
* @this {Map}
* @param {string|number} key A value that represents key for value retrieval
* @return {any} Returns the value stored under the key or undefined if key isnt found
*/
this.get = function(key) {
return object[key];
};
/**
* Gets the value stored under given order number
*
* @this {Map}
* @param {number} id Order number in keys array
* @return {any} Returns the value stored under the key or null if key isnt found
*/
this.getById = function(id) {
return this.get(keys[id]);
};
/**
* Gets the value stored under the last entered key
*
* @this {Map}
* @return {any} Returns the value stored under the key or null if key isn't found
*/
this.getLast = function() {
return this.getById(keys.length1);
};
/**
* Gets the value stored under the first entered key
*
* @this {Map}
* @return {any} Returns the value stored under the key or null if key isn't found
*/
this.getFirst = function() {
return this.getById(0);
};
/**
* Gets a key name labeling the given value
*
* @this {Map}
* @param {any} value Value used to find the keyname
* @return {string|number} Returns key name under which given value is stored
*/
this.getKey = function(value) {
return this.find(value); //SLOW
};
/**
* Gets this map's object containing keys and values
*
* @this {Map}
* @return {object} object containing keys and values
*/
this.entrySet = function() {
return object;
};
/**
* Checks if the map is empty
*
* @this {Map}
* @return {boolean} returns true if Map is empty, otherwise false.
*/
this.isEmpty = function() {
return this.length === 0 ? true : false;
};
/**
* Does the map contain given key?
*
* @this {Map}
* @param {string|number} key
* @return {boolean} returns true if the given key exists in the map
*/
this.hasKey = function(key) {
return object.hasOwnProperty(key);
};
/**
* Does the map contain given value?
*
* @this {Map}
* @param {any} value
* @return {boolean} returns true if the given value exists in the map
*/
this.hasValue = function(value) { //SLOW O(n)
return this.getKey(value) ? true : false;
};
/**
* Returns list of all entry keys in the map
*
* @this {Map}
* @return {array} returns array of keys
*/
this.keys = function() {
return keys;
};
/**
* Returns list of all entry values in the map. SLOW! O(n)
*
* @this {Map}
* @return {array} returns array of values
*/
this.values = function() { //SLOW O(n)
var res = [];
for (var i in object) {
res.push(object[i]);
}
return res;
};
/**
* Checks if an other map is identical to this one!
* Can be very slow if they have same keys and number of entries.
*
* @this {Map}
* @param {Map} map
* @return {boolean} returns true if they are identical
*/
this.equals = function(map) {
if (this.length != map.length)
return false;
return equal(object, map.entrySet()); //SLOW
};
/**
* Resets the contents of the map to empty state
*
* @this {Map}
*/
this.clear = function() {
this.length = 0;
object = {};
keys = [];
};
/**
* For each entry of the map executes the given function
*
* @this {Map}
* @param {function} function(key,value) Given functions that receives key and value as arguments
*/
this.each = function(fn) {
for (var i in object) {
fn(i, object[i]);
}
};
/**
* Gets key name that holds supplied value
*
* @this {Map}
* @param {any} value Given value as a search parameter
*/
this.find = function(value) {
for (var i in object) {
if(value === object[i])
return i;
}
};
if(o) this.incorporate(o);
};
// ======== HELPERS
//Returns the object's class, Array, Date, RegExp, Object are of interest to us
var getClass = function(val) {
return Object.prototype.toString.call(val)
.match(/^\[object\s(.*)\]$/)[1];
};
//Defines the type of the value, extended typeof
var whatis = function(val) {
if (val === undefined)
return 'undefined';
if (val === null)
return 'null';
var type = typeof val;
if (type === 'object')
type = getClass(val).toLowerCase();
if (type === 'number') {
if (val.toString().indexOf('.') > 0)
return 'float';
else
return 'integer';
}
return type;
};
var compareObjects = function(a, b) {
if (a === b)
return true;
for (var i in a) {
if (b.hasOwnProperty(i)) {
if (!equal(a[i],b[i])) return false;
} else {
return false;
}
}
for (var i in b) {
if (!a.hasOwnProperty(i)) {
return false;
}
}
return true;
};
var compareArrays = function(a, b) {
if (a === b)
return true;
if (a.length !== b.length)
return false;
for (var i = 0; i < a.length; i++){
if(!equal(a[i], b[i])) return false;
};
return true;
};
var _equal = {};
_equal.array = compareArrays;
_equal.object = compareObjects;
_equal.date = function(a, b) {
return a.getTime() === b.getTime();
};
_equal.regexp = function(a, b) {
return a.toString() === b.toString();
};
// uncoment to support function as string compare
// _equal.fucntion = _equal.regexp;
/*
* Are two values equal, deep compare for objects and arrays.
* @param a {any}
* @param b {any}
* @return {boolean} Are equal?
*/
var equal = function(a, b) {
if (a !== b) {
var atype = whatis(a), btype = whatis(b);
if (atype === btype)
return _equal.hasOwnProperty(atype) ? _equal[atype](a, b) : a==b;
return false;
}
return true;
};
// ====== HELPERS END

view raw
Map.js
hosted with ❤ by GitHub

I really hope you found this solution useful, if nothing, just as a simple lesson of map data structure. If you spot any bugs, or space for improvement, please comment below. The sole iteration of this data structure is left to Iterator class, that will be described in some future post.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s

%d bloggers like this: