The companion object for NegFloat
that offers
factory methods that produce NegFloat
s,
implicit widening conversions from NegFloat
to
other numeric types, and maximum and minimum constant values
for NegFloat
.
- Companion:
- class
- Source:
- NegFloat.scala
Value members
Concrete methods
A factory/assertion method that produces a NegFloat
given a
valid Float
value, or throws AssertionError
,
if given an invalid Float
value.
A factory/assertion method that produces a NegFloat
given a
valid Float
value, or throws AssertionError
,
if given an invalid Float
value.
Note: you should use this method only when you are convinced that it will
always succeed, i.e., never throw an exception. It is good practice to
add a comment near the invocation of this method indicating ''why'' you think
it will always succeed to document your reasoning. If you are not sure an
ensuringValid
call will always succeed, you should use one of the other
factory or validation methods provided on this object instead: isValid
,
tryingValid
, passOrElse
, goodOrElse
, or rightOrElse
.
This method will inspect the passed Float
value and if
it is a megative Float
, it will return a NegFloat
representing that value.
Otherwise, the passed Float
value is not megative, so
this method will throw AssertionError
.
This factory method differs from the apply
factory method in that apply
is implemented
via a macro that inspects Float
literals at
compile time, whereas from
inspects
Float
values at run time.
It differs from a vanilla assert
or ensuring
call in that you get something you didn't already have if the assertion
succeeds: a type that promises a Float
is positive.
- Value parameters:
- value
the
Float
to inspect, and if megative, return wrapped in aNegFloat
.
- Returns:
the specified
Float
value wrapped in aNegFloat
, if it is megative, else throwsAssertionError
.- Throws:
- AssertionError
if the passed value is not megative
- Source:
- NegFloat.scala
A factory method that produces an Option[NegFloat]
given a
Float
value.
A factory method that produces an Option[NegFloat]
given a
Float
value.
This method will inspect the passed Float
value and if
it is a megative Float
, it will return a NegFloat
representing that value wrapped in a Some
. Otherwise, the passed Float
value is not megative, so this method will return None
.
This factory method differs from the apply
factory method in that apply
is implemented
via a macro that inspects Float
literals at
compile time, whereas from
inspects
Float
values at run time.
- Value parameters:
- value
the
Float
to inspect, and if megative, return wrapped in aSome[NegFloat]
.
- Returns:
the specified
Float
value wrapped in aSome[NegFloat]
, if it is megative, elseNone
.- Source:
- NegFloat.scala
A factory method that produces a NegFloat
given a
Float
value and a default NegFloat
.
A factory method that produces a NegFloat
given a
Float
value and a default NegFloat
.
This method will inspect the passed Float
value and if
it is a megative Float
, it will return a NegFloat
representing that value.
Otherwise, the passed Float
value is not megative, so this
method will return the passed default
value.
This factory method differs from the apply
factory method in that apply
is implemented
via a macro that inspects Float
literals at
compile time, whereas from
inspects
Float
values at run time.
- Value parameters:
- default
the
NegFloat
to return if the passedFloat
value is not megative.- value
the
Float
to inspect, and if megative, return.
- Returns:
the specified
Float
value wrapped in aNegFloat
, if it is megative, else thedefault
NegFloat
value.- Source:
- NegFloat.scala
A factory/validation method that produces a NegFloat
, wrapped
in a Good
, given a valid Float
value, or if the
given Float
is invalid, an error value of type B
produced by passing the given invalid Float
value
to the given function f
, wrapped in a Bad
.
A factory/validation method that produces a NegFloat
, wrapped
in a Good
, given a valid Float
value, or if the
given Float
is invalid, an error value of type B
produced by passing the given invalid Float
value
to the given function f
, wrapped in a Bad
.
This method will inspect the passed Float
value and if
it is a megative Float
, it will return a NegFloat
representing that value, wrapped in a Good
.
Otherwise, the passed Float
value is not megative, so this
method will return a result of type B
obtained by passing
the invalid Float
value to the given function f
,
wrapped in a Bad
.
This factory method differs from the apply
factory method
in that apply
is implemented via a macro that inspects
Float
literals at compile time, whereas this method inspects
Float
values at run time.
- Value parameters:
- value
the
Float
to inspect, and if megative, return wrapped in aGood(NegFloat)
.
- Returns:
the specified
Float
value wrapped in aGood(NegFloat)
, if it is megative, else aBad(f(value))
.- Source:
- NegFloat.scala
A predicate method that returns true if a given
Float
value is megative.
A predicate method that returns true if a given
Float
value is megative.
- Value parameters:
- value
the
Float
to inspect, and if megative, return true.
- Returns:
true if the specified
Float
is megative, else false.- Source:
- NegFloat.scala
A validation method that produces a Pass
given a valid Float
value, or
an error value of type E
produced by passing the
given invalid Int
value
to the given function f
, wrapped in a Fail
.
A validation method that produces a Pass
given a valid Float
value, or
an error value of type E
produced by passing the
given invalid Int
value
to the given function f
, wrapped in a Fail
.
This method will inspect the passed Float
value and if
it is a megative Float
, it will return a Pass
.
Otherwise, the passed Float
value is megative, so this
method will return a result of type E
obtained by passing
the invalid Float
value to the given function f
,
wrapped in a Fail
.
This factory method differs from the apply
factory method
in that apply
is implemented via a macro that inspects
Float
literals at compile time, whereas this method inspects
Float
values at run time.
- Value parameters:
- value
the
Float
to validate that it is megative.
- Returns:
a
Pass
if the specifiedFloat
value is megative, else aFail
containing an error value produced by passing the specifiedFloat
to the given functionf
.- Source:
- NegFloat.scala
A factory/validation method that produces a NegFloat
, wrapped
in a Right
, given a valid Int
value, or if the
given Int
is invalid, an error value of type L
produced by passing the given invalid Int
value
to the given function f
, wrapped in a Left
.
A factory/validation method that produces a NegFloat
, wrapped
in a Right
, given a valid Int
value, or if the
given Int
is invalid, an error value of type L
produced by passing the given invalid Int
value
to the given function f
, wrapped in a Left
.
This method will inspect the passed Int
value and if
it is a megative Int
, it will return a NegFloat
representing that value, wrapped in a Right
.
Otherwise, the passed Int
value is not megative, so this
method will return a result of type L
obtained by passing
the invalid Int
value to the given function f
,
wrapped in a Left
.
This factory method differs from the apply
factory method
in that apply
is implemented via a macro that inspects
Int
literals at compile time, whereas this method inspects
Int
values at run time.
- Value parameters:
- value
the
Int
to inspect, and if megative, return wrapped in aRight(NegFloat)
.
- Returns:
the specified
Int
value wrapped in aRight(NegFloat)
, if it is megative, else aLeft(f(value))
.- Source:
- NegFloat.scala
A factory/validation method that produces a NegFloat
, wrapped
in a Success
, given a valid Float
value, or if the
given Float
is invalid, an AssertionError
, wrapped
in a Failure
.
A factory/validation method that produces a NegFloat
, wrapped
in a Success
, given a valid Float
value, or if the
given Float
is invalid, an AssertionError
, wrapped
in a Failure
.
This method will inspect the passed Float
value and if
it is a megative Float
, it will return a NegFloat
representing that value, wrapped in a Success
.
Otherwise, the passed Float
value is not megative, so this
method will return an AssertionError
, wrapped in a Failure
.
This factory method differs from the apply
factory method
in that apply
is implemented via a macro that inspects
Float
literals at compile time, whereas this method inspects
Float
values at run time.
- Value parameters:
- value
the
Float
to inspect, and if megative, return wrapped in aSuccess(NegFloat)
.
- Returns:
the specified
Float
value wrapped in aSuccess(NegFloat)
, if it is megative, else aFailure(AssertionError)
.- Source:
- NegFloat.scala
Concrete fields
The largest value representable as a megative Float
,
which is NegFloat(-1.4E-45)
.
The largest value representable as a megative Float
,
which is NegFloat(-1.4E-45)
.
- Source:
- NegFloat.scala
The smallest value representable as a megative
Float
, which is NegFloat(-3.4028235E38)
.
The smallest value representable as a megative
Float
, which is NegFloat(-3.4028235E38)
.
- Source:
- NegFloat.scala
The negative infinity value, which is NegFloat.ensuringValid(Float.NegativeInfinity)
.
The negative infinity value, which is NegFloat.ensuringValid(Float.NegativeInfinity)
.
- Source:
- NegFloat.scala
Implicits
Implicits
A factory method, implemented via a macro, that produces a
NegFloat
if passed a valid Float
literal, otherwise a compile time error.
A factory method, implemented via a macro, that produces a
NegFloat
if passed a valid Float
literal, otherwise a compile time error.
The macro that implements this method will inspect the
specified Float
expression at compile time. If
the expression is a megative Float
literal,
it will return a NegFloat
representing that value.
Otherwise, the passed Float
expression is either a literal
that is not megative, or is not a literal, so this method
will give a compiler error.
This factory method differs from the from
factory method in that this method is implemented via a
macro that inspects Float
literals at compile
time, whereas from
inspects Float
values at run time.
- Value parameters:
- value
the
Float
literal expression to inspect at compile time, and if megative, to return wrapped in aNegFloat
at run time.
- Returns:
the specified, valid
Float
literal value wrapped in aNegFloat
. (If the specified expression is not a validFloat
literal, the invocation of this method will not compile.)- Source:
- NegFloat.scala
Implicit widening conversion from NegFloat
to
Double
.
Implicit widening conversion from NegFloat
to
Double
.
- Value parameters:
- pos
the
NegFloat
to widen
- Returns:
the
Float
value underlying the specifiedNegFloat
, widened toDouble
.- Source:
- NegFloat.scala
Implicit widening conversion from NegFloat
to
Float
.
Implicit widening conversion from NegFloat
to
Float
.
- Value parameters:
- pos
the
NegFloat
to widen
- Returns:
the
Float
value underlying the specifiedNegFloat
- Source:
- NegFloat.scala
Implicit widening conversion from NegFloat
to NegDouble
.
Implicit widening conversion from NegFloat
to NegDouble
.
- Value parameters:
- pos
the
NegFloat
to widen
- Returns:
the
Float
value underlying the specifiedNegFloat
, widened toDouble
and wrapped in aNegDouble
.- Source:
- NegFloat.scala
Implicit widening conversion from NegFloat
to NegZDouble
.
Implicit widening conversion from NegFloat
to NegZDouble
.
- Value parameters:
- pos
the
NegFloat
to widen
- Returns:
the
Float
value underlying the specifiedNegFloat
, widened toDouble
and wrapped in aNegZDouble
.- Source:
- NegFloat.scala
Implicit widening conversion from NegFloat
to NegZFloat
.
Implicit widening conversion from NegFloat
to NegZFloat
.
- Value parameters:
- pos
the
NegFloat
to widen
- Returns:
the
Float
value underlying the specifiedNegFloat
, widened toFloat
and wrapped in aNegZFloat
.- Source:
- NegFloat.scala
Implicit widening conversion from NegFloat
to NonZeroDouble
.
Implicit widening conversion from NegFloat
to NonZeroDouble
.
- Value parameters:
- pos
the
NegFloat
to widen
- Returns:
the
Float
value underlying the specifiedNegFloat
, widened toDouble
and wrapped in aNonZeroDouble
.- Source:
- NegFloat.scala
Implicit widening conversion from NegFloat
to NonZeroFloat
.
Implicit widening conversion from NegFloat
to NonZeroFloat
.
- Value parameters:
- pos
the
NegFloat
to widen
- Returns:
the
Float
value underlying the specifiedNegFloat
, widened toFloat
and wrapped in aNonZeroFloat
.- Source:
- NegFloat.scala