scala.runtime

RichFloat

final class RichFloat extends FractionalProxy[Float]

Source
RichFloat.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. RichFloat
  2. FractionalProxy
  3. RangedProxy
  4. ScalaNumberProxy
  5. OrderedProxy
  6. Ordered
  7. Comparable
  8. Typed
  9. Proxy
  10. ScalaNumericConversions
  11. ScalaNumber
  12. Number
  13. Serializable
  14. AnyRef
  15. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new RichFloat(self: Float)

Type Members

  1. type ResultWithoutStep = Partial[Float, NumericRange[Float]]

    Definition Classes
    FractionalProxyRangedProxy

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. 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
  3. 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
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from RichFloat to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (RichFloat, B)

    Implicit information
    This member is added by an implicit conversion from RichFloat to ArrowAssoc[RichFloat] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. def <(that: Float): Boolean

    Returns true if this is less than that

    Returns true if this is less than that

    Definition Classes
    Ordered
  7. 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
  8. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  9. 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
  10. def >(that: Float): Boolean

    Returns true if this is greater than that.

    Returns true if this is greater than that.

    Definition Classes
    Ordered
  11. 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
  12. def abs: Float

    Definition Classes
    ScalaNumberProxy
  13. 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.

  14. def byteValue(): Byte

    Definition Classes
    Number
  15. def ceil: Float

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

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
    Note

    not specified by SLS as a member of AnyRef

  17. 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
  18. def compareTo(that: Float): Int

    Result of comparing this with operand that.

    Result of comparing this with operand that.

    Definition Classes
    Ordered → Comparable
  19. def doubleValue(): Double

    Definition Classes
    ScalaNumberProxy → Number
  20. def ensuring(cond: (RichFloat) ⇒ Boolean, msg: ⇒ Any): RichFloat

    Implicit information
    This member is added by an implicit conversion from RichFloat to Ensuring[RichFloat] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  21. def ensuring(cond: (RichFloat) ⇒ Boolean): RichFloat

    Implicit information
    This member is added by an implicit conversion from RichFloat to Ensuring[RichFloat] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  22. def ensuring(cond: Boolean, msg: ⇒ Any): RichFloat

    Implicit information
    This member is added by an implicit conversion from RichFloat to Ensuring[RichFloat] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  23. def ensuring(cond: Boolean): RichFloat

    Implicit information
    This member is added by an implicit conversion from RichFloat to Ensuring[RichFloat] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  24. final def eq(arg0: AnyRef): Boolean

    Tests whether the argument (arg0) is a reference to the receiver object (this).

    Tests whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an equivalence relation on non-null instances of AnyRef, and has three additional properties:

    • It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false.
    • For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false.
    • null.eq(null) returns true.

    When overriding the equals or hashCode 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
  25. 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 AnyRef 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 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
    ProxyAny
  26. 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 between finalize and non-local returns and exceptions, are all platform dependent.

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
    Note

    not specified by SLS as a member of AnyRef

  27. def floatValue(): Float

    Definition Classes
    ScalaNumberProxy → Number
  28. def floor: Float

  29. 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 RichFloat to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  30. final def getClass(): Class[_]

    A representation that corresponds to the dynamic class of the receiver object.

    A representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    Definition Classes
    AnyRef → Any
    Note

    not specified by SLS as a member of AnyRef

  31. 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
    ProxyAny
  32. def intValue(): Int

    Definition Classes
    ScalaNumberProxy → Number
  33. val integralNum: Numeric.FloatAsIfIntegral.type

    In order to supply predictable ranges, we require an Integral[T] which provides us with discrete operations on the (otherwise fractional) T.

    In order to supply predictable ranges, we require an Integral[T] which provides us with discrete operations on the (otherwise fractional) T. See Numeric.DoubleAsIfIntegral for an example.

    Attributes
    protected
    Definition Classes
    RichFloatFractionalProxy
  34. def isInfinity: Boolean

  35. 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
  36. def isNegInfinity: Boolean

  37. def isPosInfinity: Boolean

  38. def isValidByte: Boolean

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

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

    Definition Classes
    RichFloatScalaNumericConversions
  39. def isValidChar: Boolean

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

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

    Definition Classes
    RichFloatScalaNumericConversions
  40. def isValidInt: Boolean

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

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

    Definition Classes
    RichFloatScalaNumericConversions
  41. def isValidShort: Boolean

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

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

    Definition Classes
    RichFloatScalaNumericConversions
  42. def isWhole(): Boolean

    Definition Classes
    RichFloatFractionalProxy → ScalaNumber
  43. def longValue(): Long

    Definition Classes
    ScalaNumberProxy → Number
  44. def max(that: Float): Float

    Definition Classes
    ScalaNumberProxy
  45. def min(that: Float): Float

    Definition Classes
    ScalaNumberProxy
  46. 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
  47. 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
    Note

    not specified by SLS as a member of AnyRef

  48. 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
    Note

    not specified by SLS as a member of AnyRef

  49. val ord: Ordering[Float]

    Attributes
    protected
    Definition Classes
    ScalaNumberProxyOrderedProxy
  50. def round: Int

  51. val self: Float

    Definition Classes
    RichFloatTypedProxy
  52. def shortValue(): Short

    Definition Classes
    Number
  53. def signum: Int

    Definition Classes
    ScalaNumberProxy
  54. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  55. def to(end: Float, step: Float): Inclusive[Float]

    Definition Classes
    FractionalProxyRangedProxy
  56. def to(end: Float): ResultWithoutStep

    Definition Classes
    FractionalProxyRangedProxy
  57. def toByte: Byte

    Returns the value of this as a Byte.

    Returns the value of this as a Byte. This may involve rounding or truncation.

    Definition Classes
    ScalaNumericConversions
  58. def toChar: Char

    Returns the value of this as a Char.

    Returns the value of this as a Char. This may involve rounding or truncation.

    Definition Classes
    ScalaNumericConversions
  59. 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.

  60. def toDouble: Double

    Returns the value of this as a Double.

    Returns the value of this as a Double. This may involve rounding or truncation.

    Definition Classes
    ScalaNumericConversions
  61. def toFloat: Float

    Returns the value of this as a Float.

    Returns the value of this as a Float. This may involve rounding or truncation.

    Definition Classes
    ScalaNumericConversions
  62. def toInt: Int

    Returns the value of this as an Int.

    Returns the value of this as an Int. This may involve rounding or truncation.

    Definition Classes
    ScalaNumericConversions
  63. def toLong: Long

    Returns the value of this as a Long.

    Returns the value of this as a Long. This may involve rounding or truncation.

    Definition Classes
    ScalaNumericConversions
  64. 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.

  65. def toShort: Short

    Returns the value of this as a Short.

    Returns the value of this as a Short. This may involve rounding or truncation.

    Definition Classes
    ScalaNumericConversions
  66. 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
  67. def underlying(): AnyRef

    Definition Classes
    ScalaNumberProxy → ScalaNumber
  68. 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
    ScalaNumericConversions
  69. def unifiedPrimitiveHashcode(): Int

    Attributes
    protected
    Definition Classes
    ScalaNumericConversions
  70. def until(end: Float, step: Float): Exclusive[Float]

    Definition Classes
    FractionalProxyRangedProxy
  71. def until(end: Float): ResultWithoutStep

    Definition Classes
    FractionalProxyRangedProxy
  72. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  73. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  74. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  75. def [B](y: B): (RichFloat, B)

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

Deprecated Value Members

  1. def x: RichFloat

    Implicit information
    This member is added by an implicit conversion from RichFloat to ArrowAssoc[RichFloat] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: RichFloat

    Implicit information
    This member is added by an implicit conversion from RichFloat to Ensuring[RichFloat] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from FractionalProxy[Float]

Inherited from RangedProxy[Float]

Inherited from ScalaNumberProxy[Float]

Inherited from OrderedProxy[Float]

Inherited from Ordered[Float]

Inherited from Comparable[Float]

Inherited from Typed[Float]

Inherited from Proxy

Inherited from ScalaNumericConversions

Inherited from ScalaNumber

Inherited from Number

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from RichFloat to StringAdd

Inherited by implicit conversion any2stringfmt from RichFloat to StringFormat

Inherited by implicit conversion any2ArrowAssoc from RichFloat to ArrowAssoc[RichFloat]

Inherited by implicit conversion any2Ensuring from RichFloat to Ensuring[RichFloat]