Skip to content

local_min_max_funct_1dlocal_min_max_funct_1dLocalMinMaxFunct1dLocalMinMaxFunct1dlocal_min_max_funct_1dT_local_min_max_funct_1d🔗

Short description🔗

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

Signature🔗

local_min_max_funct_1d( function_1d Function, string Mode, string Interpolation, out real Min, out real Max )local_min_max_funct_1d( : : Function, Mode, Interpolation : Min, Max )void LocalMinMaxFunct1d( const HTuple& Function, const HTuple& Mode, const HTuple& Interpolation, HTuple* Min, HTuple* Max )static void HOperatorSet.LocalMinMaxFunct1d( HTuple function, HTuple mode, HTuple 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]]

Herror T_local_min_max_funct_1d( 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)

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

Description🔗

local_min_max_funct_1dLocalMinMaxFunct1d searches for the local minima Minminmin and maxima Maxmaxmax of the function Functionfunctionfunction.

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

If Modemodemode is set to '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 Modemodemode is set to '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🔗

Execution information
  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).

  • Multithreading scope: global (may be called from any thread).

  • Processed without parallelization.

Parameters🔗

Functionfunctionfunction (input_control) function_1d → (real / integer)(real / integer)HTuple (double / Hlong)HFunction1D, HTuple (double / int / long)Sequence[Union[float, int]]Htuple (double / Hlong)

Input function

Modemodemode (input_control) string → (string)(string)HTuple (HString)HTuple (string)strHtuple (char*)

Handling of plateaus

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

Interpolationinterpolationinterpolation (input_control) string → (string)(string)HTuple (HString)HTuple (string)strHtuple (char*)

Interpolation of the input function

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

Minminmin (output_control) real-array → (real)(real)HTuple (double)HTuple (double)Sequence[float]Htuple (double)

Minimum points of the input function

Maxmaxmax (output_control) real-array → (real)(real)HTuple (double)HTuple (double)Sequence[float]Htuple (double)

Maximum points of the input function

Combinations with other operators🔗

Combinations

Possible predecessors

create_funct_1d_pairsCreateFunct1dPairs, create_funct_1d_arrayCreateFunct1dArray, smooth_funct_1d_gaussSmoothFunct1dGauss, smooth_funct_1d_meanSmoothFunct1dMean

Module🔗

Foundation