trait ScalaWholeNumberProxy[T] extends ScalaNumberProxy[T]
- Alphabetic
- By Inheritance
- ScalaWholeNumberProxy
- ScalaNumberProxy
- OrderedProxy
- Ordered
- Comparable
- Typed
- Proxy
- ScalaNumericAnyConversions
- Any
- by orderingToOrdered
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
getClass(): Class[_]
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
- Any
-
implicit abstract
def
num: Numeric[T]
- Attributes
- protected
- Definition Classes
- ScalaNumberProxy
-
abstract
def
ord: Ordering[T]
- Attributes
- protected
- Definition Classes
- OrderedProxy
- abstract def self: T
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
Test two objects for inequality.
Test two objects for inequality.
- returns
trueif !(this == that), false otherwise.
- Definition Classes
- Any
-
final
def
##(): Int
Equivalent to
x.hashCodeexcept for boxed numeric types andnull.Equivalent to
x.hashCodeexcept 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. Fornullreturns a hashcode wherenull.hashCodethrows aNullPointerException.- returns
a hash value consistent with ==
- Definition Classes
- Any
-
def
+(other: String): String
- Implicit
- This member is added by an implicit conversion from ScalaWholeNumberProxy[T] to any2stringadd[ScalaWholeNumberProxy[T]] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
->[B](y: B): (ScalaWholeNumberProxy[T], B)
- Implicit
- This member is added by an implicit conversion from ScalaWholeNumberProxy[T] to ArrowAssoc[ScalaWholeNumberProxy[T]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
-
def
<(that: T): Boolean
Returns true if
thisis less thanthatReturns true if
thisis less thanthat- Definition Classes
- Ordered
-
def
<=(that: T): Boolean
Returns true if
thisis less than or equal tothat.Returns true if
thisis less than or equal tothat.- Definition Classes
- Ordered
-
final
def
==(arg0: Any): Boolean
Test two objects for equality.
Test two objects for equality. The expression
x == thatis equivalent toif (x eq null) that eq null else x.equals(that).- returns
trueif the receiver object is equivalent to the argument;falseotherwise.
- Definition Classes
- Any
-
def
>(that: T): Boolean
Returns true if
thisis greater thanthat.Returns true if
thisis greater thanthat.- Definition Classes
- Ordered
-
def
>=(that: T): Boolean
Returns true if
thisis greater than or equal tothat.Returns true if
thisis greater than or equal tothat.- Definition Classes
- Ordered
-
def
abs: T
Returns the absolute value of
this.Returns the absolute value of
this.- Definition Classes
- ScalaNumberProxy
-
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 aClassCastExceptionat 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
ClassCastExceptionif the receiver object is not an instance of the erasure of typeT0.
-
def
byteValue(): Byte
- Definition Classes
- ScalaNumberProxy → ScalaNumericAnyConversions
-
def
compare(y: T): Int
Result of comparing
thiswith operandthat.Result of comparing
thiswith operandthat.Implement this method to determine how instances of A will be sorted.
Returns
xwhere:x < 0whenthis < thatx == 0whenthis == thatx > 0whenthis > that
- Definition Classes
- OrderedProxy → Ordered
-
def
compareTo(that: T): Int
Result of comparing
thiswith operandthat.Result of comparing
thiswith operandthat.- Definition Classes
- Ordered → Comparable
-
def
doubleValue(): Double
- Definition Classes
- ScalaNumberProxy → ScalaNumericAnyConversions
-
def
ensuring(cond: (ScalaWholeNumberProxy[T]) ⇒ Boolean, msg: ⇒ Any): ScalaWholeNumberProxy[T]
- Implicit
- This member is added by an implicit conversion from ScalaWholeNumberProxy[T] to Ensuring[ScalaWholeNumberProxy[T]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (ScalaWholeNumberProxy[T]) ⇒ Boolean): ScalaWholeNumberProxy[T]
- Implicit
- This member is added by an implicit conversion from ScalaWholeNumberProxy[T] to Ensuring[ScalaWholeNumberProxy[T]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): ScalaWholeNumberProxy[T]
- Implicit
- This member is added by an implicit conversion from ScalaWholeNumberProxy[T] to Ensuring[ScalaWholeNumberProxy[T]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): ScalaWholeNumberProxy[T]
- Implicit
- This member is added by an implicit conversion from ScalaWholeNumberProxy[T] to Ensuring[ScalaWholeNumberProxy[T]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
equals(that: Any): Boolean
Compares the receiver object (
this) with the argument object (that) for equivalence.Compares the receiver object (
this) with the argument object (that) for equivalence.Any implementation of this method should be an equivalence relation:
- It is reflexive: for any instance
xof typeAny,x.equals(x)should returntrue. - It is symmetric: for any instances
xandyof typeAny,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any instances
x,y, andzof typeAnyifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue.
If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override
hashCodeto ensure that objects which are "equal" (o1.equals(o2)returnstrue) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).- that
the object to compare against this object for equality.
- returns
trueif the receiver object is equivalent to the argument;falseotherwise.
- It is reflexive: for any instance
-
def
floatValue(): Float
- Definition Classes
- ScalaNumberProxy → ScalaNumericAnyConversions
-
def
hashCode(): Int
Calculate a hash code value for the object.
Calculate a hash code value for the object.
The default hashing algorithm is platform dependent.
Note that it is allowed for two objects to have identical hash codes (
o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2)returnsfalse). A degenerate implementation could always return0. However, it is required that if two objects are equal (o1.equals(o2)returnstrue) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with theequalsmethod.- returns
the hash code value for this object.
-
def
intValue(): Int
- Definition Classes
- ScalaNumberProxy → ScalaNumericAnyConversions
-
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
trueif the receiver object is an instance of erasure of typeT0;falseotherwise.
- Definition Classes
- Any
-
def
isValidByte: Boolean
Returns
trueiff this has a zero fractional part, and is within the range of scala.Byte MinValue and MaxValue; otherwise returnsfalse.Returns
trueiff this has a zero fractional part, and is within the range of scala.Byte MinValue and MaxValue; otherwise returnsfalse.- Definition Classes
- ScalaNumericAnyConversions
-
def
isValidChar: Boolean
Returns
trueiff this has a zero fractional part, and is within the range of scala.Char MinValue and MaxValue; otherwise returnsfalse.Returns
trueiff this has a zero fractional part, and is within the range of scala.Char MinValue and MaxValue; otherwise returnsfalse.- Definition Classes
- ScalaNumericAnyConversions
-
def
isValidInt: Boolean
Returns
trueiff this has a zero fractional part, and is within the range of scala.Int MinValue and MaxValue; otherwise returnsfalse.Returns
trueiff this has a zero fractional part, and is within the range of scala.Int MinValue and MaxValue; otherwise returnsfalse.- Definition Classes
- ScalaNumericAnyConversions
-
def
isValidShort: Boolean
Returns
trueiff this has a zero fractional part, and is within the range of scala.Short MinValue and MaxValue; otherwise returnsfalse.Returns
trueiff this has a zero fractional part, and is within the range of scala.Short MinValue and MaxValue; otherwise returnsfalse.- Definition Classes
- ScalaNumericAnyConversions
-
def
longValue(): Long
- Definition Classes
- ScalaNumberProxy → ScalaNumericAnyConversions
-
def
max(that: T): T
Returns
thisifthis > thatorthatotherwise.Returns
thisifthis > thatorthatotherwise.- Definition Classes
- ScalaNumberProxy
-
def
min(that: T): T
Returns
thisifthis < thatorthatotherwise.Returns
thisifthis < thatorthatotherwise.- Definition Classes
- ScalaNumberProxy
-
def
shortValue(): Short
- Definition Classes
- ScalaNumberProxy → ScalaNumericAnyConversions
-
def
signum: Int
Returns the signum of
this.Returns the signum of
this.- Definition Classes
- 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.
- Definition Classes
- 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.
- Definition Classes
- 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.
- Definition Classes
- 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.
- Definition Classes
- 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.
- Definition Classes
- 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.
- Definition Classes
- 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.
- Definition Classes
- ScalaNumericAnyConversions
-
def
toString(): String
Returns a string representation of the object.
-
def
underlying(): AnyRef
- Definition Classes
- ScalaNumberProxy → ScalaNumericAnyConversions
-
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
-
def
unifiedPrimitiveHashcode(): Int
- Attributes
- protected
- Definition Classes
- ScalaNumericAnyConversions
-
def
→[B](y: B): (ScalaWholeNumberProxy[T], B)
- Implicit
- This member is added by an implicit conversion from ScalaWholeNumberProxy[T] to ArrowAssoc[ScalaWholeNumberProxy[T]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
Shadowed Implicit Value Members
-
def
<(that: ScalaWholeNumberProxy[T]): Boolean
Returns true if
thisis less thanthatReturns true if
thisis less thanthat- Implicit
- This member is added by an implicit conversion from ScalaWholeNumberProxy[T] to math.Ordered[ScalaWholeNumberProxy[T]] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[ScalaWholeNumberProxy[T]] is in scope.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(scalaWholeNumberProxy: math.Ordered[ScalaWholeNumberProxy[T]]).<(that)
- Definition Classes
- Ordered
-
def
<=(that: ScalaWholeNumberProxy[T]): Boolean
Returns true if
thisis less than or equal tothat.Returns true if
thisis less than or equal tothat.- Implicit
- This member is added by an implicit conversion from ScalaWholeNumberProxy[T] to math.Ordered[ScalaWholeNumberProxy[T]] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[ScalaWholeNumberProxy[T]] is in scope.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(scalaWholeNumberProxy: math.Ordered[ScalaWholeNumberProxy[T]]).<=(that)
- Definition Classes
- Ordered
-
def
>(that: ScalaWholeNumberProxy[T]): Boolean
Returns true if
thisis greater thanthat.Returns true if
thisis greater thanthat.- Implicit
- This member is added by an implicit conversion from ScalaWholeNumberProxy[T] to math.Ordered[ScalaWholeNumberProxy[T]] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[ScalaWholeNumberProxy[T]] is in scope.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(scalaWholeNumberProxy: math.Ordered[ScalaWholeNumberProxy[T]]).>(that)
- Definition Classes
- Ordered
-
def
>=(that: ScalaWholeNumberProxy[T]): Boolean
Returns true if
thisis greater than or equal tothat.Returns true if
thisis greater than or equal tothat.- Implicit
- This member is added by an implicit conversion from ScalaWholeNumberProxy[T] to math.Ordered[ScalaWholeNumberProxy[T]] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[ScalaWholeNumberProxy[T]] is in scope.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(scalaWholeNumberProxy: math.Ordered[ScalaWholeNumberProxy[T]]).>=(that)
- Definition Classes
- Ordered
-
def
compare(that: ScalaWholeNumberProxy[T]): Int
Result of comparing
thiswith operandthat.Result of comparing
thiswith operandthat.Implement this method to determine how instances of A will be sorted.
Returns
xwhere:x < 0whenthis < thatx == 0whenthis == thatx > 0whenthis > that
- Implicit
- This member is added by an implicit conversion from ScalaWholeNumberProxy[T] to math.Ordered[ScalaWholeNumberProxy[T]] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[ScalaWholeNumberProxy[T]] is in scope.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(scalaWholeNumberProxy: math.Ordered[ScalaWholeNumberProxy[T]]).compare(that)
- Definition Classes
- Ordered
-
def
compareTo(that: ScalaWholeNumberProxy[T]): Int
Result of comparing
thiswith operandthat.Result of comparing
thiswith operandthat.- Implicit
- This member is added by an implicit conversion from ScalaWholeNumberProxy[T] to math.Ordered[ScalaWholeNumberProxy[T]] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[ScalaWholeNumberProxy[T]] is in scope.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(scalaWholeNumberProxy: math.Ordered[ScalaWholeNumberProxy[T]]).compareTo(that)
- Definition Classes
- Ordered → Comparable
Deprecated Value Members
-
def
formatted(fmtstr: String): String
Returns string formatted according to given
formatstring.Returns string formatted according to given
formatstring. Format strings are as forString.format(@see java.lang.String.format).- Implicit
- This member is added by an implicit conversion from ScalaWholeNumberProxy[T] to Predef.StringFormat[ScalaWholeNumberProxy[T]] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
-
def
isWhole(): Boolean
- returns
trueif this number has no decimal component,falseotherwise.
- Definition Classes
- ScalaWholeNumberProxy → ScalaNumericAnyConversions
- Annotations
- @deprecated
- Deprecated
(Since version 2.12.15) isWhole on an integer type is always true
This is the documentation for the Scala standard library.
Package structure
The scala package contains core types like
Int,Float,ArrayorOptionwhich are accessible in all Scala compilation units without explicit qualification or imports.Notable packages include:
scala.collectionand its sub-packages contain Scala's collections frameworkscala.collection.immutable- Immutable, sequential data-structures such asVector,List,Range,HashMaporHashSetscala.collection.mutable- Mutable, sequential data-structures such asArrayBuffer,StringBuilder,HashMaporHashSetscala.collection.concurrent- Mutable, concurrent data-structures such asTrieMapscala.collection.parallel.immutable- Immutable, parallel data-structures such asParVector,ParRange,ParHashMaporParHashSetscala.collection.parallel.mutable- Mutable, parallel data-structures such asParArray,ParHashMap,ParTrieMaporParHashSetscala.concurrent- Primitives for concurrent programming such asFuturesandPromisesscala.io- Input and output operationsscala.math- Basic math functions and additional numeric types likeBigIntandBigDecimalscala.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.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.Predefobject are always in scope by default.Some of these identifiers are type aliases provided as shortcuts to commonly used classes. For example,
Listis an alias forscala.collection.immutable.List.Other aliases refer to classes provided by the underlying platform. For example, on the JVM,
Stringis an alias forjava.lang.String.