KSLCore/ksl.utilities.moda/Metric

Metric

open class Metric(val name: String, val domain: Interval = Interval(0.0, Double.MAX_VALUE), val allowLowerLimitAdjustment: Boolean = true, val allowUpperLimitAdjustment: Boolean = true) : MetricIfc

This class serves as a base class for classes that implement the MetricIfc interface. A metric is figure of merit that characterizes the performance of a device, system, method, or entity, relative to its alternatives.

A metric has a required name to help identify it and an optional description to provide context for the metric. The domain of the metric represents the natural set of possible (real) legal values for its values. The default interval for the domain is 0.0 to Double.MAX_VALUE. The direction provides the context for evaluation based on the metric value, with two cases:

bigger values are considered better or 2) smaller values are considered better. The default direction is smaller is better. The metric can have a description of its units of measure unitsOfMeasure.

Inheritors

PDFScoringModel

Constructors

Metric

constructor(name: String, domain: Interval = Interval(0.0, Double.MAX_VALUE), allowLowerLimitAdjustment: Boolean = true, allowUpperLimitAdjustment: Boolean = true)