KSLCore/ksl.simopt.evaluator/Solutions

Solutions

class Solutions(val capacity: Int = defaultCapacity, var allowInfeasibleSolutions: Boolean = false) : SolutionsIfc

Class to support a group of solutions (each containing inputs, responses, objective fns, penalties) The solutions are naturally ordered by comparison of Solution instances based on their penalized objective functions (without regard to sampling error).

Parameters

capacity

the capacity for the solutions. Constrains the total number of solutions in-memory. The default capacity is 100. Oldest solutions are evicted first.

allowInfeasibleSolutions

if true input infeasible solutions are allowed to be saved. If false, input-infeasible solutions are silently ignored. The default is false (do not allow input infeasible solutions to be saved)

Constructors

Solutions

constructor(solutions: List<Solution>, capacity: Int = defaultCapacity)

constructor(capacity: Int = defaultCapacity, allowInfeasibleSolutions: Boolean = false)

Types

Companion

object Companion

Properties

allowInfeasibleSolutions

var allowInfeasibleSolutions: Boolean

capacity

val capacity: Int

enteredSolutions

val enteredSolutions: List<Solution>

A time-ordered list of the solution, where 0 is the first (oldest) solution added, 1 is the next, etc.

orderedInputFeasibleSolutions

open override val orderedInputFeasibleSolutions: List<Solution>

A list of solutions that are input feasible ordered by penalized objective function.

orderedSolutions

open override val orderedSolutions: List<Solution>

A list of solutions ordered by penalized objective function. The solutions may or may not be feasible.

powersetSize

val <T> Collection<T>.powersetSize: Int

size

open override val size: Int

Functions

add

fun add(solution: Solution): Solution?

Adds the solution to the sequence of solutions. If the capacity is met, then the oldest (first) item is evicted and returned

addAll

fun addAll(solutions: List<Solution>): List<Solution>

Adds all the solutions to the sequence of solutions. If the capacity is met, then the oldest (first) item is evicted and returned. Each evicted item is returned in the order of eviction.

allAvailable

fun List<Conveyor.Cell>.allAvailable(): Boolean

Returns true if and only if all cells in the list are available.

asMCBIntervalDataFrame

fun List<MCBIntervalData>.asMCBIntervalDataFrame(): DataFrame<MCBIntervalData>

Converts the MCB interval data to a data frame

asMCBResultDataFrame

fun List<MCBResultData>.asMCBResultDataFrame(): DataFrame<MCBResultData>

Converts the MCB result data to a data frame

asMCBScreeningIntervalDataFrame

fun List<MCBScreeningIntervalData>.asMCBScreeningIntervalDataFrame(): DataFrame<MCBScreeningIntervalData>

Converts the MCB interval data to a data frame

asObservationDataFrame

fun List<ObservationDataDb>.asObservationDataFrame(): DataFrame<ObservationDataDb>

Converts the observation data to a data frame

asStatisticDataFrame

fun List<StatisticDataDb>.asStatisticDataFrame(): DataFrame<StatisticDataDb>

Converts the statistic data to a data frame

availableResources

fun List<Resource>.availableResources(): MutableList<Resource>

Filters the list such that the returned list has resources that have units available for allocation. The returned list may be empty which indicates that there are no resources in the list that have available units.

averages

fun List<StatisticIfc>.averages(): DoubleArray

cdf

fun List<ProbPoint>.cdf(): DoubleArray

Returns the cumulative distribution probabilities as an array

clear

fun clear()

Clears all solutions

confidenceIntervals

fun List<StatisticIfc>.confidenceIntervals(level: Double = 0.95): List<Interval>

contains

open operator override fun contains(element: Solution): Boolean

containsAll

open override fun containsAll(elements: Collection<Solution>): Boolean

counts

fun List<StatisticIfc>.counts(): DoubleArray

distancesTo

fun List<MovableResource>.distancesTo(location: LocationIfc)

Computes and assigns the distance to the provided location from the current location of the resource for each resource. The distance is assigned to the resource's sectionCriteria attribute. This mutates elements of the list.

