trait Integral[T] extends Numeric[T]
- Alphabetic
- By Inheritance
- Integral
- Numeric
- Ordering
- PartialOrdering
- Equiv
- Serializable
- Comparator
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Type Members
- class IntegralOps extends NumericOps
- class NumericOps extends AnyRef
- Definition Classes
- Numeric
- class OrderingOps extends AnyRef
This inner class defines comparison operators available for
T
.This inner class defines comparison operators available for
T
.- Definition Classes
- Ordering
Abstract Value Members
- abstract def compare(x: T, y: T): Int
Returns an integer whose sign communicates how x compares to y.
Returns an integer whose sign communicates how x compares to y.
The result sign has the following meaning:
- negative if x < y
- positive if x > y
- zero otherwise (if x == y)
- Definition Classes
- Ordering → Comparator
- abstract def fromInt(x: Int): T
- Definition Classes
- Numeric
- abstract def minus(x: T, y: T): T
- Definition Classes
- Numeric
- abstract def negate(x: T): T
- Definition Classes
- Numeric
- abstract def parseString(str: String): Option[T]
- Definition Classes
- Numeric
- abstract def plus(x: T, y: T): T
- Definition Classes
- Numeric
- abstract def quot(x: T, y: T): T
- abstract def rem(x: T, y: T): T
- abstract def times(x: T, y: T): T
- Definition Classes
- Numeric
- abstract def toDouble(x: T): Double
- Definition Classes
- Numeric
- abstract def toFloat(x: T): Float
- Definition Classes
- Numeric
- abstract def toInt(x: T): Int
- Definition Classes
- Numeric
- abstract def toLong(x: T): Long
- Definition Classes
- Numeric
Concrete Value Members
- final def !=(arg0: Any): Boolean
Test two objects for inequality.
Test two objects for inequality.
- returns
true
if !(this == that), false otherwise.
- Definition Classes
- AnyRef → Any
- final def ##: Int
Equivalent to
x.hashCode
except for boxed numeric types andnull
.Equivalent to
x.hashCode
except for boxed numeric types andnull
. 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. Fornull
returns a hashcode wherenull.hashCode
throws aNullPointerException
.- returns
a hash value consistent with ==
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from Integral[T] toany2stringadd[Integral[T]] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (Integral[T], B)
- Implicit
- This member is added by an implicit conversion from Integral[T] toArrowAssoc[Integral[T]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
The expression
x == that
is equivalent toif (x eq null) that eq null else x.equals(that)
.The expression
x == that
is equivalent toif (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
- AnyRef → Any
- def abs(x: T): T
- Definition Classes
- Numeric
- 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 aClassCastException
at runtime, while the expressionList(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 typeT0
.
- def clone(): AnyRef
Create a copy of the receiver object.
Create a copy of the receiver object.
The default implementation of the
clone
method is platform dependent.- returns
a copy of the receiver object.
- def ensuring(cond: (Integral[T]) => Boolean, msg: => Any): Integral[T]
- Implicit
- This member is added by an implicit conversion from Integral[T] toEnsuring[Integral[T]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (Integral[T]) => Boolean): Integral[T]
- Implicit
- This member is added by an implicit conversion from Integral[T] toEnsuring[Integral[T]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): Integral[T]
- Implicit
- This member is added by an implicit conversion from Integral[T] toEnsuring[Integral[T]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): Integral[T]
- Implicit
- This member is added by an implicit conversion from Integral[T] toEnsuring[Integral[T]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
Tests whether the argument (
that
) is a reference to the receiver object (this
).Tests whether the argument (
that
) is a reference to the receiver object (this
).The
eq
method implements an equivalence relation on non-null instances ofAnyRef
, and has three additional properties:- It is consistent: for any non-null instances
x
andy
of typeAnyRef
, multiple invocations ofx.eq(y)
consistently returnstrue
or consistently returnsfalse
. - For any non-null instance
x
of typeAnyRef
,x.eq(null)
andnull.eq(x)
returnsfalse
. null.eq(null)
returnstrue
.
When overriding the
equals
orhashCode
methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2
), they should be equal to each other (o1 == o2
) and they should hash to the same value (o1.hashCode == o2.hashCode
).- returns
true
if the argument is a reference to the receiver object;false
otherwise.
- Definition Classes
- AnyRef
- It is consistent: for any non-null instances
- def equals(arg0: AnyRef): Boolean
The equality method for reference types.
- def equiv(x: T, y: T): Boolean
Return true if
x
==y
in the ordering.Return true if
x
==y
in the ordering.- Definition Classes
- Ordering → PartialOrdering → Equiv
- def finalize(): Unit
Called by the garbage collector on the receiver object when there are no more references to the object.
Called by the garbage collector on the receiver object when there are no more references to the object.
The details of when and if the
finalize
method is invoked, as well as the interaction betweenfinalize
and non-local returns and exceptions, are all platform dependent.- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- Note
not specified by SLS as a member of AnyRef
- 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 forString.format
(@see java.lang.String.format).- Implicit
- This member is added by an implicit conversion from Integral[T] toStringFormat[Integral[T]] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
- final def getClass(): Class[_ <: AnyRef]
Returns the runtime class representation of the object.
- def gt(x: T, y: T): Boolean
Return true if
x
>y
in the ordering.Return true if
x
>y
in the ordering.- Definition Classes
- Ordering → PartialOrdering
- def gteq(x: T, y: T): Boolean
Return true if
x
>=y
in the ordering.Return true if
x
>=y
in the ordering.- Definition Classes
- Ordering → PartialOrdering
- def hashCode(): Int
The hashCode method for reference types.
- 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 returnfalse
, while the expressionList(1).isInstanceOf[List[String]]
will returntrue
. 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 typeT0
;false
otherwise.
- Definition Classes
- Any
- def isReverseOf(other: Ordering[_]): Boolean
Returns whether or not the other ordering is the opposite ordering of this one.
- def lt(x: T, y: T): Boolean
Return true if
x
<y
in the ordering.Return true if
x
<y
in the ordering.- Definition Classes
- Ordering → PartialOrdering
- def lteq(x: T, y: T): Boolean
Return true if
x
<=y
in the ordering.Return true if
x
<=y
in the ordering.- Definition Classes
- Ordering → PartialOrdering
- def max[U <: T](x: U, y: U): U
Return
x
ifx
>=y
, otherwisey
.Return
x
ifx
>=y
, otherwisey
.- Definition Classes
- Ordering
- def min[U <: T](x: U, y: U): U
Return
x
ifx
<=y
, otherwisey
.Return
x
ifx
<=y
, otherwisey
.- Definition Classes
- Ordering
- implicit def mkNumericOps(lhs: T): IntegralOps
- implicit def mkOrderingOps(lhs: T): OrderingOps
This implicit method augments
T
with the comparison operators defined inscala.math.Ordering.Ops
.This implicit method augments
T
with the comparison operators defined inscala.math.Ordering.Ops
.- Definition Classes
- Ordering
- final def ne(arg0: AnyRef): Boolean
Equivalent to
!(this eq that)
.Equivalent to
!(this eq that)
.- returns
true
if the argument is not a reference to the receiver object;false
otherwise.
- Definition Classes
- AnyRef
- final def notify(): Unit
Wakes up a single thread that is waiting on the receiver object's monitor.
Wakes up a single thread that is waiting on the receiver object's monitor.
- Definition Classes
- AnyRef
- Annotations
- @native()
- Note
not specified by SLS as a member of AnyRef
- final def notifyAll(): Unit
Wakes up all threads that are waiting on the receiver object's monitor.
Wakes up all threads that are waiting on the receiver object's monitor.
- Definition Classes
- AnyRef
- Annotations
- @native()
- Note
not specified by SLS as a member of AnyRef
- def on[U](f: (U) => T): Ordering[U]
Given f, a function from U into T, creates an Ordering[U] whose compare function is equivalent to:
Given f, a function from U into T, creates an Ordering[U] whose compare function is equivalent to:
def compare(x:U, y:U) = Ordering[T].compare(f(x), f(y))
- Definition Classes
- Ordering
- def one: T
- Definition Classes
- Numeric
- def orElse(other: Ordering[T]): Ordering[T]
Creates an Ordering[T] whose compare function returns the result of this Ordering's compare function, if it is non-zero, or else the result of
other
s compare function.Creates an Ordering[T] whose compare function returns the result of this Ordering's compare function, if it is non-zero, or else the result of
other
s compare function.- other
an Ordering to use if this Ordering returns zero
- Definition Classes
- Ordering
case class Pair(a: Int, b: Int) val pairOrdering = Ordering.by[Pair, Int](_.a) .orElse(Ordering.by[Pair, Int](_.b))
Example: - def orElseBy[S](f: (T) => S)(implicit ord: Ordering[S]): Ordering[T]
Given f, a function from T into S, creates an Ordering[T] whose compare function returns the result of this Ordering's compare function, if it is non-zero, or else a result equivalent to:
Given f, a function from T into S, creates an Ordering[T] whose compare function returns the result of this Ordering's compare function, if it is non-zero, or else a result equivalent to:
Ordering[S].compare(f(x), f(y))
This function is equivalent to passing the result of
Ordering.by(f)
toorElse
.- Definition Classes
- Ordering
case class Pair(a: Int, b: Int) val pairOrdering = Ordering.by[Pair, Int](_.a) .orElseBy[Int](_.b)
Example: - def reverse: Ordering[T]
Return the opposite ordering of this one.
Return the opposite ordering of this one.
Implementations overriding this method MUST override isReverseOf as well if they change the behavior at all (for example, caching does not require overriding it).
- Definition Classes
- Ordering → PartialOrdering
- def reversed(): Comparator[T]
- Definition Classes
- Comparator
- def sign(x: T): T
- Definition Classes
- Numeric
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def thenComparing[U <: Comparable[_ >: U <: AnyRef]](arg0: java.util.function.Function[_ >: T <: AnyRef, _ <: U]): Comparator[T]
- Definition Classes
- Comparator
- def thenComparing[U <: AnyRef](arg0: java.util.function.Function[_ >: T <: AnyRef, _ <: U], arg1: Comparator[_ >: U <: AnyRef]): Comparator[T]
- Definition Classes
- Comparator
- def thenComparing(arg0: Comparator[_ >: T <: AnyRef]): Comparator[T]
- Definition Classes
- Comparator
- def thenComparingDouble(arg0: ToDoubleFunction[_ >: T <: AnyRef]): Comparator[T]
- Definition Classes
- Comparator
- def thenComparingInt(arg0: ToIntFunction[_ >: T <: AnyRef]): Comparator[T]
- Definition Classes
- Comparator
- def thenComparingLong(arg0: ToLongFunction[_ >: T <: AnyRef]): Comparator[T]
- Definition Classes
- Comparator
- def toString(): String
Creates a String representation of this object.
Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.
- returns
a String representation of the object.
- Definition Classes
- AnyRef → Any
- def tryCompare(x: T, y: T): Some[Int]
Returns whether a comparison between
x
andy
is defined, and if so the result ofcompare(x, y)
.Returns whether a comparison between
x
andy
is defined, and if so the result ofcompare(x, y)
.- Definition Classes
- Ordering → PartialOrdering
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- def zero: T
- Definition Classes
- Numeric
Deprecated Value Members
- def signum(x: T): Int
- Definition Classes
- Numeric
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) use
sign
method instead
- def →[B](y: B): (Integral[T], B)
- Implicit
- This member is added by an implicit conversion from Integral[T] toArrowAssoc[Integral[T]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->
instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
This is the documentation for the Scala standard library.
Package structure
The scala package contains core types like
Int
,Float
,Array
orOption
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 frameworkscala.collection.immutable
- Immutable, sequential data-structures such asVector
,List
,Range
,HashMap
orHashSet
scala.collection.mutable
- Mutable, sequential data-structures such asArrayBuffer
,StringBuilder
,HashMap
orHashSet
scala.collection.concurrent
- Mutable, concurrent data-structures such asTrieMap
scala.concurrent
- Primitives for concurrent programming such asFutures
andPromises
scala.io
- Input and output operationsscala.math
- Basic math functions and additional numeric types likeBigInt
andBigDecimal
scala.sys
- Interaction with other processes and the operating systemscala.util.matching
- Regular expressionsOther 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.collection.parallel
- Parallel collections (scala-parallel-collections.jar)scala.util.parsing
- Parser combinators (scala-parser-combinators.jar)scala.swing
- A convenient wrapper around Java's GUI framework called Swing (scala-swing.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 forscala.collection.immutable.List
.Other aliases refer to classes provided by the underlying platform. For example, on the JVM,
String
is an alias forjava.lang.String
.