miva_array_binarysearch()

    
Also See:   miva_array_clear miva_array_collapse miva_array_copy miva_array_copy_ref miva_array_delete miva_array_deserialize miva_array_elements miva_array_filter miva_array_filter_ref miva_array_find miva_array_insert miva_array_insert_ref miva_array_insert_var miva_array_max miva_array_merge miva_array_merge_ref miva_array_min miva_array_next miva_array_pop miva_array_pop_ref miva_array_previous miva_array_search miva_array_serialize miva_array_shift miva_array_shift_ref miva_array_sort miva_element_exists miva_member_exists miva_struct_members miva_struct_member_callback miva_struct_merge miva_struct_merge_ref

Report a language bug  |  Report a documentation error
Performs a binary search for "key" in "array". "array" must have been previously sorted.
Syntax 
miva_array_binarysearch( key, array var, callback, data var )
Returns the index of "key" in "array" or 0 if no match was found.
  • key = The value that will be searched for.
  • array var = The array that will be searched.
  • callback = The name of a callback function. See below.
  • data var = Optional data that is passed through to the callback function

callback is the name of a callback function with the following parameters:

    CallbackFunc( key var, element var, data var )
  • key = The value that will be searched for.
  • element = The current array record.
  • data = optional data that is passed unmodified to each execution of the callback function.

The callback function should return the following:

  • -1 = key is less than element
  • 0 = key is equal to element
  • 1 = key is greater than element

      • Example:

      <MvASSIGN NAME = "l.array" INDEX = 1 VALUE = "wombat">
<MvASSIGN NAME = "l.array" INDEX = 2 VALUE = "badger">
<MvASSIGN NAME = "l.array" INDEX = 3 VALUE = "beaver">

<MvFUNCTION NAME = "SortSearch_Callback" PARAMETERS = "left var, right var, data var">
    <MvIF EXPR = "{ l.left LT l.right }">
        <MvFUNCTIONRETURN VALUE = -1>
    <MvELSEIF EXPR = "{ l.left GT l.right }">
        <MvFUNCTIONRETURN VALUE = 1>
    </MvIF>
    <MvFUNCTIONRETURN VALUE = 0>
</MvFUNCTION>

<MvASSIGN NAME = "l.null" VALUE = "{ miva_array_sort( l.array, 'SortSearch_Callback', l.null ) }">
<MvASSIGN NAME = "l.wombat_pos" 
          VALUE = "{ miva_array_binarysearch( 'wombat', l.array, 'SortSearch_Callback', l.null ) }">
+ Add a note
User Annotations: miva_array_binarysearch