get

open operator override fun get(index: Int): Solution

hasSufficientAvailableUnits

fun List<Resource>.hasSufficientAvailableUnits(amountNeeded: Int): Boolean

indexOf

open override fun indexOf(element: Solution): Int

indexOfMin

fun List<Double>.indexOfMin(): Int

Returns the index associated with the minimum element in the list For ties, this returns the first found.

isEmpty

open override fun isEmpty(): Boolean

iterator

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

lastIndexOf

open override fun lastIndexOf(element: Solution): Int

listIterator

open override fun listIterator(): ListIterator<Solution>

open override fun listIterator(index: Int): ListIterator<Solution>

numAvailable

fun List<Conveyor.Cell>.numAvailable(): Int

Returns the total number of available cells within the list. The count is regardless of the sequential nature of the cells. That is, regardless of whether intermediate cells are not available. This is simply the total number available.

numAvailableUnits

fun List<Resource>.numAvailableUnits(): Int

Returns the total number of units that are available within the resources contained in the list.

orderedResponseFeasibleSolutions

open fun orderedResponseFeasibleSolutions(overallCILevel: Double = 0.99): List<Solution>

A list of solutions ordered by penalized objective function that are input feasible and have tested as response constraint feasible.

parseToDoubles

fun List<String>.parseToDoubles(parseFail: Double = Double.NaN): DoubleArray

Converts the list of strings to Doubles

peekBest

open override fun peekBest(): Solution?

The solution with the lowest penalized objective function value. The solution may or may not be feasible.

powerset

fun <T> Collection<T>.powerset(): Set<Set<T>>

probabilities

fun List<ProbPoint>.probabilities(): DoubleArray

Returns the probabilities as an array

randomlySelect

fun <T> List<T>.randomlySelect(streamNum: Int): T

fun <T> List<T>.randomlySelect(stream: RNStreamIfc = KSLRandom.defaultRNStream()): T

remove

fun remove(solution: Solution)

Removes the specified element

sample

fun Collection<RVariableIfc>.sample(): DoubleArray

Returns an array that holds a sample from each individual random variable in the collection.

fun List<RVariableIfc>.sample(): DoubleArray

Returns an array that holds a sample from each individual random variable in the list.

fun Collection<RVariableIfc>.sample(sampleSize: Int = 1): Array<DoubleArray>

Returns an array that holds a sample of size sampleSize from each individual random variable in the collection.

fun List<RVariableIfc>.sample(sampleSize: Int = 1): Array<DoubleArray>

Returns a matrix that holds a sample of size sampleSize from each individual random variable in the list.

statistics

fun Collection<Double>.statistics(): Statistic

Returns a statistic that summarizes the data in the collection.

subList

open override fun subList(fromIndex: Int, toIndex: Int): List<Solution>

toDataFrame

fun List<DesignPoint>.toDataFrame(coded: Boolean = false): AnyFrame

Turns the list of design points into a data frame. The columns of the data frame are the factor names and the rows are the design points values.

toListOfStringArrays

@JvmStatic

fun List<CSVRecord>.toListOfStringArrays(): List<Array<String>>

For compatibility purposes converts the list of CSV records to a list of string arrays

toPrimitives

fun List<Double?>.toPrimitives(replaceNull: Double = 0.0): DoubleArray

Converts any null values to replaceNull. For List use toDoubleArray()

fun List<Int?>.toPrimitives(replaceNull: Int = 0): IntArray

Converts any null values to replaceNull. For List use toDoubleArray()

fun List<Long?>.toPrimitives(replaceNull: Long = 0): LongArray

Converts any null values to replaceNull. For List use toDoubleArray()

totalReplications

fun List<RequestData>.totalReplications(): Int

A simple extension function to compute the total number of replications within a set of evaluation requests.

values

fun List<ProbPoint>.values(): DoubleArray

Returns the values as an array

variances

fun List<StatisticIfc>.variances(): DoubleArray

write

fun List<DoubleArray>.write(out: PrintWriter = KSLFileUtil.SOUT, df: DecimalFormat? = null)