W3cubDocs

/Scala 2.12 Library

Class scala.runtime.RichFloat

final class RichFloat extends AnyVal with FractionalProxy[Float]

Source
RichFloat.scala
Linear Supertypes

Instance Constructors

new RichFloat(self: Float)

Type Members

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

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.

Definition Classes
FractionalProxyRangedProxy

Value Members

final def !=(arg0: Any): Boolean

Test two objects for inequality.

returns

true if !(this == that), false otherwise.

Definition Classes
Any

final def ##(): Int

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

def +(other: String): String

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

def ->[B](y: B): (RichFloat, B)

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

def <(that: Float): Boolean

Returns true if this is less than that

Definition Classes
Ordered

def <=(that: Float): Boolean

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

Definition Classes
Ordered

final def ==(arg0: Any): Boolean

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

def >(that: Float): Boolean

Returns true if this is greater than that.

Definition Classes
Ordered

def >=(that: Float): Boolean

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

Definition Classes
Ordered

def abs: Float

Returns the absolute value of this.

Definition Classes
RichFloatScalaNumberProxy

final def asInstanceOf[T0]: 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.

def byteValue(): Byte

def ceil: Float

def compare(y: Float): Int

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

def compareTo(that: Float): Int

Result of comparing this with operand that.

Definition Classes
Ordered → Comparable

def doubleValue(): Double

def ensuring(cond: (RichFloat) ⇒ Boolean, msg: ⇒ Any): RichFloat

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

def ensuring(cond: (RichFloat) ⇒ Boolean): RichFloat

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

def ensuring(cond: Boolean, msg: ⇒ Any): RichFloat

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

def ensuring(cond: Boolean): RichFloat

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

def floatValue(): Float

def floor: Float

def formatted(fmtstr: String): 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 to Predef.StringFormat[RichFloat] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()

def getClass(): Class[_ <: AnyVal]

Returns the runtime class representation of the object.

returns

a class object corresponding to the runtime type of the receiver.

Definition Classes
AnyValAny

def intValue(): Int

def integralNum: FloatAsIfIntegral.type

Attributes
protected
Definition Classes
RichFloatFractionalProxy

def isInfinity: Boolean

final def isInstanceOf[T0]: Boolean

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

def isNaN: Boolean

def isNegInfinity: Boolean

def isPosInfinity: Boolean

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.

Definition Classes
RichFloatScalaNumericAnyConversions

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.

Definition Classes
RichFloatScalaNumericAnyConversions

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.

Definition Classes
RichFloatScalaNumericAnyConversions

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.

Definition Classes
RichFloatScalaNumericAnyConversions

def isWhole(): Boolean

returns

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

Definition Classes
RichFloatFractionalProxyScalaNumericAnyConversions

def longValue(): Long

def max(that: Float): Float

Returns this if this > that or that otherwise.

Definition Classes
RichFloatScalaNumberProxy

def min(that: Float): Float

Returns this if this < that or that otherwise.

Definition Classes
RichFloatScalaNumberProxy

def num: FloatIsFractional.type

Attributes
protected
Definition Classes
RichFloatFractionalProxyScalaNumberProxy

def ord: math.Ordering.Float.type

Attributes
protected
Definition Classes
RichFloatOrderedProxy

def round: Int

val self: Float

Definition Classes
RichFloatTypedProxy

def shortValue(): Short

def signum: Int

Returns the signum of this.

Definition Classes
RichFloatScalaNumberProxy

def toByte: 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. This may involve rounding or truncation.

Definition Classes
ScalaNumericAnyConversions

def toDegrees: Float

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

returns

the measurement of the angle x in degrees.

def toDouble: 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. This may involve rounding or truncation.

Definition Classes
ScalaNumericAnyConversions

def toInt: 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. This may involve rounding or truncation.

Definition Classes
ScalaNumericAnyConversions

def toRadians: Float

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

returns

the measurement of the angle x in radians.

def toShort: 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.

The default representation is platform dependent.

returns

a string representation of the object.

Definition Classes
ProxyAny

def underlying(): AnyRef

def unifiedPrimitiveEquals(x: Any): Boolean

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): (RichFloat, B)

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

© 2002-2019 EPFL, with contributions from Lightbend.
Licensed under the Apache License, Version 2.0.
https://www.scala-lang.org/api/2.12.9/scala/runtime/RichFloat.html