Scala Standard Library2.12.21 < Back
 

# Packages

-  package root

  This is the documentation for the Scala standard library.

  This is the documentation for the Scala standard library.

  #### Package structure

  The scala package contains core types like `Int`, `Float`, `Array` or `Option` which are accessible in all Scala compilation units without explicit qualification or imports.

  Notable packages include:

  - `scala.collection` and its sub-packages contain Scala's collections framework
    - `scala.collection.immutable` - Immutable, sequential data-structures such as `Vector`, `List`, `Range`, `HashMap` or `HashSet`
    - `scala.collection.mutable` - Mutable, sequential data-structures such as `ArrayBuffer`, `StringBuilder`, `HashMap` or `HashSet`
    - `scala.collection.concurrent` - Mutable, concurrent data-structures such as `TrieMap`
    - `scala.collection.parallel.immutable` - Immutable, parallel data-structures such as `ParVector`, `ParRange`, `ParHashMap` or `ParHashSet`
    - `scala.collection.parallel.mutable` - Mutable, parallel data-structures such as `ParArray`, `ParHashMap`, `ParTrieMap` or `ParHashSet`
  - `scala.concurrent` - Primitives for concurrent programming such as `Futures` and `Promises`
  - `scala.io` - Input and output operations
  - `scala.math` - Basic math functions and additional numeric types like `BigInt` and `BigDecimal`
  - `scala.sys` - Interaction with other processes and the operating system
  - `scala.util.matching` - Regular expressions

  Other packages exist. See the complete list on the right.

  Additional parts of the standard library are shipped as separate libraries. These include:

  - `scala.reflect` - Scala's reflection API (scala-reflect.jar)
  - `scala.xml` - XML parsing, manipulation, and serialization (scala-xml.jar)
  - `scala.swing` - A convenient wrapper around Java's GUI framework called Swing (scala-swing.jar)
  - `scala.util.parsing` - Parser combinators (scala-parser-combinators.jar)

  #### Automatic imports

  Identifiers in the scala package and the `scala.Predef` object are always in scope by default.

  Some of these identifiers are type aliases provided as shortcuts to commonly used classes. For example, `List` is an alias for `scala.collection.immutable.List`.

  Other aliases refer to classes provided by the underlying platform. For example, on the JVM, `String` is an alias for `java.lang.String`.

  Definition Classes
    root
-  package scala

  Core Scala types.

  Core Scala types. They are always available without an explicit import.

  Definition Classes
    root
-  package runtime
  Definition Classes
    scala
- AbstractFunction0
- AbstractFunction1
- AbstractFunction10
- AbstractFunction11
- AbstractFunction12
- AbstractFunction13
- AbstractFunction14
- AbstractFunction15
- AbstractFunction16
- AbstractFunction17
- AbstractFunction18
- AbstractFunction19
- AbstractFunction2
- AbstractFunction20
- AbstractFunction21
- AbstractFunction22
- AbstractFunction3
- AbstractFunction4
- AbstractFunction5
- AbstractFunction6
- AbstractFunction7
- AbstractFunction8
- AbstractFunction9
- AbstractPartialFunction
- ArrayCharSequence
- FractionalProxy
- IntegralProxy
- LambdaDeserializer
- LazyBoolean
- LazyByte
- LazyChar
- LazyDouble
- LazyFloat
- LazyInt
- LazyLong
- LazyRef
- LazyShort
- LazyUnit
- NonLocalReturnControl
- OrderedProxy
- RangedProxy
- RichBoolean
- RichByte
- RichChar
- RichDouble
- RichException
- RichFloat
- RichInt
- RichLong
- RichShort
- ScalaNumberProxy
- ScalaWholeNumberProxy
- SeqCharSequence
- StringFormat
- Tuple2Zipped
- Tuple3Zipped
- ZippedTraversable2
- ZippedTraversable3

c

scala.runtime

# RichInt 

###

#### final class RichInt extends AnyVal with ScalaNumberProxy[Int] with RangedProxy[Int]

Source
  RichInt.scala

Linear Supertypes
RangedProxy[Int], ScalaNumberProxy[Int], OrderedProxy[Int], math.Ordered[Int], Comparable[Int], Typed[Int], Proxy, ScalaNumericAnyConversions, AnyVal, Any
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. RichInt
2. RangedProxy
3. ScalaNumberProxy
4. OrderedProxy
5. Ordered
6. Comparable
7. Typed
8. Proxy
9. ScalaNumericAnyConversions
10. AnyVal
11. Any

Implicitly

1. by any2stringadd
2. by StringFormat
3. by Ensuring
4. by ArrowAssoc

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Instance Constructors

1.  new RichInt(self: Int)

### Type Members

1.  type ResultWithoutStep = collection.immutable.Range
   Definition Classes
     RichInt → RangedProxy

### Value Members

1.  final def !=(arg0: Any): Boolean

   Test two objects for inequality.

   Test two objects for inequality.

   returns

     `true` if !(this == that), false otherwise.

   Definition Classes
     Any
