local_min_max_funct_1dT_local_min_max_funct_1dLocalMinMaxFunct1dLocalMinMaxFunct1dlocal_min_max_funct_1d (Operator)

Name

local_min_max_funct_1dT_local_min_max_funct_1dLocalMinMaxFunct1dLocalMinMaxFunct1dlocal_min_max_funct_1d — Calculate the local minimum and maximum points of a function.

Signature

local_min_max_funct_1d( : : Function, Mode, Interpolation : Min, Max)

Herror T_local_min_max_funct_1d(const Htuple Function, const Htuple Mode, const Htuple Interpolation, Htuple* Min, Htuple* Max)

void LocalMinMaxFunct1d(const HTuple& Function, const HTuple& Mode, const HTuple& Interpolation, HTuple* Min, HTuple* Max)

void HFunction1D::LocalMinMaxFunct1d(const HString& Mode, const HString& Interpolation, HTuple* Min, HTuple* Max) const

void HFunction1D::LocalMinMaxFunct1d(const char* Mode, const char* Interpolation, HTuple* Min, HTuple* Max) const

void HFunction1D::LocalMinMaxFunct1d(const wchar_t* Mode, const wchar_t* Interpolation, HTuple* Min, HTuple* Max) const   ( Windows only)

static void HOperatorSet.LocalMinMaxFunct1d(HTuple function, HTuple mode, HTuple interpolation, out HTuple min, out HTuple max)

void HFunction1D.LocalMinMaxFunct1d(string mode, string interpolation, out HTuple min, out HTuple max)

def local_min_max_funct_1d(function: Sequence[Union[float, int]], mode: str, interpolation: str) -> Tuple[Sequence[float], Sequence[float]]

Description

local_min_max_funct_1dlocal_min_max_funct_1dLocalMinMaxFunct1dLocalMinMaxFunct1dLocalMinMaxFunct1dlocal_min_max_funct_1d searches for the local minima MinMinMinMinminmin and maxima MaxMaxMaxMaxmaxmax of the function FunctionFunctionFunctionFunctionfunctionfunction.

Since the function values are only known at discrete sampling points, the function can interpolated by parabolas between these points. Setting the parameter InterpolationInterpolationInterpolationInterpolationinterpolationinterpolation to 'true'"true""true""true""true""true", enables this feature. If InterpolationInterpolationInterpolationInterpolationinterpolationinterpolation is 'false'"false""false""false""false""false", extrema are always sampling points.

If ModeModeModeModemodemode is set to 'strict_min_max'"strict_min_max""strict_min_max""strict_min_max""strict_min_max""strict_min_max", extrema are only calculated close to points with a function value that is strictly smaller or strictly greater than the values of its direct neighbors.

If ModeModeModeModemodemode is set to 'plateaus_center'"plateaus_center""plateaus_center""plateaus_center""plateaus_center""plateaus_center", areas with a function value that is constant throughout several sampling points are also considered. If such an area is identified as being a flat extremum, its center coordinate is returned.

Execution Information

Parameters

FunctionFunctionFunctionFunctionfunctionfunction (input_control)  function_1d HFunction1D, HTupleSequence[Union[float, int]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Input function

ModeModeModeModemodemode (input_control)  string HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Handling of plateaus

Default: 'strict_min_max' "strict_min_max" "strict_min_max" "strict_min_max" "strict_min_max" "strict_min_max"

List of values: 'plateaus_center'"plateaus_center""plateaus_center""plateaus_center""plateaus_center""plateaus_center", 'strict_min_max'"strict_min_max""strict_min_max""strict_min_max""strict_min_max""strict_min_max"

InterpolationInterpolationInterpolationInterpolationinterpolationinterpolation (input_control)  string HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Interpolation of the input function

Default: 'true' "true" "true" "true" "true" "true"

List of values: 'false'"false""false""false""false""false", 'true'"true""true""true""true""true"

MinMinMinMinminmin (output_control)  real-array HTupleSequence[float]HTupleHtuple (real) (double) (double) (double)

Minimum points of the input function

MaxMaxMaxMaxmaxmax (output_control)  real-array HTupleSequence[float]HTupleHtuple (real) (double) (double) (double)

Maximum points of the input function

Possible Predecessors

create_funct_1d_pairscreate_funct_1d_pairsCreateFunct1dPairsCreateFunct1dPairsCreateFunct1dPairscreate_funct_1d_pairs, create_funct_1d_arraycreate_funct_1d_arrayCreateFunct1dArrayCreateFunct1dArrayCreateFunct1dArraycreate_funct_1d_array, smooth_funct_1d_gausssmooth_funct_1d_gaussSmoothFunct1dGaussSmoothFunct1dGaussSmoothFunct1dGausssmooth_funct_1d_gauss, smooth_funct_1d_meansmooth_funct_1d_meanSmoothFunct1dMeanSmoothFunct1dMeanSmoothFunct1dMeansmooth_funct_1d_mean

Module

Foundation