MODAAnalyzer

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

Parameters

alternativeNames

the set of names representing the experiments or scenarios to be evaluated.

responseDefinitions

A specification of the name of the response, its associated weight, metric, and value function within a Set

responseData

the data to use for the analysis

Constructors

Link copied to clipboard
constructor(alternativeNames: Set<String>, responseDefinitions: Set<MODAAnalyzerData>, responseData: List<WithinRepViewData>)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
Link copied to clipboard

The names of the responses as supplied within the response definitions

Functions

Link copied to clipboard
fun analyze()

Causes the analyzer to analyze the data to produce MODA models for each replication and results for an overall multiple comparison of the value scoring of each alternative.

Link copied to clipboard
fun asString(includeMCBByResponse: Boolean = true, includeOverallRankFreq: Boolean = false, includeMCBByMODAResponse: Boolean = false, includeMODAByReplication: Boolean = false): String

Constructs a string representation of the results.

Link copied to clipboard

Returns a MODA model based on the average performance of the responses across the replications.

Link copied to clipboard

Computes the average performance for each alternative for each response

Link copied to clipboard
fun changeWeights(newWeights: Map<String, Double>)

Changes or assigns the weights for the additive model. The keys to the map are the names of the responses. The values to the map are the weights. Each weight must be greater than 0.0

Link copied to clipboard

Returns a multiple comparison analyzer instance that permits the comparison of overall value for each alternative based on the MODA results. The returned result may be null if insufficient data exists to perform the analysis. There must be at least 2 alternative and there must be 2 or more observations for each alternative. The number of observations per alternative must also be the same.

Link copied to clipboard

Returns a map holding multiple comparison results for each response. The response values represent the values from the value function transformation. Thus, the MCB comparison is done on the value domains.

Link copied to clipboard

Returns a map holding multiple comparison results for each response. The key to the returned map is the response name. The associated multiple comparison analyzer represents the comparison for that response across all the experiments/alternatives. If insufficient data is available, then the response is not included.

Link copied to clipboard

Tabulate the rank frequencies for each alternative based on overall MODA value

Link copied to clipboard
fun print(includeMCBByResponse: Boolean = true, includeOverallRankFreq: Boolean = false, includeMCBByMODAResponse: Boolean = false, includeMODAByReplication: Boolean = false)

Prints the basic asString() results to the console.

Link copied to clipboard

Extracts the response performance as MODA values (i.e. after value function processing) The returned map of maps has the outer key as the experiment/alternative name. The associated inner map holds the response values for each replication by response name (key).

Link copied to clipboard

Computes and returns the raw replication values for the responses for each experiment/alternative. The returned map of maps has an outer key of the experiment/alternative name. The inner map has keys representing the named responses. The associated array contains the associated replication values of the response variable (within replication average, or ending counter value), a value for each replication.

Link copied to clipboard
fun resultsAsDatabase(dbName: String, dir: Path = KSL.dbDir, deleteIfExists: Boolean = true): DatabaseIfc

Returns the results as a database holding MCBResultData, MCBIntervalData, MCBScreeningIntervalData, StatisticDataDb, and ObservationDataDb tables (tblMCBResults, tblStatistic, tblMCBIntervals,tblMCBScreeningIntervals, tblObservations).

Link copied to clipboard
open override fun toString(): String
Link copied to clipboard
fun write(out: PrintWriter, includeMCBByResponse: Boolean = true, includeOverallRankFreq: Boolean = true, includeMCBByMODAResponse: Boolean = true, includeMODAByReplication: Boolean = true)

Writes the basic asString() results to the PrintWriter.

fun write(fileName: String, includeMCBByResponse: Boolean = true, includeOverallRankFreq: Boolean = true, includeMCBByMODAResponse: Boolean = true, includeMODAByReplication: Boolean = true)

Writes the basic asString() results to a file within the KSL output directory.