Telogis.GeoBase.Arrays

Checks to see whether a given array contains a certain item.

• arr (Array) - The array to check for Arrays.contains.item in.

• item (Object) - The item to check for in Arrays.contains.arr.

Boolean - True if Arrays.contains.item is an entry in Arrays.contains.arr; false otherwise.

Finds the number of items in an array (or object) using hasOwnProperty(), such that in the case of sparse arrays, the actual number of elements in the array is returned.

• arr (Array) - The array to count the properties of.

Number - The number of non-prototyped properties of the array.

Finds the index of a certain item in an array.

• arr (Array) - The array to search.

• item (Object or Function) - The item to search for. Or, a boolean function that determines whether a passed item in the array is the desired one. When used as a function, this acts as a predicate to find the first index in the array that matches the item. If found, indexOf returns the index. If no match is found, returns -1.

Number - The index of Arrays.indexOf.item in Arrays.indexOf.arr, or -1 if no match was found.

Finds the intersection of multiple arrays.

• ... (Array) - A list of arrays to take the intersection of.

Array - An array / set containing only the elements found in each of the argument arrays.

Moves an entry of an array from a specified index to another. The supplied array instance is not modified in the call.

• arr (Array) - The array to move an item in.

• from (Number) - The original index of the item to move.

• to (Number) - The index to move the item to.

Array - The modified array.

Assuming the array is already sorted by Arrays.place.comparator, inserts a new item in the array at the appropriate location. If there are multiple appropriate locations, the first is used. The supplied instance of the array is not modified.

• arr (Array) - The sorted array to insert an item in.

• item (Object) - The item to insert into the sorted array.

• (Optional) comparator (Function) - The callback used to compare two entries in the array. Defaults to function (a, b) {return a - b;}.

  Arguments

  • a (Object) - The first item in the array to compare.

  • b (Object) - The second item in the array to compare.

  Returns

  Number - A negative number if Arrays.place.comparator.a occurs before Arrays.place.comparator.b in the sorted array, and a positive number if the converse is true. If Arrays.place.comparator.a and Arrays.place.comparator.b are equivalent, this should return 0.

Array - The modified array.

Finds the index of the first item in the array to satisfy a certain condition.

• arr (Array) - The array to search.

• condition (Function) - The boolean function that must be satisfied by the result of the search. If met, query returns the index. If not met, returns -1.

  Arguments

  • item (Object) - The value of any given item in the array.

  Returns

  Boolean - True if Arrays.query.condition.item satisfies the desired condition (and should have its index returned); false otherwise.

Number - The index of the first item satisfying Arrays.query.condition in Arrays.query.arr, or -1 if no match was found.

Performs a binary search on a sorted array to check which index a new item should be inserted at to maintain the order specified by Arrays.search.comparator.

• arr (Array) - The array to search.

• item (Object) - The arbitrary item / object to find an index for in the sorted array. Returns true if the object is found in the array; otherwise false.

• (Optional) comparator (Function) - The callback used to compare two entries in the array. Defaults to function (a, b) {return a - b;}.

  Arguments

  • a (Object) - The first item in the array to compare.

  • b (Object) - The second item in the array to compare.

  Returns

  Number - A negative number if Arrays.search.a occurs before Arrays.search.b in the sorted array, and a positive number if the converse is true. If Arrays.search.a and Arrays.search.b are equivalent, this should return 0.

Number - The index that the new item should be inserted at to maintain order.

Exchanges two values in an array. The supplied array instance is not modified during the call.

• arr (Array) - The array to swap items in.

• i (Number) - The index of the first item to swap.

• j (Number) - The index of the second item to swap.

Array - The modified array.

Finds a set corresponding to a given array -- i.e. that array with duplicate values removed.

• arr (Array) - The array to remove duplicates from.

Array - The set representation of the array.

Finds a string representation of an array.

• arr (Array) - The array to represent as a string.

String - A string of the form '[a1, a2, ..., an]'.