defineAlternativesReporting

fun defineAlternativesReporting(alternatives: Map<String, List<Score>>, allowRescalingByMetrics: Boolean = true): AlternativeDefinitionResult(source)

Defines the alternatives exactly as defineAlternatives does, and additionally reports which of them were taken into the model and why any were left out.

An alternative that is left out is simply absent from the results, which looks the same as never having been offered. The usual cause is a metric built a second time somewhere rather than the model's own metric being reused, since metrics are matched by identity and not by name, and that is hard to see precisely because the name looks right. Prefer this function wherever the caller can act on, or report, alternatives that did not make it in.

Return

which alternatives were taken in, and the reason for each one that was not

Parameters

allowRescalingByMetrics

indicates if rescaling is permitted by metrics or not. True is the default.