>  Docs Center  >  Libraries  >  Motley  >  MGH_MINMAX

MGH_MINMAX

MGH_MINMAX

Name


  MGH_MINMAX

Purpose


  This function returns a 2 element vector containing both the
  minimum and maximum of an array.

Calling Sequence


  Result = mgh_minmax(array)

Positional Parameters


  array (input, numeric, scalar or array)
    Data for which max & min are required.

Return Value


  The function returns a two-element vector equal to
  [min(arr),max(arr)]

Keyword Parameters


  ABSOLUTE (input, switch)
    Set this keyword to cause the routine to use the absolute value
    of each element in determining the minimum and maximum
    values.This keyword has no effect for arrays of type byte or
    unsigned integer.
  NAN (input, switch)
    Set this keyword to cause the routine to check for occurrences
    of the IEEE floating-point value NaN in the input data.
    Elements with the value NaN are treated as missing data.
  SUBSCRIPT (output, 2-element integer)
    This keyword returns the one-dimensional subscripts of the minimum
    and maximum elements, bundled as a 2-element integer vector.

Procedure


  The MIN function is used with the MAX keyword

Explanation


  The function is defined for convenience and performance. A single
  call to MGH_MINMAX is faster than separate calls to MAX and MIN.
###########################################################################
  This software is provided subject to the following conditions:
  1. NIWA makes no representations or warranties regarding the
    accuracy of the software, the use to which the software may
    be put or the results to be obtained from the use of the
    software. Accordingly NIWA accepts no liability for any loss
    or damage (whether direct of indirect) incurred by any person
    through the use of or reliance on the software.
  2. NIWA is to be acknowledged as the original author of the
    software where the software is used or presented in any form.
###########################################################################

Modification History


  Mark Hadfield, 1999-11:
    Written based on the MINMAX routine in the IDL Astronomy Library.
  Mark Hadfield, 2003-06:
    Added SUBSCRIPT keyword
  Mark Hadfield, 2007-02:
    Added ABSOLUTE keyword, to support the MIN/MAX keyword of the
    same name introduced in IDL 6.1.



© 2019 Harris Geospatial Solutions, Inc. |  Legal
My Account    |    Store    |    Contact Us