Scala 3/API/scala.runtime/RichInt

RichInt

final class RichInt(val self: Int) extends AnyVal with ScalaNumberProxy[Int] with RangedProxy[Int]
trait Ordered[Int]
class Object
trait Typed[Int]
trait Proxy
class AnyVal
trait Matchable
class Any

Type members

Types

Value members

Concrete methods

override def abs: Int
Definition Classes
override def byteValue: Byte
override def intValue: Int
override def isValidInt: Boolean
Definition Classes
def isWhole: Boolean

Returns true if this number has no decimal component.

Returns true if this number has no decimal component. Always true for RichInt.

override def longValue: Long
override def max(that: Int): Int
Definition Classes
override def min(that: Int): Int
Definition Classes
def to(end: Int): Inclusive
Value Params
end

The final bound of the range to make.

Returns

A scala.collection.immutable.Range from this up to and including end.

def to(end: Int, step: Int): Inclusive
Value Params
end

The final bound of the range to make.

step

The number to increase by for each step of the range.

Returns

A scala.collection.immutable.Range from this up to and including end.

def until(end: Int): Range
Value Params
end

The final bound of the range to make.

Returns

A scala.collection.immutable.Range from this up to but not including end.

def until(end: Int, step: Int): Range
Value Params
end

The final bound of the range to make.

step

The number to increase by for each step of the range.

Returns

A scala.collection.immutable.Range from this up to but not including end.

Deprecated methods

@deprecated("this is an integer type; there is no reason to round it. Perhaps you meant to call this on a floating-point value?", "2.11.0")
def round: Int

There is no reason to round an Int, but this method is provided to avoid accidental loss of precision from a detour through Float.

There is no reason to round an Int, but this method is provided to avoid accidental loss of precision from a detour through Float.

Deprecated

Inherited methods

def <(that: Int): Boolean

Returns true if this is less than that

Returns true if this is less than that

Inherited from
Ordered
def <=(that: Int): Boolean

Returns true if this is less than or equal to that.

Returns true if this is less than or equal to that.

Inherited from
Ordered
def >(that: Int): Boolean

Returns true if this is greater than that.

Returns true if this is greater than that.

Inherited from
Ordered
def >=(that: Int): Boolean

Returns true if this is greater than or equal to that.

Returns true if this is greater than or equal to that.

Inherited from
Ordered
def compare(y: Int): Int
Inherited from
OrderedProxy
def compareTo(that: Int): Int

Result of comparing this with operand that.

Result of comparing this with operand that.

Inherited from
Ordered
override def equals(that: Any): Boolean
Definition Classes
Proxy -> Any
Inherited from
Proxy
override def hashCode: Int
Definition Classes
Proxy -> Any
Inherited from
Proxy
def isValidByte: Boolean

Returns true iff this has a zero fractional part, and is within the range of scala.Byte MinValue and MaxValue; otherwise returns false.

Returns true iff this has a zero fractional part, and is within the range of scala.Byte MinValue and MaxValue; otherwise returns false.

Inherited from
ScalaNumericAnyConversions
def isValidChar: Boolean

Returns true iff this has a zero fractional part, and is within the range of scala.Char MinValue and MaxValue; otherwise returns false.

Returns true iff this has a zero fractional part, and is within the range of scala.Char MinValue and MaxValue; otherwise returns false.

Inherited from
ScalaNumericAnyConversions
def isValidShort: Boolean

Returns true iff this has a zero fractional part, and is within the range of scala.Short MinValue and MaxValue; otherwise returns false.

Returns true iff this has a zero fractional part, and is within the range of scala.Short MinValue and MaxValue; otherwise returns false.

Inherited from
ScalaNumericAnyConversions
def sign: Int

Returns the sign of this.

Returns the sign of this. zero if the argument is zero, -zero if the argument is -zero, one if the argument is greater than zero, -one if the argument is less than zero, and NaN if the argument is NaN where applicable.

Inherited from
ScalaNumberProxy
def toByte: Byte

Returns the value of this as a scala.Byte.

Returns the value of this as a scala.Byte. This may involve rounding or truncation.

Inherited from
ScalaNumericAnyConversions
def toChar: Char

Returns the value of this as a scala.Char.

Returns the value of this as a scala.Char. This may involve rounding or truncation.

Inherited from
ScalaNumericAnyConversions
def toDouble: Double

Returns the value of this as a scala.Double.

Returns the value of this as a scala.Double. This may involve rounding or truncation.

Inherited from
ScalaNumericAnyConversions
def toFloat: Float

Returns the value of this as a scala.Float.

Returns the value of this as a scala.Float. This may involve rounding or truncation.

Inherited from
ScalaNumericAnyConversions
def toInt: Int

Returns the value of this as an scala.Int.

Returns the value of this as an scala.Int. This may involve rounding or truncation.

Inherited from
ScalaNumericAnyConversions
def toLong: Long

Returns the value of this as a scala.Long.

Returns the value of this as a scala.Long. This may involve rounding or truncation.

Inherited from
ScalaNumericAnyConversions
def toShort: Short

Returns the value of this as a scala.Short.

Returns the value of this as a scala.Short. This may involve rounding or truncation.

Inherited from
ScalaNumericAnyConversions
override def toString: String
Definition Classes
Proxy -> Any
Inherited from
Proxy
protected def unifiedPrimitiveEquals(x: Any): Boolean

Should only be called after all known non-primitive types have been excluded.

Should only be called after all known non-primitive types have been excluded. This method won't dispatch anywhere else after checking against the primitives to avoid infinite recursion between equals and this on unknown "Number" variants.

Additionally, this should only be called if the numeric type is happy to be converted to Long, Float, and Double. If for instance a BigInt much larger than the Long range is sent here, it will claim equality with whatever Long is left in its lower 64 bits. Or a BigDecimal with more precision than Double can hold: same thing. There's no way given the interface available here to prevent this error.

Inherited from
ScalaNumericAnyConversions

Deprecated and Inherited methods

@deprecated("use `sign` method instead", since = "2.13.0")
def signum: Int

Returns the signum of this.

Returns the signum of this.

Deprecated
[Since version 2.13.0]
Inherited from
ScalaNumberProxy

Concrete fields

val self: Int