JavaScript Documentation: util_array.js

<<BACK

Summary: Random, standalone functions for array analysis.

Function	Summary
gtVRAIdx	Get the array index, at which the (first instance of the) desired value exists.
isInAscRA	Is the desired value in the ordered-ascending array of values?
isRA	Is the provided object an array?

util_array.js: Overview

Random, standalone functions for array analysis.

TOP     util_array.gtVRAIdx()

Get the array index, at which the (first instance of the) desired value exists.

PARAMETERS

• s_callingFunc: The function calling this, for potential error messages only.
• v_alue: The value to find in a_value
• a_value: The value array to search for v_alue in. Must be a good array

RETURNS

• Array index of a_value Of the first element equal to v_alue.
• -1 when no a_value element equals v_alue.

SIGNATURE

gtVRAIdx(s_callingFunc, v_alue, a_value)

TOP     util_array.isInAscRA()

Is the desired value in the ordered-ascending array of values?

PARAMETERS

• v_alue: The value to find in a_value. REQUIRED
• a_value: The ordered-ascending value array, to search for v_alue in. Must be a good array. It is assumed that it is ordered-ascending (a..z). If not, this function will behave unpredictably.

RETURNS

• true when an element in a_value equals v_alue.
• false if not.

SIGNATURE

isInAscRA(v_alue, a_value)

TOP     util_array.isRA()

Is the provided object an array?

This concept comes from Kas Thomas, at http://www.planetpdf.com/mainpage.asp?webpageid=1144

PARAMETERS

• o_potentialArray: The object to analyze for array-ness. REQUIRED.

RETURNS

• true when o_potentialArray is an array.
• false if not.

SIGNATURE

isRA(o_potentialArray)