KSLCore/ksl.controls.experiments/Factor

Factor

open class Factor(name: String, values: DoubleArray = doubleArrayOf(-1.0, 1.0)) : Identity

This class represents an individual factor within a factorial design. The name of the factor must be provided and will be required to be unique when placed within a design. The supplied values of the levels must be strictly increasing. That is, they must be unique and increasing in value.

Parameters

values

the value for each level as an array. There must be 2 or more values supplied.

Inheritors

TwoLevelFactor

Constructors

Factor

constructor(name: String, values: List<Double>)

constructor(name: String, values: IntProgression)

constructor(name: String, low: Double, high: Double)

Creates a two level factor with provided low and high values.

constructor(name: String, values: DoubleArray = doubleArrayOf(-1.0, 1.0))

Properties

codedLevels

val codedLevels: List<Double>

The levels as coded values.

halfRange

val halfRange: Double

The half-range of the levels.

override val id: Int

interval

val interval: Interval

label

open override var label: String?

levels

val levels: List<Double>

The levels as a list

midPoint

val midPoint: Double

The mid-point of the levels.

name

override val name: String

Functions

codedLevels

fun codedLevels(): DoubleArray

The coded levels as an array.

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

isInRange

fun isInRange(value: Double): Boolean

True if the value is within the range limits of the factor

levels

fun levels(): DoubleArray

The levels as an array.

toCodedValue

fun toCodedValue(rawValue: Double): Double

Converts the original raw value to the coded measurement scale. This conversion does not check if the raw value is within the range limits of the factor.

toOriginalValue

fun toOriginalValue(codedValue: Double): Double

Converts the coded value to the original measurement scale

toString

open override fun toString(): String