Skip to content

maxtab

Returns the maximum value in a k-rate array and optionally its index.

This opcode is deprecated. Use maxarray in new code. The old name remains available for compatibility.

Syntax

kmax [, kindex] = maxtab(kArray[])

kmax [, kindex] maxtab kArray[]

Performance

kArray[] must be an initialized, nonempty numeric k-rate array. The opcode checks every element on each control cycle and returns the maximum in kmax.

The optional kindex is zero-based. If several elements have the same maximum, it reports the first. For a multidimensional array, the index counts through all elements in storage order, with the last dimension changing fastest.

Replacement

Change the name and keep the arguments and outputs. The k-rate forms share the same implementation.

// Old name
kValue, kIndex = maxtab(kArray)
// Supported name
kValue, kIndex = maxarray(kArray)

maxarray also accepts an i-rate array and returns an i-rate value and optional index at initialization. The old name has only the k-rate form.

See maxarray for examples.

Credits

Author John ffitch, October 2011.