/* * Copyright 2010-2023 JetBrains s.r.o. and Kotlin Programming Language contributors. * Use of this source code is governed by the Apache 2.0 license that can be found in the license/LICENSE.txt file. */ // Auto-generated file. DO NOT EDIT! package kotlin import kotlin.experimental.* import kotlin.jvm.* @SinceKotlin("1.5") @WasExperimental(ExperimentalUnsignedTypes::class) @JvmInline public value class UByte @kotlin.internal.IntrinsicConstEvaluation @PublishedApi internal constructor(@PublishedApi internal val data: Byte) : Comparable { companion object { /** * A constant holding the minimum value an instance of UByte can have. */ public const val MIN_VALUE: UByte = UByte(0) /** * A constant holding the maximum value an instance of UByte can have. */ public const val MAX_VALUE: UByte = UByte(-1) /** * The number of bytes used to represent an instance of UByte in a binary form. */ public const val SIZE_BYTES: Int = 1 /** * The number of bits used to represent an instance of UByte in a binary form. */ public const val SIZE_BITS: Int = 8 } /** * Compares this value with the specified value for order. * Returns zero if this value is equal to the specified other value, a negative number if it's less than other, * or a positive number if it's greater than other. */ @kotlin.internal.InlineOnly @Suppress("OVERRIDE_BY_INLINE") public override inline operator fun compareTo(other: UByte): Int = this.toInt().compareTo(other.toInt()) /** * Compares this value with the specified value for order. * Returns zero if this value is equal to the specified other value, a negative number if it's less than other, * or a positive number if it's greater than other. */ @kotlin.internal.InlineOnly public inline operator fun compareTo(other: UShort): Int = this.toInt().compareTo(other.toInt()) /** * Compares this value with the specified value for order. * Returns zero if this value is equal to the specified other value, a negative number if it's less than other, * or a positive number if it's greater than other. */ @kotlin.internal.InlineOnly public inline operator fun compareTo(other: UInt): Int = this.toUInt().compareTo(other) /** * Compares this value with the specified value for order. * Returns zero if this value is equal to the specified other value, a negative number if it's less than other, * or a positive number if it's greater than other. */ @kotlin.internal.InlineOnly public inline operator fun compareTo(other: ULong): Int = this.toULong().compareTo(other) /** Adds the other value to this value. */ @kotlin.internal.InlineOnly public inline operator fun plus(other: UByte): UInt = this.toUInt().plus(other.toUInt()) /** Adds the other value to this value. */ @kotlin.internal.InlineOnly public inline operator fun plus(other: UShort): UInt = this.toUInt().plus(other.toUInt()) /** Adds the other value to this value. */ @kotlin.internal.InlineOnly public inline operator fun plus(other: UInt): UInt = this.toUInt().plus(other) /** Adds the other value to this value. */ @kotlin.internal.InlineOnly public inline operator fun plus(other: ULong): ULong = this.toULong().plus(other) /** Subtracts the other value from this value. */ @kotlin.internal.InlineOnly public inline operator fun minus(other: UByte): UInt = this.toUInt().minus(other.toUInt()) /** Subtracts the other value from this value. */ @kotlin.internal.InlineOnly public inline operator fun minus(other: UShort): UInt = this.toUInt().minus(other.toUInt()) /** Subtracts the other value from this value. */ @kotlin.internal.InlineOnly public inline operator fun minus(other: UInt): UInt = this.toUInt().minus(other) /** Subtracts the other value from this value. */ @kotlin.internal.InlineOnly public inline operator fun minus(other: ULong): ULong = this.toULong().minus(other) /** Multiplies this value by the other value. */ @kotlin.internal.InlineOnly public inline operator fun times(other: UByte): UInt = this.toUInt().times(other.toUInt()) /** Multiplies this value by the other value. */ @kotlin.internal.InlineOnly public inline operator fun times(other: UShort): UInt = this.toUInt().times(other.toUInt()) /** Multiplies this value by the other value. */ @kotlin.internal.InlineOnly public inline operator fun times(other: UInt): UInt = this.toUInt().times(other) /** Multiplies this value by the other value. */ @kotlin.internal.InlineOnly public inline operator fun times(other: ULong): ULong = this.toULong().times(other) /** Divides this value by the other value, truncating the result to an integer that is closer to zero. */ @kotlin.internal.InlineOnly public inline operator fun div(other: UByte): UInt = this.toUInt().div(other.toUInt()) /** Divides this value by the other value, truncating the result to an integer that is closer to zero. */ @kotlin.internal.InlineOnly public inline operator fun div(other: UShort): UInt = this.toUInt().div(other.toUInt()) /** Divides this value by the other value, truncating the result to an integer that is closer to zero. */ @kotlin.internal.InlineOnly public inline operator fun div(other: UInt): UInt = this.toUInt().div(other) /** Divides this value by the other value, truncating the result to an integer that is closer to zero. */ @kotlin.internal.InlineOnly public inline operator fun div(other: ULong): ULong = this.toULong().div(other) /** * Calculates the remainder of truncating division of this value (dividend) by the other value (divisor). * * The result is always less than the divisor. */ @kotlin.internal.InlineOnly public inline operator fun rem(other: UByte): UInt = this.toUInt().rem(other.toUInt()) /** * Calculates the remainder of truncating division of this value (dividend) by the other value (divisor). * * The result is always less than the divisor. */ @kotlin.internal.InlineOnly public inline operator fun rem(other: UShort): UInt = this.toUInt().rem(other.toUInt()) /** * Calculates the remainder of truncating division of this value (dividend) by the other value (divisor). * * The result is always less than the divisor. */ @kotlin.internal.InlineOnly public inline operator fun rem(other: UInt): UInt = this.toUInt().rem(other) /** * Calculates the remainder of truncating division of this value (dividend) by the other value (divisor). * * The result is always less than the divisor. */ @kotlin.internal.InlineOnly public inline operator fun rem(other: ULong): ULong = this.toULong().rem(other) /** * Divides this value by the other value, flooring the result to an integer that is closer to negative infinity. * * For unsigned types, the results of flooring division and truncating division are the same. */ @kotlin.internal.InlineOnly public inline fun floorDiv(other: UByte): UInt = this.toUInt().floorDiv(other.toUInt()) /** * Divides this value by the other value, flooring the result to an integer that is closer to negative infinity. * * For unsigned types, the results of flooring division and truncating division are the same. */ @kotlin.internal.InlineOnly public inline fun floorDiv(other: UShort): UInt = this.toUInt().floorDiv(other.toUInt()) /** * Divides this value by the other value, flooring the result to an integer that is closer to negative infinity. * * For unsigned types, the results of flooring division and truncating division are the same. */ @kotlin.internal.InlineOnly public inline fun floorDiv(other: UInt): UInt = this.toUInt().floorDiv(other) /** * Divides this value by the other value, flooring the result to an integer that is closer to negative infinity. * * For unsigned types, the results of flooring division and truncating division are the same. */ @kotlin.internal.InlineOnly public inline fun floorDiv(other: ULong): ULong = this.toULong().floorDiv(other) /** * Calculates the remainder of flooring division of this value (dividend) by the other value (divisor). * * The result is always less than the divisor. * * For unsigned types, the remainders of flooring division and truncating division are the same. */ @kotlin.internal.InlineOnly public inline fun mod(other: UByte): UByte = this.toUInt().mod(other.toUInt()).toUByte() /** * Calculates the remainder of flooring division of this value (dividend) by the other value (divisor). * * The result is always less than the divisor. * * For unsigned types, the remainders of flooring division and truncating division are the same. */ @kotlin.internal.InlineOnly public inline fun mod(other: UShort): UShort = this.toUInt().mod(other.toUInt()).toUShort() /** * Calculates the remainder of flooring division of this value (dividend) by the other value (divisor). * * The result is always less than the divisor. * * For unsigned types, the remainders of flooring division and truncating division are the same. */ @kotlin.internal.InlineOnly public inline fun mod(other: UInt): UInt = this.toUInt().mod(other) /** * Calculates the remainder of flooring division of this value (dividend) by the other value (divisor). * * The result is always less than the divisor. * * For unsigned types, the remainders of flooring division and truncating division are the same. */ @kotlin.internal.InlineOnly public inline fun mod(other: ULong): ULong = this.toULong().mod(other) /** * Returns this value incremented by one. * * @sample samples.misc.Builtins.inc */ @kotlin.internal.InlineOnly public inline operator fun inc(): UByte = UByte(data.inc()) /** * Returns this value decremented by one. * * @sample samples.misc.Builtins.dec */ @kotlin.internal.InlineOnly public inline operator fun dec(): UByte = UByte(data.dec()) /** Creates a range from this value to the specified [other] value. */ @kotlin.internal.InlineOnly public inline operator fun rangeTo(other: UByte): UIntRange = UIntRange(this.toUInt(), other.toUInt()) /** * Creates a range from this value up to but excluding the specified [other] value. * * If the [other] value is less than or equal to `this` value, then the returned range is empty. */ @SinceKotlin("1.7") @ExperimentalStdlibApi @kotlin.internal.InlineOnly public inline operator fun rangeUntil(other: UByte): UIntRange = this.toUInt() until other.toUInt() /** Performs a bitwise AND operation between the two values. */ @kotlin.internal.InlineOnly public inline infix fun and(other: UByte): UByte = UByte(this.data and other.data) /** Performs a bitwise OR operation between the two values. */ @kotlin.internal.InlineOnly public inline infix fun or(other: UByte): UByte = UByte(this.data or other.data) /** Performs a bitwise XOR operation between the two values. */ @kotlin.internal.InlineOnly public inline infix fun xor(other: UByte): UByte = UByte(this.data xor other.data) /** Inverts the bits in this value. */ @kotlin.internal.InlineOnly public inline fun inv(): UByte = UByte(data.inv()) /** * Converts this [UByte] value to [Byte]. * * If this value is less than or equals to [Byte.MAX_VALUE], the resulting `Byte` value represents * the same numerical value as this `UByte`. Otherwise the result is negative. * * The resulting `Byte` value has the same binary representation as this `UByte` value. */ @kotlin.internal.InlineOnly public inline fun toByte(): Byte = data /** * Converts this [UByte] value to [Short]. * * The resulting `Short` value represents the same numerical value as this `UByte`. * * The least significant 8 bits of the resulting `Short` value are the same as the bits of this `UByte` value, * whereas the most significant 8 bits are filled with zeros. */ @kotlin.internal.InlineOnly public inline fun toShort(): Short = data.toShort() and 0xFF /** * Converts this [UByte] value to [Int]. * * The resulting `Int` value represents the same numerical value as this `UByte`. * * The least significant 8 bits of the resulting `Int` value are the same as the bits of this `UByte` value, * whereas the most significant 24 bits are filled with zeros. */ @kotlin.internal.InlineOnly public inline fun toInt(): Int = data.toInt() and 0xFF /** * Converts this [UByte] value to [Long]. * * The resulting `Long` value represents the same numerical value as this `UByte`. * * The least significant 8 bits of the resulting `Long` value are the same as the bits of this `UByte` value, * whereas the most significant 56 bits are filled with zeros. */ @kotlin.internal.InlineOnly public inline fun toLong(): Long = data.toLong() and 0xFF /** Returns this value. */ @kotlin.internal.InlineOnly public inline fun toUByte(): UByte = this /** * Converts this [UByte] value to [UShort]. * * The resulting `UShort` value represents the same numerical value as this `UByte`. * * The least significant 8 bits of the resulting `UShort` value are the same as the bits of this `UByte` value, * whereas the most significant 8 bits are filled with zeros. */ @kotlin.internal.InlineOnly public inline fun toUShort(): UShort = UShort(data.toShort() and 0xFF) /** * Converts this [UByte] value to [UInt]. * * The resulting `UInt` value represents the same numerical value as this `UByte`. * * The least significant 8 bits of the resulting `UInt` value are the same as the bits of this `UByte` value, * whereas the most significant 24 bits are filled with zeros. */ @kotlin.internal.InlineOnly public inline fun toUInt(): UInt = UInt(data.toInt() and 0xFF) /** * Converts this [UByte] value to [ULong]. * * The resulting `ULong` value represents the same numerical value as this `UByte`. * * The least significant 8 bits of the resulting `ULong` value are the same as the bits of this `UByte` value, * whereas the most significant 56 bits are filled with zeros. */ @kotlin.internal.InlineOnly public inline fun toULong(): ULong = ULong(data.toLong() and 0xFF) /** * Converts this [UByte] value to [Float]. * * The resulting `Float` value represents the same numerical value as this `UByte`. */ @kotlin.internal.InlineOnly public inline fun toFloat(): Float = this.toInt().toFloat() /** * Converts this [UByte] value to [Double]. * * The resulting `Double` value represents the same numerical value as this `UByte`. */ @kotlin.internal.InlineOnly public inline fun toDouble(): Double = this.toInt().toDouble() public override fun toString(): String = toInt().toString() } /** * Converts this [Byte] value to [UByte]. * * If this value is positive, the resulting `UByte` value represents the same numerical value as this `Byte`. * * The resulting `UByte` value has the same binary representation as this `Byte` value. */ @SinceKotlin("1.5") @WasExperimental(ExperimentalUnsignedTypes::class) @kotlin.internal.InlineOnly public inline fun Byte.toUByte(): UByte = UByte(this) /** * Converts this [Short] value to [UByte]. * * If this value is positive and less than or equals to [UByte.MAX_VALUE], the resulting `UByte` value represents * the same numerical value as this `Short`. * * The resulting `UByte` value is represented by the least significant 8 bits of this `Short` value. */ @SinceKotlin("1.5") @WasExperimental(ExperimentalUnsignedTypes::class) @kotlin.internal.InlineOnly public inline fun Short.toUByte(): UByte = UByte(this.toByte()) /** * Converts this [Int] value to [UByte]. * * If this value is positive and less than or equals to [UByte.MAX_VALUE], the resulting `UByte` value represents * the same numerical value as this `Int`. * * The resulting `UByte` value is represented by the least significant 8 bits of this `Int` value. */ @SinceKotlin("1.5") @WasExperimental(ExperimentalUnsignedTypes::class) @kotlin.internal.InlineOnly public inline fun Int.toUByte(): UByte = UByte(this.toByte()) /** * Converts this [Long] value to [UByte]. * * If this value is positive and less than or equals to [UByte.MAX_VALUE], the resulting `UByte` value represents * the same numerical value as this `Long`. * * The resulting `UByte` value is represented by the least significant 8 bits of this `Long` value. */ @SinceKotlin("1.5") @WasExperimental(ExperimentalUnsignedTypes::class) @kotlin.internal.InlineOnly public inline fun Long.toUByte(): UByte = UByte(this.toByte())