You are here: Start » Function Reference » Profile Features » ProfileMaximum

ProfileMaximum

Finds the highest value of the input profile, its precise location and the corresponding index.

Header:	AVL.h

Syntax

void avl::ProfileMaximum
(
	const avl::Profile& inProfile,
	avl::ProfileInterpolationMethod::Type inInterpolationMethod,
	float& outMaximumPoint,
	atl::Optional<int&> outMaximumIndex = atl::NIL,
	atl::Optional<float&> outMaximumValue = atl::NIL
)

void ProfileMaximum
(
	Profile inProfile,
	ProfileInterpolationMethod inInterpolationMethod,
	out float outMaximumPoint,
	out int? outMaximumIndex,
	out float? outMaximumValue
)

Parameters

Name	Type	Default	Description
inProfile	const Profile&		Input profile
inInterpolationMethod	ProfileInterpolationMethod::Type	Quadratic4	Profile points' interpolation method
outMaximumPoint	float&		Position of highest value with respect to profile's offset and scale
outMaximumIndex	Optional<int&>	NIL	Index of highest value
outMaximumValue	Optional<float&>	NIL	Highest value

Errors

Error type	Description
DomainError	Empty profile in ProfileMaximum.