2.  final def ##(): Int

   Equivalent to `x.hashCode` except for boxed numeric types and `null`.

   Equivalent to `x.hashCode` except for boxed numeric types and `null`. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them. For `null` returns a hashcode where `null.hashCode` throws a `NullPointerException`.

   returns

     a hash value consistent with ==

   Definition Classes
     Any
3.  def +(other: String): String
   Implicit
     This member is added by an implicit conversion from RichInt to any2stringadd[RichInt] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
4.  def ->[B](y: B): (RichInt, B)
   Implicit
     This member is added by an implicit conversion from RichInt to ArrowAssoc[RichInt] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @inline()
5.  def <(that: Int): Boolean

   Returns true if `this` is less than `that`

   Returns true if `this` is less than `that`

   Definition Classes
     Ordered
6.  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`.

   Definition Classes
     Ordered
7.  final def ==(arg0: Any): Boolean

   Test two objects for equality.

   Test two objects for equality. The expression `x == that` is equivalent to `if (x eq null) that eq null else x.equals(that)`.

   returns

     `true` if the receiver object is equivalent to the argument; `false` otherwise.

   Definition Classes
     Any
8.  def >(that: Int): Boolean

   Returns true if `this` is greater than `that`.

   Returns true if `this` is greater than `that`.

   Definition Classes
     Ordered
9.  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`.

   Definition Classes
     Ordered
10.  def abs: Int

    Returns the absolute value of `this`.

    Returns the absolute value of `this`.

    Definition Classes
      RichInt → ScalaNumberProxy
11.  final def asInstanceOf[T0]: T0

    Cast the receiver object to be of type `T0`.

    Cast the receiver object to be of type `T0`.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression `1.asInstanceOf[String]` will throw a `ClassCastException` at runtime, while the expression `List(1).asInstanceOf[List[String]]` will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested type.

    returns

      the receiver object.

    Definition Classes
      Any
    Exceptions thrown

      `ClassCastException` if the receiver object is not an instance of the erasure of type `T0`.

12.  def byteValue(): Byte
    Definition Classes
      RichInt → ScalaNumberProxy → ScalaNumericAnyConversions
13.  def compare(y: Int): Int

    Result of comparing `this` with operand `that`.

    Result of comparing `this` with operand `that`.

    Implement this method to determine how instances of A will be sorted.

    Returns `x` where:

    - `x < 0` when `this < that`
    - `x == 0` when `this == that`
    - `x > 0` when `this > that`
    Definition Classes
      OrderedProxy → Ordered
14.  def compareTo(that: Int): Int

    Result of comparing `this` with operand `that`.

    Result of comparing `this` with operand `that`.

    Definition Classes
      Ordered → Comparable
15.  def doubleValue(): Double
    Definition Classes
      RichInt → ScalaNumberProxy → ScalaNumericAnyConversions
16.  def ensuring(cond: (RichInt) ⇒ Boolean, msg: ⇒ Any): RichInt
    Implicit
      This member is added by an implicit conversion from RichInt to Ensuring[RichInt] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
17.  def ensuring(cond: (RichInt) ⇒ Boolean): RichInt
    Implicit
      This member is added by an implicit conversion from RichInt to Ensuring[RichInt] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
18.  def ensuring(cond: Boolean, msg: ⇒ Any): RichInt
    Implicit
      This member is added by an implicit conversion from RichInt to Ensuring[RichInt] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
19.  def ensuring(cond: Boolean): RichInt
    Implicit
      This member is added by an implicit conversion from RichInt to Ensuring[RichInt] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
20.  def floatValue(): Float
    Definition Classes
      RichInt → ScalaNumberProxy → ScalaNumericAnyConversions
21.  def getClass(): Class[_ <: AnyVal]

    Returns the runtime class representation of the object.

    Returns the runtime class representation of the object.

    returns

      a class object corresponding to the runtime type of the receiver.

    Definition Classes
      AnyVal → Any
22.  def intValue(): Int
    Definition Classes
      RichInt → ScalaNumberProxy → ScalaNumericAnyConversions
23.  final def isInstanceOf[T0]: Boolean

    Test whether the dynamic type of the receiver object is `T0`.

    Test whether the dynamic type of the receiver object is `T0`.

    Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression `1.isInstanceOf[String]` will return `false`, while the expression `List(1).isInstanceOf[List[String]]` will return `true`. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the specified type.

    returns

      `true` if the receiver object is an instance of erasure of type `T0`; `false` otherwise.

    Definition Classes
      Any
24.  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`.

    Definition Classes
      ScalaNumericAnyConversions
25.  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`.

    Definition Classes
      ScalaNumericAnyConversions
26.  def isValidInt: Boolean

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

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

    Definition Classes
      RichInt → ScalaNumericAnyConversions
