KSLCore/ksl.controls.experiments/FactorialDesign

FactorialDesign

open class FactorialDesign @JvmOverloads constructor(factors: Set<Factor>, name: String? = null) : Identity, ExperimentalDesignIfc(source)

A factorial design represents a list of design points where every design point represents a possible row in the cartesian product of the levels for the factors. That is, all possible combinations of the levels for the factors are possible design points. A design point is individually generated when needed via the associated iterator for the design.

Parameters

factors

a set representing the factors used in the design. There must be 2 factors in the supplied set.

name

an optional name for the design

Inheritors

TwoLevelFactorialDesign

Constructors

FactorialDesign

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

Types

object Companion

FactorialDesignIterator

open inner class FactorialDesignIterator @JvmOverloads constructor(val numReps: Int? = null) : DesignPointIteratorIfc

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

Properties

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.

numDesignPoints

val numDesignPoints: Int

Functions

open override fun designIterator(replications: Int?): FactorialDesign.FactorialDesignIterator

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

protected fun designPoint(k: Int, replications: Int?): DesignPoint

Returns the design point at the kth row of the factorial design based on the cartesian product of the factors and their levels.

open operator override fun iterator(): DesignPointIteratorIfc

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

open override fun toString(): String