shared/io.github.gatrongdev.kbignum.math/KBRoundingMode

KBRoundingMode

enum KBRoundingMode : Enum<KBRoundingMode>

Cross-platform representation of rounding behaviors supported by KBigDecimal operations. The enum mirrors the semantics of java.math.RoundingMode while providing type-safety and shared documentation across Kotlin Multiplatform targets.

Entries

Rounds away from zero.

Down

Rounds towards zero.

Ceiling

Rounds towards positive infinity.

Floor

Rounds towards negative infinity.

HalfUp

Rounds towards the nearest neighbour; ties are rounded away from zero.

HalfDown

Rounds towards the nearest neighbour; ties are rounded towards zero.

HalfEven

Rounds towards the nearest neighbour; ties are rounded to the even neighbour.

Unnecessary

Asserts that rounding is unnecessary; throws if precision would be lost.

Types

Companion

object Companion

Properties

entries

val entries: EnumEntries<KBRoundingMode>

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

legacyCode

val legacyCode: Int

Stable identifier matching legacy integer constants (see RoundingMode).

name

val name: String

ordinal

val ordinal: Int

Functions

valueOf

fun valueOf(value: String): KBRoundingMode

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<KBRoundingMode>

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