KSLCore/ksl.utilities.random.robj/RList

RList

abstract class RList<T>(val elements: MutableList<T>, stream: RNStreamIfc = KSLRandom.nextRNStream()) : RListIfc<T> , MutableList<T>

Inheritors

Constructors

constructor(elements: MutableList<T>, stream: RNStreamIfc = KSLRandom.nextRNStream())

Properties

advanceToNextSubStreamOption

open override var advanceToNextSubStreamOption: Boolean

If true, the stream will automatically participate in having its stream advanced to the next sub-stream via stream managers

open override var antithetic: Boolean

Tells the stream to start producing antithetic variates

val elements: MutableList<T>

abstract val randomElement: T

Returns an element randomly selected from the list

resetStartStreamOption

open override var resetStartStreamOption: Boolean

If true, the stream will automatically participate in having its stream reset to its start stream via stream managers

open override var rnStream: RNStreamIfc

the underlying stream of random numbers

open override val size: Int

open val streamNumber: Int

Functions

open override fun add(element: T): Boolean

open override fun add(index: Int, element: T)

open override fun addAll(elements: Collection<T>): Boolean

open override fun addAll(index: Int, elements: Collection<T>): Boolean

advanceToNextSubStream

open override fun advanceToNextSubStream()

Positions the RNG at the beginning of its next substream

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.

fun List<StatisticIfc>.averages(): DoubleArray

open override fun clear()

confidenceIntervals

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

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

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

fun List<StatisticIfc>.counts(): DoubleArray

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

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

hasSufficientAvailableUnits

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

open override fun indexOf(element: T): Int

open override fun isEmpty(): Boolean

open operator override fun iterator(): MutableIterator<T>

open override fun lastIndexOf(element: T): Int

open override fun listIterator(): MutableListIterator<T>

open override fun listIterator(index: Int): MutableListIterator<T>

numAvailableUnits

fun List<Resource>.numAvailableUnits(): Int

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

open fun parallelStream(): Stream<T>

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

Converts the list of strings to Doubles

fun <T> MutableList<T>.permute(streamNum: Int): MutableList<T>

fun <T> MutableList<T>.permute(stream: RNStreamIfc = KSLRandom.defaultRNStream()): MutableList<T>

Permutes the array in place. The array is changed.

fun <T> MutableList<T>.permute(streamNum: Int)

fun <T> MutableList<T>.permute(stream: RNStreamIfc = KSLRandom.defaultRNStream())

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

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

open override fun remove(element: T): Boolean

open override fun removeAll(elements: Collection<T>): Boolean

open override fun removeAt(index: Int): T

open fun removeIf(p0: Predicate<in T>): Boolean

open fun replaceAll(p0: UnaryOperator<T>)

resetStartStream

open override fun resetStartStream()

The resetStartStream method will position the RNG at the beginning of its stream. This is the same location in the stream as assigned when the RNG was created and initialized.

resetStartSubStream

open override fun resetStartSubStream()

Resets the position of the RNG at the start of the current substream

open override fun retainAll(elements: Collection<T>): Boolean

open fun sample(): T

Returns an element randomly selected from the list

open fun sample(size: Int): List<T>

Returns sample of size from the list

fun <T> MutableList<T>.sample(stream: RNStreamIfc = KSLRandom.defaultRNStream()): T

Randomly samples an element from the list.

fun <T> MutableList<T>.sample(sampleSize: Int, stream: RNStreamIfc = KSLRandom.defaultRNStream()): MutableList<T>

Randomly samples sampleSize elements from the list, returning a new list The elements in the list may repeat (sampling with replacement)

open operator override fun set(index: Int, element: T): T

open fun sort(p0: Comparator<in T>)

open override fun spliterator(): Spliterator<T>

fun Collection<Double>.statistics(): Statistic

Returns a statistic that summarizes the data in the collection.

open fun stream(): Stream<T>

open override fun subList(fromIndex: Int, toIndex: Int): MutableList<T>

open fun <T : Any> ~~toArray~~(p0: IntFunction<Array<T>>): Array<T>

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

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

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

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()

useStreamNumber

open fun useStreamNumber(streamNumber: Int)

Assigns the stream associated with the supplied number from the default RNStreamProvider

fun List<StatisticIfc>.variances(): DoubleArray

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