You are here: Start » Function Reference » Path Classification » GetMinimumPath

GetMinimumPath

Returns the path from the input array that corresponds to the smallest computed feature value.

Syntax

void avl::GetMinimumPath
(
	const atl::Array<avl::Path>& inPaths,
	avl::PathFeature::Type inFeature,
	avl::Path& outPath,
	atl::Optional<float&> outValue = atl::NIL,
	atl::Optional<int&> outIndex = atl::NIL
)

void GetMinimumPath
(
	Path[] inPaths,
	PathFeature inFeature,
	out Path outPath,
	out float? outValue,
	out int? outIndex
)

Parameters

Name	Type	Default	Description
inPaths	const Array<Path>&		Input paths
inFeature	PathFeature::Type		Path feature value to be computed
outPath	Path&		Output path
outValue	Optional<float&>	NIL	Computed feature value of the output path
outIndex	Optional<int&>	NIL

Errors

Error type	Description
DomainError	Empty path array on input in GetMinimumPath.