Packages

c

scala.runtime

RichFloat

final class RichFloat extends AnyVal with FractionalProxy[Float]

Source
RichFloat.scala
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RichFloat
  2. FractionalProxy
  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. Protected

Instance Constructors

  1. new RichFloat(self: Float)

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 RichFloat toany2stringadd[RichFloat] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (RichFloat, B)
    Implicit
    This member is added by an implicit conversion from RichFloat toArrowAssoc[RichFloat] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. def <(that: Float): Boolean

    Returns true if this is less than that

    Returns true if this is less than that

    Definition Classes
    Ordered
  6. def <=(that: Float): 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: Float): Boolean

    Returns true if this is greater than that.

    Returns true if this is greater than that.

    Definition Classes
    Ordered
  9. def >=(that: Float): 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: Float

    Returns the absolute value of this.

    Returns the absolute value of this.

    Definition Classes
    RichFloatScalaNumberProxy
  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
  13. def ceil: Float
  14. def compare(y: Float): 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
    OrderedProxyOrdered
  15. def compareTo(that: Float): Int

    Result of comparing this with operand that.

    Result of comparing this with operand that.

    Definition Classes
    Ordered → Comparable
  16. def doubleValue: Double
  17. def ensuring(cond: (RichFloat) => Boolean, msg: => Any): RichFloat
    Implicit
    This member is added by an implicit conversion from RichFloat toEnsuring[RichFloat] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: (RichFloat) => Boolean): RichFloat
    Implicit
    This member is added by an implicit conversion from RichFloat toEnsuring[RichFloat] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. def ensuring(cond: Boolean, msg: => Any): RichFloat
    Implicit
    This member is added by an implicit conversion from RichFloat toEnsuring[RichFloat] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  20. def ensuring(cond: Boolean): RichFloat
    Implicit
    This member is added by an implicit conversion from RichFloat toEnsuring[RichFloat] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  21. def floatValue: Float
  22. def floor: Float
  23. 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
    AnyValAny
  24. def intValue: Int
  25. def isFinite: Boolean
  26. def isInfinity: Boolean
  27. final def isInstanceOf[T0]: Boolean

    Test whether the dynamic type of the receiver object has the same erasure as T0.

    Test whether the dynamic type of the receiver object has the same erasure as T0.

    Depending on what T0 is, the test is done in one of the below ways:

    • T0 is a non-parameterized class type, e.g. BigDecimal: this method returns true if the value of the receiver object is a BigDecimal or a subtype of BigDecimal.
    • T0 is a parameterized class type, e.g. List[Int]: this method returns true if the value of the receiver object is some List[X] for any X. For example, List(1, 2, 3).isInstanceOf[List[String]] will return true.
    • T0 is some singleton type x.type or literal x: this method returns this.eq(x). For example, x.isInstanceOf[1] is equivalent to x.eq(1)
    • T0 is an intersection X with Y or X & Y: this method is equivalent to x.isInstanceOf[X] && x.isInstanceOf[Y]
    • T0 is a union X | Y: this method is equivalent to x.isInstanceOf[X] || x.isInstanceOf[Y]
    • T0 is a type parameter or an abstract type member: this method is equivalent to isInstanceOf[U] where U is T0's upper bound, Any if T0 is unbounded. For example, x.isInstanceOf[A] where A is an unbounded type parameter will return true for any value of x.

    This is exactly equivalent to the type pattern _: T0

    returns

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

    Definition Classes
    Any
    Note

    due to the unexpectedness of List(1, 2, 3).isInstanceOf[List[String]] returning true and x.isInstanceOf[A] where A is a type parameter or abstract member returning true, these forms issue a warning.

  28. def isNaN: Boolean
  29. def isNegInfinity: Boolean
  30. def isPosInfinity: Boolean
  31. 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
    RichFloatScalaNumericAnyConversions
  32. 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
    RichFloatScalaNumericAnyConversions
  33. 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
    RichFloatScalaNumericAnyConversions
  34. 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
    RichFloatScalaNumericAnyConversions
  35. def isWhole: Boolean

    returns

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

    Definition Classes
    RichFloatFractionalProxyScalaNumericAnyConversions
  36. def longValue: Long
  37. def max(that: Float): Float

    Returns this if this > that or that otherwise.

    Returns this if this > that or that otherwise.

    Definition Classes
    RichFloatScalaNumberProxy
  38. def min(that: Float): Float

    Returns this if this < that or that otherwise.

    Returns this if this < that or that otherwise.

    Definition Classes
    RichFloatScalaNumberProxy
  39. def num: Fractional[Float]
    Attributes
    protected
    Definition Classes
    RichFloatFractionalProxyScalaNumberProxy
  40. def ord: Ordering[Float]
    Attributes
    protected
    Definition Classes
    RichFloatOrderedProxy
  41. def round: Int
  42. val self: Float
    Definition Classes
    RichFloatTypedProxy
  43. def shortValue: Short
  44. def sign: Float

    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.

    Definition Classes
    ScalaNumberProxy
  45. 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
  46. 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
  47. def toDegrees: Float

    Converts an angle measured in radians to an approximately equivalent angle measured in degrees.

    Converts an angle measured in radians to an approximately equivalent angle measured in degrees.

    returns

    the measurement of the angle x in degrees.

  48. 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
  49. 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
  50. 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
  51. 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
  52. def toRadians: Float

    Converts an angle measured in degrees to an approximately equivalent angle measured in radians.

    Converts an angle measured in degrees to an approximately equivalent angle measured in radians.

    returns

    the measurement of the angle x in radians.

  53. 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
  54. 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
    ProxyAny
  55. 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
  56. def unifiedPrimitiveHashcode: Int
    Attributes
    protected
    Definition Classes
    ScalaNumericAnyConversions

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 RichFloat toStringFormat[RichFloat] 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 signum: Int

    Returns the signum of this.

    Returns the signum of this.

    Definition Classes
    RichFloatScalaNumberProxy
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) signum does not handle -0.0f or Float.NaN; use sign method instead

  3. def [B](y: B): (RichFloat, B)
    Implicit
    This member is added by an implicit conversion from RichFloat toArrowAssoc[RichFloat] 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.

Inherited from FractionalProxy[Float]

Inherited from ScalaNumberProxy[Float]

Inherited from OrderedProxy[Float]

Inherited from math.Ordered[Float]

Inherited from Comparable[Float]

Inherited from Typed[Float]

Inherited from Proxy

Inherited from AnyVal

Inherited from Any

Inherited by implicit conversion any2stringadd fromRichFloat to any2stringadd[RichFloat]

Inherited by implicit conversion StringFormat fromRichFloat to StringFormat[RichFloat]

Inherited by implicit conversion Ensuring fromRichFloat to Ensuring[RichFloat]

Inherited by implicit conversion ArrowAssoc fromRichFloat to ArrowAssoc[RichFloat]

Ungrouped