27.  def isValidLong: Boolean
28.  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`.

    Definition Classes
      ScalaNumericAnyConversions
29.  def longValue(): Long
    Definition Classes
      RichInt → ScalaNumberProxy → ScalaNumericAnyConversions
30.  def max(that: Int): Int

    Returns `this` if `this > that` or `that` otherwise.

    Returns `this` if `this > that` or `that` otherwise.

    Definition Classes
      RichInt → ScalaNumberProxy
31.  def min(that: Int): Int

    Returns `this` if `this < that` or `that` otherwise.

    Returns `this` if `this < that` or `that` otherwise.

    Definition Classes
      RichInt → ScalaNumberProxy
32.  def num: IntIsIntegral.type
    Attributes
      protected
    Definition Classes
      RichInt → ScalaNumberProxy
33.  def ord: math.Ordering.Int.type
    Attributes
      protected
    Definition Classes
      RichInt → OrderedProxy
34.  val self: Int
    Definition Classes
      RichInt → Typed → Proxy
35.  def shortValue(): Short
    Definition Classes
      RichInt → ScalaNumberProxy → ScalaNumericAnyConversions
36.  def signum: Int

    Returns the signum of `this`.

    Returns the signum of `this`.

    Definition Classes
      RichInt → ScalaNumberProxy
37.  def to(end: Int, step: Int): Inclusive

    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`.

    Definition Classes
      RichInt → RangedProxy
38.  def to(end: Int): Inclusive

    end

      The final bound of the range to make.

    returns

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

    Definition Classes
      RichInt → RangedProxy
39.  def toBinaryString: String
40.  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.

    Definition Classes
      ScalaNumericAnyConversions
41.  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.

    Definition Classes
      ScalaNumericAnyConversions
42.  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.

    Definition Classes
      ScalaNumericAnyConversions
43.  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.

    Definition Classes
      ScalaNumericAnyConversions
44.  def toHexString: String
45.  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.

    Definition Classes
      ScalaNumericAnyConversions
46.  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.

    Definition Classes
      ScalaNumericAnyConversions
47.  def toOctalString: String
48.  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.

    Definition Classes
      ScalaNumericAnyConversions
49.  def toString(): String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

      a string representation of the object.

    Definition Classes
      Proxy → Any
50.  def underlying(): AnyRef
    Definition Classes
      ScalaNumberProxy → ScalaNumericAnyConversions
51.  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.

    Attributes
      protected
    Definition Classes
      ScalaNumericAnyConversions
52.  def unifiedPrimitiveHashcode(): Int
    Attributes
      protected
    Definition Classes
      ScalaNumericAnyConversions
53.  def until(end: Int, step: Int): collection.immutable.Range

    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`.

    Definition Classes
      RichInt → RangedProxy
54.  def until(end: Int): collection.immutable.Range

    end

      The final bound of the range to make.

    returns

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

    Definition Classes
      RichInt → RangedProxy
55.  def →[B](y: B): (RichInt, B)
    Implicit
      This member is added by an implicit conversion from RichInt to ArrowAssoc[RichInt] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
      ArrowAssoc

### Deprecated Value Members

1.  def formatted(fmtstr: String): String

   Returns string formatted according to given `format` string.

   Returns string formatted according to given `format` string. Format strings are as for `String.format` (@see java.lang.String.format).

   Implicit
     This member is added by an implicit conversion from RichInt to Predef.StringFormat[RichInt] performed by method StringFormat in scala.Predef.
   Definition Classes
     StringFormat
   Annotations
     @deprecated @inline()
   Deprecated

     (Since version 2.12.16) Use `formatString.format(value)` instead of `value.formatted(formatString)`, or use the `f""` string interpolator. In Java 15 and later, `formatted` resolves to the new method in String which has reversed parameters.

2.  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`.

   returns

     `true` if this number has no decimal component, `false` otherwise.

   Definition Classes
     RichInt → ScalaNumericAnyConversions
   Annotations
     @deprecated
   Deprecated

     (Since version 2.12.15) isWhole on an integer type is always true

3.  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`.

   Annotations
     @deprecated
   Deprecated

     (Since version 2.11.0) this is an integer type; there is no reason to round it. Perhaps you meant to call this on a floating-point value?

### Inherited from RangedProxy[Int]

### Inherited from ScalaNumberProxy[Int]

### Inherited from OrderedProxy[Int]

### Inherited from math.Ordered[Int]

### Inherited from Comparable[Int]

### Inherited from Typed[Int]

### Inherited from Proxy

### Inherited from ScalaNumericAnyConversions

### Inherited from AnyVal

### Inherited from Any

### Inherited by implicit conversion any2stringadd from RichInt to any2stringadd[RichInt]

### Inherited by implicit conversion StringFormat from RichInt to Predef.StringFormat[RichInt]

### Inherited by implicit conversion Ensuring from RichInt to Ensuring[RichInt]

### Inherited by implicit conversion ArrowAssoc from RichInt to ArrowAssoc[RichInt]

### Ungrouped