kstats-core/org.oremif.kstats.descriptive/SemiVarianceDirection

SemiVarianceDirection

enum SemiVarianceDirection : Enum<SemiVarianceDirection> (source)

Selects which side of the threshold to measure in a semi-variance calculation.

Semi-variance splits the total variance into downside risk (values below the threshold) and upside potential (values above). This enum controls which side is measured.

Entries

UPSIDE

Measure variability of values strictly above the threshold.

DOWNSIDE

Measure variability of values strictly below the threshold.

Properties

entries

val entries: EnumEntries<SemiVarianceDirection>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

Functions

valueOf

fun valueOf(value: String): SemiVarianceDirection

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<SemiVarianceDirection>

Returns an array containing the constants of this enum type, in the order they're declared.