KSLCore/ksl.utilities.moda

Package-level declarations

Types

class AdditiveMODAModel(metricDefinitions: Map<MetricIfc, ValueFunctionIfc>, weights: Map<MetricIfc, Double> = makeEqualWeights(metricDefinitions.keys), name: String? = null) : MODAModel

Represents a multi-objective decision analysis (MODA) model that uses an additive model for the attribute valuation. The supplied weights must correspond to weights within the model.

AlternativeRankFrequencyData

data class AlternativeRankFrequencyData(var id: Int = altRankFreqDataCounter++, var modaName: String = "", var alternative: String = "", var value: Int = 0, var count: Double = 0.0, var proportion: Double = 0.0, var cumProportion: Double = 0.0) : DbTableData

LinearValueFunction

class LinearValueFunction : ValueFunctionIfc

Uses a linear transformation to transform from score with a metric domain to the value domain.

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.

MetricData

data class MetricData(var id: Int = metricDataCounter++, var modaName: String = "", var metricName: String = "", var direction: String = "", var weight: Double = 1.0, var domainLowerLimit: Double = 0.0, var domainUpperLimit: Double = Double.POSITIVE_INFINITY, var unitsOfMeasure: String? = null, var description: String? = null, var allowLowerLimitAdjustment: Boolean = false, var allowUpperLimitAdjustment: Boolean = false) : DbTableData

MetricIfc

interface MetricIfc

A performance metric is figure of merit that characterizes the performance of a device, system, method, or entity, relative to its alternatives.

MODAAnalyzer

class MODAAnalyzer(alternativeNames: Set<String>, responseDefinitions: Set<MODAAnalyzerData>, responseData: List<WithinRepViewData>)

MODAAnalyzerData

data class MODAAnalyzerData(val responseName: String, val direction: MetricIfc.Direction = MetricIfc.Direction.SmallerIsBetter, var weight: Double = 1.0, val valueFunction: ValueFunctionIfc = LinearValueFunction(), val domain: Interval = Interval(0.0, Double.MAX_VALUE), var unitsOfMeasure: String? = null, var description: String? = null)

MODAModel

abstract class MODAModel(metricDefinitions: Map<MetricIfc, ValueFunctionIfc>, name: String? = null) : IdentityIfc

Defines a base class for creating multi-objective decision analysis (MODA) models.

MultiAttributeValueFunctionIfc

interface MultiAttributeValueFunctionIfc

OverallValueData

data class OverallValueData(var id: Int = overallValueDataCounter++, var modaName: String = "", var alternative: String = "", var weightedValue: Double = 0.0, var firstRankCount: Int = 0, var averageRank: Double = 0.0) : DbTableData

Score

data class Score(val metric: MetricIfc, val value: Double, var valid: Boolean = true)

A score represents an evaluation of an alternative, system, or entity based on some metric. Each score is related to a metric and has a value that represents the value of the metric. If there is an issue with computing the score, then the property valid indicates whether the score can be trusted (true) or not (false). The default value of the valid property is true. The supplied value must be within the specified domain of the supplied metric; otherwise, an illegal argument exception will occur.

ScoreData

data class ScoreData(var id: Int = scoreDataCounter++, var modaName: String = "", var alternative: String = "", var scoreName: String = "", var scoreValue: Double = 0.0) : DbTableData

ValueData

data class ValueData(var id: Int = valueDataCounter++, var modaName: String = "", var alternative: String = "", var metricName: String = "", var metricValue: Double = 0.0, var rank: Double = 0.0) : DbTableData

ValueFunction

abstract class ValueFunction : ValueFunctionIfc

A value function maps values from some metric domain to the value range of 0.0, 1.0, where 0.0 implies no value and 1.0 implies maximal value.

ValueFunctionIfc

fun interface ValueFunctionIfc

A value function maps values from some domain to the value range of 0.0, 1.0, where 0.0 implies no value and 1.0 implies maximal value.

Functions

main

fun main()