KSLCore/ksl.controls.experiments/ExperimentalDesign

ExperimentalDesign

class ExperimentalDesign(factors: Set<Factor>, name: String? = null) : Identity, ExperimentalDesignIfc

Constructors

ExperimentalDesign

constructor(factors: Set<Factor>, name: String? = null)

Types

DesignPointIterator

inner class DesignPointIterator(val numReps: Int? = null) : DesignPointIteratorIfc

This iterator should present each design point until all points in the design have been presented.

Properties

open override val factorNames: List<String>

The names of the factors within a list.

open override val factors: Map<String, Factor>

The factors associated with the design held by name.

override val id: Int

open override var label: String?

override val name: String

open val numFactors: Int

The number of factor in the design

Functions

fun addDesignPoint(values: DoubleArray, numReps: Int = 1, enforceRange: Boolean = true): DesignPoint

fun addDesignPoint(settings: Map<Factor, Double>, numReps: Int = 1, enforceRange: Boolean = true): DesignPoint

Creates a design point and adds it to the design.

open fun centerPoint(): DoubleArray

Makes a center point for the factors of the design in the original measurement units

clearDesignPoints

fun clearDesignPoints()

Clears all the design points from the design.

open override fun designIterator(replications: Int?): DesignPointIteratorIfc

Returns an iterator that produces the design points in order from 1 to the number of design points.

open fun designPoints(): List<DesignPoint>

Returns all the design points in the experiment

designPointsAsDataframe

open fun designPointsAsDataframe(coded: Boolean = false): AnyFrame

Returns the design points as a data frame. The columns of the data frame are the factor names and the rows are the design points.

designPointsTo2DArray

open fun designPointsTo2DArray(coded: Boolean = false): Array<DoubleArray>

Returns all the design points based on the cartesian product of the factors and their levels as a 2D array. The rows of the array are the design points. The row array's 0th element represents the first factor in the list of factor names.

designPointsToList

open fun designPointsToList(coded: Boolean = false): List<DoubleArray>

Returns all the design points based on the cartesian product of the factors and their levels. The element arrays of the returned list are the design points. The element array's 0th element represents the first factor in the list of factor names.

open fun factorName(k: Int): String

Returns the name of the factor. The first factor is at k = 1

open fun forEach(p0: Consumer<in DesignPoint>)

open fun isValid(settings: Map<Factor, Double>, enforceRange: Boolean = true): Boolean

Checks if the settings for the factors are valid for this design

open operator override fun iterator(): Iterator<DesignPoint>

open fun linearModel(type: LinearModel.Type = LinearModel.Type.FirstOrder): LinearModel

To facilitate the specification of a linear model for the design

open fun spliterator(): Spliterator<DesignPoint>

open fun toCodedValues(rawValues: DoubleArray): DoubleArray

Converts the original values to code values

toOriginalValues

open fun toOriginalValues(codedValues: DoubleArray): DoubleArray

Converts the coded values to values on the original measurement scale.

open override fun toString(): String