scala.runtime

# ScalaNumberProxy

###
Related Doc: package runtime

#### trait ScalaNumberProxy[T] extends ScalaNumericAnyConversions with Typed[T] with OrderedProxy[T]

Base classes for the Rich* wrappers of the primitive types. As with all classes in scala.runtime.*, this is not a supported API.

Source
  ScalaNumberProxy.scala
Version

  2.9

Since

  2.9

Linear Supertypes
OrderedProxy[T], math.Ordered[T], Comparable[T], Typed[T], Proxy, ScalaNumericAnyConversions, Any
Known Subclasses
FractionalProxy, IntegralProxy, RichByte, RichChar, RichDouble, RichFloat, RichInt, RichLong, RichShort, ScalaWholeNumberProxy
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. ScalaNumberProxy
2. OrderedProxy
3. Ordered
4. Comparable
5. Typed
6. Proxy
7. ScalaNumericAnyConversions
8. Any

Implicitly

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

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Abstract Value Members

1. #### 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

2. #### abstract def isWhole(): Boolean

   returns

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

   Definition Classes
     ScalaNumericAnyConversions

3. #### implicit abstract def num: Numeric[T]

   Attributes
     protected

4. #### abstract def ord: Ordering[T]

   Attributes
     protected
   Definition Classes
     OrderedProxy

5. #### abstract def self: T

   Definition Classes
     Typed → Proxy

### Concrete 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 information
     This member is added by an implicit conversion from ScalaNumberProxy[T] to any2stringadd[ScalaNumberProxy[T]] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd

4. #### def ->[B](y: B): (ScalaNumberProxy[T], B)

   Implicit information
     This member is added by an implicit conversion from ScalaNumberProxy[T] to ArrowAssoc[ScalaNumberProxy[T]] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @inline()

5. #### def <(that: T): Boolean

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

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

   Definition Classes
     Ordered

6. #### def <=(that: T): 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: T): Boolean

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

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

   Definition Classes
     Ordered

9. #### def >=(that: T): 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: T

    Returns the absolute value of `this`.

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
      ScalaNumberProxy → ScalaNumericAnyConversions

13. #### def compare(y: T): 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: T): 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
      ScalaNumberProxy → ScalaNumericAnyConversions

