Namespace goog.array

Inserts a value into a sorted array. The array is not modified if the value is already present.

Removes a value from a sorted array.

Searches the specified array for the specified target using the binary search algorithm. If no opt_compareFn is specified, elements are compared using goog.array.defaultCompare, which compares the elements using the built in < and > operators. This will produce the expected behavior for homogeneous arrays of String(s) and Number(s). The array specified must be sorted in ascending order (as defined by the comparison function). If the array is not sorted, results are undefined. If the array contains multiple instances of the specified target value, any of these instances may be found. Runtime: O(log n)

Selects an index in the specified array using the binary search algorithm. The evaluator receives an element and determines whether the desired index is before, at, or after it. The evaluator must be consistent (formally, goog.array.map(goog.array.map(arr, evaluator, opt_obj), goog.math.sign) must be monotonically non-increasing). Runtime: O(log n)

Splits an array into disjoint buckets according to a splitting function.

Clears the array.

Does a shallow copy of an array.

3-way array compare function.

Returns a new array that is the result of joining the arguments. If arrays are passed then their items are added, however, if non-arrays are passed they will be added to the return array as is. Note that ArrayLike objects will be added as is, rather than having their items added. goog.array.concat([1, 2], [3, 4]) -> [1, 2, 3, 4] goog.array.concat(0, [1, 2]) -> [0, 1, 2] goog.array.concat([1, 2], null) -> [1, 2, null] There is bug in all current versions of IE (6, 7 and 8) where arrays created in an iframe become corrupted soon (not immediately) after the iframe is destroyed. This is common if loading data via goog.net.IframeIo, for example. This corruption only affects the concat method which will start throwing Catastrophic Errors (#-2147418113). See http://endoflow.com/scratch/corrupted-arrays.html for a test case. Internally goog.array should use this, so that all methods will continue to work on these broken array objects.

Whether the array contains the given object.

Counts the array elements that fulfill the predicate, i.e. for which the callback function returns true. Skips holes in the array.

Compares its two arguments for order, using the built in < and > operators.

Compares its two arguments for equality, using the built in === operator.

Compares two arrays for equality. Two arrays are considered equal if they have the same length and their corresponding elements are equal according to the comparison function.

Call f for each element of an array. If all calls return true, every() returns true. If any call returns false, every() returns false and does not continue to check the remaining elements. See http://tinyurl.com/developer-mozilla-org-array-every

Extends an array with another array, element, or "array like" object. This function operates 'in-place', it does not create a new Array. Example: var a = []; goog.array.extend(a, [0, 1]); a; // [0, 1] goog.array.extend(a, 2); a; // [0, 1, 2]

Calls a function for each element in an array, and if the function returns true adds the element to a new array. See http://tinyurl.com/developer-mozilla-org-array-filter

Search an array for the first element that satisfies a given condition and return that element.

Search an array for the first element that satisfies a given condition and return its index.

Search an array (in reverse order) for the last element that satisfies a given condition and return its index.

Search an array (in reverse order) for the last element that satisfies a given condition and return that element.

Returns an array consisting of every argument with all arrays expanded in-place recursively.

Calls a function for each element in an array. Skips holes in the array. See http://tinyurl.com/developer-mozilla-org-array-foreach

Calls a function for each element in an array, starting from the last element rather than the first.

Returns the index of the first element of an array with a specified value, or -1 if the element is not present in the array. See http://tinyurl.com/developer-mozilla-org-array-indexof

Pushes an item into an array, if it's not already in the array.

Inserts at the given index of the array, all elements of another array.

Inserts an object at the given index of the array.

Inserts an object into an array before a specified object.

Whether the array is empty.

Tells if the array is sorted.

Returns the index of the last element of an array with a specified value, or -1 if the element is not present in the array. See http://tinyurl.com/developer-mozilla-org-array-lastindexof

Calls a function for each element in an array and inserts the result into a new array. See http://tinyurl.com/developer-mozilla-org-array-map

Returns the last element in an array without removing it.

Creates a range of numbers in an arithmetic progression. Range takes 1, 2, or 3 arguments:

 range(5) is the same as range(0, 5, 1) and produces [0, 1, 2, 3, 4]
 range(2, 5) is the same as range(2, 5, 1) and produces [2, 3, 4]
 range(-2, -5, -1) produces [-2, -3, -4]
 range(-2, -5, 1) produces [], since stepping by 1 wouldn't ever reach -5.
 

Passes every element of an array into a function and accumulates the result. See http://tinyurl.com/developer-mozilla-org-array-reduce For example: var a = [1, 2, 3, 4]; goog.array.reduce(a, function(r, v, i, arr) {return r + v;}, 0); returns 10

Passes every element of an array into a function and accumulates the result, starting from the last element and working towards the first. See http://tinyurl.com/developer-mozilla-org-array-reduceright For example: var a = ['a', 'b', 'c']; goog.array.reduceRight(a, function(r, v, i, arr) {return r + v;}, ''); returns 'cba'

Removes the first occurrence of a particular value from an array.

Removes from an array the element at index i

Removes all duplicates from an array (retaining only the first occurrence of each array element). This function modifies the array in place and doesn't change the order of the non-duplicate items. For objects, duplicates are identified as having the same unique ID as defined by goog.getUid. Runtime: N, Worstcase space: 2N (no dupes)

Removes the first value that satisfies the given condition.

Returns an array consisting of the given value repeated N times.

Rotates an array in-place. After calling this method, the element at index i will be the element previously at index (i - n) % array.length, for all values of i between 0 and array.length - 1, inclusive. For example, suppose list comprises [t, a, n, k, s]. After invoking rotate(array, 1) (or rotate(array, -4)), array will comprise [s, t, a, n, k].

Shuffles the values in the specified array using the Fisher-Yates in-place shuffle (also known as the Knuth Shuffle). By default, calls Math.random() and so resets the state of that random number generator. Similarly, may reset the state of the any other specified random number generator. Runtime: O(n)

Returns a new array from a segment of an array. This is a generic version of Array slice. This means that it might work on other objects similar to arrays, such as the arguments object.

Calls f for each element of an array. If any call returns true, some() returns true (without checking the remaining elements). If all calls return false, some() returns false. See http://tinyurl.com/developer-mozilla-org-array-some

Sorts the specified array into ascending order. If no opt_compareFn is specified, elements are compared using goog.array.defaultCompare, which compares the elements using the built in < and > operators. This will produce the expected behavior for homogeneous arrays of String(s) and Number(s), unlike the native sort, but will give unpredictable results for heterogenous lists of strings and numbers with different numbers of digits. This sort is not guaranteed to be stable. Runtime: Same as Array.prototype.sort

Sorts an array of objects by the specified object key and compare function. If no compare function is provided, the key values are compared in ascending order using goog.array.defaultCompare. This won't work for keys that get renamed by the compiler. So use {'foo': 1, 'bar': 2} rather than {foo: 1, bar: 2}.

Adds or removes elements from an array. This is a generic version of Array splice. This means that it might work on other objects similar to arrays, such as the arguments object.

Sorts the specified array into ascending order in a stable way. If no opt_compareFn is specified, elements are compared using goog.array.defaultCompare, which compares the elements using the built in < and > operators. This will produce the expected behavior for homogeneous arrays of String(s) and Number(s). Runtime: Same as Array.prototype.sort, plus an additional O(n) overhead of copying the array twice.

Converts an object to an array.

Creates a new object built from the provided array and the key-generation function.

Creates a new array for which the element at position i is an array of the ith element of the provided arrays. The returned array will only be as long as the shortest array provided; additional values are ignored. For example, the result of zipping [1, 2] and [3, 4, 5] is [[1,3], [2, 4]]. This is similar to the zip() function in Python. See http://docs.python.org/library/functions.html#zip