final class RichFloat extends AnyVal with FractionalProxy[Float]
- Source
- RichFloat.scala
- Alphabetic
- By Inheritance
- RichFloat
- FractionalProxy
- RangedProxy
- ScalaNumberProxy
- OrderedProxy
- Ordered
- Comparable
- Typed
- Proxy
- ScalaNumericAnyConversions
- AnyVal
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
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.
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
- FractionalProxy → RangedProxy
Value Members
-
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
-
final
def
##(): Int
Equivalent to
x.hashCode
except for boxed numeric types andnull
.Equivalent to
x.hashCode
except 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. Fornull
returns a hashcode wherenull.hashCode
throws aNullPointerException
.- 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 thanthat
Returns true if
this
is less thanthat
- Definition Classes
- Ordered
-
def
<=(that: Float): Boolean
Returns true if
this
is less than or equal tothat
.Returns true if
this
is 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 == that
is equivalent toif (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 thanthat
.Returns true if
this
is greater thanthat
.- Definition Classes
- Ordered
-
def
>=(that: Float): Boolean
Returns true if
this
is greater than or equal tothat
.Returns true if
this
is greater than or equal tothat
.- Definition Classes
- Ordered
-
def
abs: Float
Returns the absolute value of
this
.Returns the absolute value of
this
.- Definition Classes
- RichFloat → 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 aClassCastException
at 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
ClassCastException
if the receiver object is not an instance of the erasure of typeT0
.
-
def
byteValue(): Byte
- Definition Classes
- RichFloat → ScalaNumberProxy → ScalaNumericAnyConversions
- def ceil: Float
-
def
compare(y: Float): Int
Result of comparing
this
with operandthat
.Result of comparing
this
with operandthat
.Implement this method to determine how instances of A will be sorted.
Returns
x
where:x < 0
whenthis < that
x == 0
whenthis == that
x > 0
whenthis > that
- Definition Classes
- OrderedProxy → Ordered
-
def
compareTo(that: Float): Int
Result of comparing
this
with operandthat
.Result of comparing
this
with operandthat
.- Definition Classes
- Ordered → Comparable
-
def
doubleValue(): Double
- Definition Classes
- RichFloat → ScalaNumberProxy → ScalaNumericAnyConversions
-
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
- Definition Classes
- RichFloat → ScalaNumberProxy → ScalaNumericAnyConversions
- def floor: Float
-
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 forString.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.
-
def
intValue(): Int
- Definition Classes
- RichFloat → ScalaNumberProxy → ScalaNumericAnyConversions
-
def
integralNum: FloatAsIfIntegral.type
- Attributes
- protected
- Definition Classes
- RichFloat → FractionalProxy
- def isInfinity: Boolean
-
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
true
if the receiver object is an instance of erasure of typeT0
;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 returnsfalse
.Returns
true
iff this has a zero fractional part, and is within the range of scala.Byte MinValue and MaxValue; otherwise returnsfalse
.- Definition Classes
- RichFloat → ScalaNumericAnyConversions
-
def
isValidChar: Boolean
Returns
true
iff this has a zero fractional part, and is within the range of scala.Char MinValue and MaxValue; otherwise returnsfalse
.Returns
true
iff this has a zero fractional part, and is within the range of scala.Char MinValue and MaxValue; otherwise returnsfalse
.- Definition Classes
- RichFloat → ScalaNumericAnyConversions
-
def
isValidInt: Boolean
Returns
true
iff this has a zero fractional part, and is within the range of scala.Int MinValue and MaxValue; otherwise returnsfalse
.Returns
true
iff this has a zero fractional part, and is within the range of scala.Int MinValue and MaxValue; otherwise returnsfalse
.- Definition Classes
- RichFloat → ScalaNumericAnyConversions
-
def
isValidShort: Boolean
Returns
true
iff this has a zero fractional part, and is within the range of scala.Short MinValue and MaxValue; otherwise returnsfalse
.Returns
true
iff this has a zero fractional part, and is within the range of scala.Short MinValue and MaxValue; otherwise returnsfalse
.- Definition Classes
- RichFloat → ScalaNumericAnyConversions
-
def
isWhole(): Boolean
- returns
true
if this number has no decimal component,false
otherwise.
- Definition Classes
- RichFloat → FractionalProxy → ScalaNumericAnyConversions
-
def
longValue(): Long
- Definition Classes
- RichFloat → ScalaNumberProxy → ScalaNumericAnyConversions
-
def
max(that: Float): Float
Returns
this
ifthis > that
orthat
otherwise.Returns
this
ifthis > that
orthat
otherwise.- Definition Classes
- RichFloat → ScalaNumberProxy
-
def
min(that: Float): Float
Returns
this
ifthis < that
orthat
otherwise.Returns
this
ifthis < that
orthat
otherwise.- Definition Classes
- RichFloat → ScalaNumberProxy
-
def
num: FloatIsFractional.type
- Attributes
- protected
- Definition Classes
- RichFloat → FractionalProxy → ScalaNumberProxy
-
def
ord: math.Ordering.Float.type
- Attributes
- protected
- Definition Classes
- RichFloat → OrderedProxy
- def round: Int
- val self: Float
-
def
shortValue(): Short
- Definition Classes
- RichFloat → ScalaNumberProxy → ScalaNumericAnyConversions
-
def
signum: Int
Returns the signum of
this
.Returns the signum of
this
.- Definition Classes
- RichFloat → 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
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.
-
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
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.
-
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): (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
Deprecated Value Members
-
def
to(end: Float, step: Float): Inclusive[Float]
- Definition Classes
- FractionalProxy → RangedProxy
- Annotations
- @deprecated
- Deprecated
(Since version 2.12.6) use BigDecimal range instead
-
def
to(end: Float): ResultWithoutStep
- Definition Classes
- FractionalProxy → RangedProxy
- Annotations
- @deprecated
- Deprecated
(Since version 2.12.6) use BigDecimal range instead
-
def
until(end: Float, step: Float): Exclusive[Float]
- Definition Classes
- FractionalProxy → RangedProxy
- Annotations
- @deprecated
- Deprecated
(Since version 2.12.6) use BigDecimal range instead
-
def
until(end: Float): ResultWithoutStep
- Definition Classes
- FractionalProxy → RangedProxy
- Annotations
- @deprecated
- Deprecated
(Since version 2.12.6) use BigDecimal range instead
This is the documentation for the Scala standard library.
Package structure
The scala package contains core types like
Int
,Float
,Array
orOption
which are accessible in all Scala compilation units without explicit qualification or imports.Notable packages include:
scala.collection
and its sub-packages contain Scala's collections frameworkscala.collection.immutable
- Immutable, sequential data-structures such asVector
,List
,Range
,HashMap
orHashSet
scala.collection.mutable
- Mutable, sequential data-structures such asArrayBuffer
,StringBuilder
,HashMap
orHashSet
scala.collection.concurrent
- Mutable, concurrent data-structures such asTrieMap
scala.collection.parallel.immutable
- Immutable, parallel data-structures such asParVector
,ParRange
,ParHashMap
orParHashSet
scala.collection.parallel.mutable
- Mutable, parallel data-structures such asParArray
,ParHashMap
,ParTrieMap
orParHashSet
scala.concurrent
- Primitives for concurrent programming such asFutures
andPromises
scala.io
- Input and output operationsscala.math
- Basic math functions and additional numeric types likeBigInt
andBigDecimal
scala.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.Predef
object are always in scope by default.Some of these identifiers are type aliases provided as shortcuts to commonly used classes. For example,
List
is an alias forscala.collection.immutable.List
.Other aliases refer to classes provided by the underlying platform. For example, on the JVM,
String
is an alias forjava.lang.String
.