16. #### def ensuring(cond: (ScalaNumberProxy[T]) ⇒ Boolean, msg: ⇒ Any): ScalaNumberProxy[T]

    Implicit information
      This member is added by an implicit conversion from ScalaNumberProxy[T] to Ensuring[ScalaNumberProxy[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring

17. #### def ensuring(cond: (ScalaNumberProxy[T]) ⇒ Boolean): ScalaNumberProxy[T]

    Implicit information
      This member is added by an implicit conversion from ScalaNumberProxy[T] to Ensuring[ScalaNumberProxy[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring

18. #### def ensuring(cond: Boolean, msg: ⇒ Any): ScalaNumberProxy[T]

    Implicit information
      This member is added by an implicit conversion from ScalaNumberProxy[T] to Ensuring[ScalaNumberProxy[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring

19. #### def ensuring(cond: Boolean): ScalaNumberProxy[T]

    Implicit information
      This member is added by an implicit conversion from ScalaNumberProxy[T] to Ensuring[ScalaNumberProxy[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring

20. #### 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 `x` of type `Any`, `x.equals(x)` should return `true`.
    - It is symmetric: for any instances `x` and `y` of type `Any`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`.
    - It is transitive: for any instances `x`, `y`, and `z` of type `Any` if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`.

    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 `hashCode` to ensure that objects which are "equal" (`o1.equals(o2)` returns `true`) hash to the same scala.Int. (`o1.hashCode.equals(o2.hashCode)`).

    that

      the object to compare against this object for equality.

    returns

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

    Definition Classes
      Proxy → Any

21. #### def floatValue(): Float

    Definition Classes
      ScalaNumberProxy → ScalaNumericAnyConversions

22. #### 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 information
      This member is added by an implicit conversion from ScalaNumberProxy[T] to Predef.StringFormat[ScalaNumberProxy[T]] performed by method StringFormat in scala.Predef.
    Definition Classes
      StringFormat
    Annotations
      @inline()

23. #### 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)` returns `false`). A degenerate implementation could always return `0`. However, it is required that if two objects are equal (`o1.equals(o2)` returns `true`) 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 the `equals` method.

    returns

      the hash code value for this object.

    Definition Classes
      Proxy → Any

24. #### def intValue(): Int

    Definition Classes
      ScalaNumberProxy → ScalaNumericAnyConversions

25. #### 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

26. #### 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

27. #### 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

28. #### 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
      ScalaNumericAnyConversions

29. #### 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

30. #### def longValue(): Long

    Definition Classes
      ScalaNumberProxy → ScalaNumericAnyConversions

31. #### def max(that: T): T

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

32. #### def min(that: T): T

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

33. #### def shortValue(): Short

    Definition Classes
      ScalaNumberProxy → ScalaNumericAnyConversions

34. #### def signum: Int

    Returns the signum of `this`.

35. #### 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

36. #### 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

37. #### 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

38. #### 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

39. #### 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

40. #### 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

41. #### 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

42. #### 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

43. #### def underlying(): AnyRef

    Definition Classes
      ScalaNumberProxy → ScalaNumericAnyConversions

44. #### 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

45. #### def unifiedPrimitiveHashcode(): Int

    Attributes
      protected
    Definition Classes
      ScalaNumericAnyConversions

46. #### def →[B](y: B): (ScalaNumberProxy[T], B)

    Implicit information
      This member is added by an implicit conversion from ScalaNumberProxy[T] to ArrowAssoc[ScalaNumberProxy[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
      ArrowAssoc

### Shadowed Implicit Value Members

1. #### def <(that: ScalaNumberProxy[T]): Boolean

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

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

   Implicit information
     This member is added by an implicit conversion from ScalaNumberProxy[T] to math.Ordered[ScalaNumberProxy[T]] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[ScalaNumberProxy[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:

         (scalaNumberProxy: math.Ordered[ScalaNumberProxy[T]]).<(that)

   Definition Classes
     Ordered

2. #### def <=(that: ScalaNumberProxy[T]): Boolean

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

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

   Implicit information
     This member is added by an implicit conversion from ScalaNumberProxy[T] to math.Ordered[ScalaNumberProxy[T]] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[ScalaNumberProxy[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:

         (scalaNumberProxy: math.Ordered[ScalaNumberProxy[T]]).<=(that)

   Definition Classes
     Ordered

3. #### def >(that: ScalaNumberProxy[T]): Boolean

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

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

   Implicit information
     This member is added by an implicit conversion from ScalaNumberProxy[T] to math.Ordered[ScalaNumberProxy[T]] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[ScalaNumberProxy[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:

         (scalaNumberProxy: math.Ordered[ScalaNumberProxy[T]]).>(that)

   Definition Classes
     Ordered

4. #### def >=(that: ScalaNumberProxy[T]): Boolean

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

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

   Implicit information
     This member is added by an implicit conversion from ScalaNumberProxy[T] to math.Ordered[ScalaNumberProxy[T]] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[ScalaNumberProxy[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:

         (scalaNumberProxy: math.Ordered[ScalaNumberProxy[T]]).>=(that)

   Definition Classes
     Ordered

5. #### def compare(that: ScalaNumberProxy[T]): 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`
   Implicit information
     This member is added by an implicit conversion from ScalaNumberProxy[T] to math.Ordered[ScalaNumberProxy[T]] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[ScalaNumberProxy[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:

         (scalaNumberProxy: math.Ordered[ScalaNumberProxy[T]]).compare(that)

   Definition Classes
     Ordered

6. #### def compareTo(that: ScalaNumberProxy[T]): Int

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

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

   Implicit information
     This member is added by an implicit conversion from ScalaNumberProxy[T] to math.Ordered[ScalaNumberProxy[T]] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[ScalaNumberProxy[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:

         (scalaNumberProxy: math.Ordered[ScalaNumberProxy[T]]).compareTo(that)

   Definition Classes
     Ordered → Comparable

### Inherited from OrderedProxy[T]

### Inherited from math.Ordered[T]

### Inherited from Comparable[T]

### Inherited from Typed[T]

### Inherited from Proxy

### Inherited from ScalaNumericAnyConversions

### Inherited from Any

### Inherited by implicit conversion orderingToOrdered from ScalaNumberProxy[T] to math.Ordered[ScalaNumberProxy[T]]

### Inherited by implicit conversion any2stringadd from ScalaNumberProxy[T] to any2stringadd[ScalaNumberProxy[T]]

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

### Inherited by implicit conversion Ensuring from ScalaNumberProxy[T] to Ensuring[ScalaNumberProxy[T]]

### Inherited by implicit conversion ArrowAssoc from ScalaNumberProxy[T] to ArrowAssoc[ScalaNumberProxy[T]]

### Ungrouped