object NonZeroFiniteFloat
The companion object for NonZeroFiniteFloat
that offers
factory methods that produce NonZeroFiniteFloat
s,
implicit widening conversions from NonZeroFiniteFloat
to
other numeric types, and maximum and minimum constant values
for NonZeroFiniteFloat
.
- Source
- NonZeroFiniteFloat.scala
- Alphabetic
- By Inheritance
- NonZeroFiniteFloat
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final val MaxValue: NonZeroFiniteFloat
The largest value representable as a finite non-zero
Float
, which isNonZeroFiniteFloat(3.4028235E38)
. - final val MinPositiveValue: NonZeroFiniteFloat
The smallest positive value greater than 0.0d representable as a
NonZeroFiniteFloat
, which is NonZeroFiniteFloat(1.4E-45). - final val MinValue: NonZeroFiniteFloat
The smallest value representable as a finite non-zero
Float
, which isNonZeroFiniteFloat(-3.4028235E38)
. - implicit macro def apply(value: Float): NonZeroFiniteFloat
A factory method, implemented via a macro, that produces a
NonZeroFiniteFloat
if passed a validFloat
literal, otherwise a compile time error.A factory method, implemented via a macro, that produces a
NonZeroFiniteFloat
if passed a validFloat
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 finite non-zeroFloat
literal, it will return aNonZeroFiniteFloat
representing that value. Otherwise, the passedFloat
expression is either a literal that is not finite non-zero, 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 inspectsFloat
literals at compile time, whereasfrom
inspectsFloat
values at run time.- value
the
Float
literal expression to inspect at compile time, and if finite non-zero, to return wrapped in aNonZeroFiniteFloat
at run time.- returns
the specified, valid
Float
literal value wrapped in aNonZeroFiniteFloat
. (If the specified expression is not a validFloat
literal, the invocation of this method will not compile.)
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def ensuringValid(value: Float): NonZeroFiniteFloat
A factory/assertion method that produces a
NonZeroFiniteFloat
given a validFloat
value, or throwsAssertionError
, if given an invalidFloat
value.A factory/assertion method that produces a
NonZeroFiniteFloat
given a validFloat
value, or throwsAssertionError
, if given an invalidFloat
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
, orrightOrElse
.This method will inspect the passed
Float
value and if it is a finite non-zeroFloat
, it will return aNonZeroFiniteFloat
representing that value. Otherwise, the passedFloat
value is not finite non-zero, so this method will throwAssertionError
.This factory method differs from the
apply
factory method in thatapply
is implemented via a macro that inspectsFloat
literals at compile time, whereasfrom
inspectsFloat
values at run time. It differs from a vanillaassert
orensuring
call in that you get something you didn't already have if the assertion succeeds: a type that promises aFloat
is positive.- value
the
Float
to inspect, and if finite non-zero, return wrapped in aNonZeroFiniteFloat
.- returns
the specified
Float
value wrapped in aNonZeroFiniteFloat
, if it is finite non-zero, else throwsAssertionError
.
- Exceptions thrown
AssertionError
if the passed value is not finite non-zero
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def from(value: Float): Option[NonZeroFiniteFloat]
A factory method that produces an
Option[NonZeroFiniteFloat]
given aFloat
value.A factory method that produces an
Option[NonZeroFiniteFloat]
given aFloat
value.This method will inspect the passed
Float
value and if it is a finite non-zeroFloat
, it will return aNonZeroFiniteFloat
representing that value wrapped in aSome
. Otherwise, the passedFloat
value is not finite non-zero, so this method will returnNone
.This factory method differs from the
apply
factory method in thatapply
is implemented via a macro that inspectsFloat
literals at compile time, whereasfrom
inspectsFloat
values at run time.- value
the
Float
to inspect, and if finite non-zero, return wrapped in aSome[NonZeroFiniteFloat]
.- returns
the specified
Float
value wrapped in aSome[NonZeroFiniteFloat]
, if it is finite non-zero, elseNone
.
- def fromOrElse(value: Float, default: => NonZeroFiniteFloat): NonZeroFiniteFloat
A factory method that produces a
NonZeroFiniteFloat
given aFloat
value and a defaultNonZeroFiniteFloat
.A factory method that produces a
NonZeroFiniteFloat
given aFloat
value and a defaultNonZeroFiniteFloat
.This method will inspect the passed
Float
value and if it is a finite non-zeroFloat
, it will return aNonZeroFiniteFloat
representing that value. Otherwise, the passedFloat
value is not finite non-zero, so this method will return the passeddefault
value.This factory method differs from the
apply
factory method in thatapply
is implemented via a macro that inspectsFloat
literals at compile time, whereasfrom
inspectsFloat
values at run time.- value
the
Float
to inspect, and if finite non-zero, return.- default
the
NonZeroFiniteFloat
to return if the passedFloat
value is not finite non-zero.- returns
the specified
Float
value wrapped in aNonZeroFiniteFloat
, if it is finite non-zero, else thedefault
NonZeroFiniteFloat
value.
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def goodOrElse[B](value: Float)(f: (Float) => B): Or[NonZeroFiniteFloat, B]
A factory/validation method that produces a
NonZeroFiniteFloat
, wrapped in aGood
, given a validFloat
value, or if the givenFloat
is invalid, an error value of typeB
produced by passing the given invalidFloat
value to the given functionf
, wrapped in aBad
.A factory/validation method that produces a
NonZeroFiniteFloat
, wrapped in aGood
, given a validFloat
value, or if the givenFloat
is invalid, an error value of typeB
produced by passing the given invalidFloat
value to the given functionf
, wrapped in aBad
.This method will inspect the passed
Float
value and if it is a finite non-zeroFloat
, it will return aNonZeroFiniteFloat
representing that value, wrapped in aGood
. Otherwise, the passedFloat
value is not finite non-zero, so this method will return a result of typeB
obtained by passing the invalidFloat
value to the given functionf
, wrapped in aBad
.This factory method differs from the
apply
factory method in thatapply
is implemented via a macro that inspectsFloat
literals at compile time, whereas this method inspectsFloat
values at run time.- value
the
Float
to inspect, and if finite non-zero, return wrapped in aGood(NonZeroFiniteFloat)
.- returns
the specified
Float
value wrapped in aGood(NonZeroFiniteFloat)
, if it is finite non-zero, else aBad(f(value))
.
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isValid(value: Float): Boolean
A predicate method that returns true if a given
Float
value is finite non-zero.A predicate method that returns true if a given
Float
value is finite non-zero.- value
the
Float
to inspect, and if finite non-zero, return true.- returns
true if the specified
Float
is finite non-zero, else false.
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- implicit val ordering: Ordering[NonZeroFiniteFloat]
Implicit Ordering instance.
- def passOrElse[E](value: Float)(f: (Float) => E): Validation[E]
A validation method that produces a
Pass
given a validFloat
value, or an error value of typeE
produced by passing the given invalidInt
value to the given functionf
, wrapped in aFail
.A validation method that produces a
Pass
given a validFloat
value, or an error value of typeE
produced by passing the given invalidInt
value to the given functionf
, wrapped in aFail
.This method will inspect the passed
Float
value and if it is a finite non-zeroFloat
, it will return aPass
. Otherwise, the passedFloat
value is finite non-zero, so this method will return a result of typeE
obtained by passing the invalidFloat
value to the given functionf
, wrapped in aFail
.This factory method differs from the
apply
factory method in thatapply
is implemented via a macro that inspectsFloat
literals at compile time, whereas this method inspectsFloat
values at run time.- value
the
Float
to validate that it is finite non-zero.- returns
a
Pass
if the specifiedFloat
value is finite non-zero, else aFail
containing an error value produced by passing the specifiedFloat
to the given functionf
.
- def rightOrElse[L](value: Float)(f: (Float) => L): Either[L, NonZeroFiniteFloat]
A factory/validation method that produces a
NonZeroFiniteFloat
, wrapped in aRight
, given a validInt
value, or if the givenInt
is invalid, an error value of typeL
produced by passing the given invalidInt
value to the given functionf
, wrapped in aLeft
.A factory/validation method that produces a
NonZeroFiniteFloat
, wrapped in aRight
, given a validInt
value, or if the givenInt
is invalid, an error value of typeL
produced by passing the given invalidInt
value to the given functionf
, wrapped in aLeft
.This method will inspect the passed
Int
value and if it is a finite non-zeroInt
, it will return aNonZeroFiniteFloat
representing that value, wrapped in aRight
. Otherwise, the passedInt
value is not finite non-zero, so this method will return a result of typeL
obtained by passing the invalidInt
value to the given functionf
, wrapped in aLeft
.This factory method differs from the
apply
factory method in thatapply
is implemented via a macro that inspectsInt
literals at compile time, whereas this method inspectsInt
values at run time.- value
the
Int
to inspect, and if finite non-zero, return wrapped in aRight(NonZeroFiniteFloat)
.- returns
the specified
Int
value wrapped in aRight(NonZeroFiniteFloat)
, if it is finite non-zero, else aLeft(f(value))
.
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- def tryingValid(value: Float): Try[NonZeroFiniteFloat]
A factory/validation method that produces a
NonZeroFiniteFloat
, wrapped in aSuccess
, given a validFloat
value, or if the givenFloat
is invalid, anAssertionError
, wrapped in aFailure
.A factory/validation method that produces a
NonZeroFiniteFloat
, wrapped in aSuccess
, given a validFloat
value, or if the givenFloat
is invalid, anAssertionError
, wrapped in aFailure
.This method will inspect the passed
Float
value and if it is a finite non-zeroFloat
, it will return aNonZeroFiniteFloat
representing that value, wrapped in aSuccess
. Otherwise, the passedFloat
value is not finite non-zero, so this method will return anAssertionError
, wrapped in aFailure
.This factory method differs from the
apply
factory method in thatapply
is implemented via a macro that inspectsFloat
literals at compile time, whereas this method inspectsFloat
values at run time.- value
the
Float
to inspect, and if finite non-zero, return wrapped in aSuccess(NonZeroFiniteFloat)
.- returns
the specified
Float
value wrapped in aSuccess(NonZeroFiniteFloat)
, if it is finite non-zero, else aFailure(AssertionError)
.
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- implicit def widenToDouble(pos: NonZeroFiniteFloat): Double
Implicit widening conversion from
NonZeroFiniteFloat
toDouble
.Implicit widening conversion from
NonZeroFiniteFloat
toDouble
.- pos
the
NonZeroFiniteFloat
to widen- returns
the
Float
value underlying the specifiedNonZeroFiniteFloat
, widened toDouble
.
- implicit def widenToFiniteDouble(pos: NonZeroFiniteFloat): FiniteDouble
Implicit widening conversion from
NonZeroFiniteFloat
toFiniteDouble
.Implicit widening conversion from
NonZeroFiniteFloat
toFiniteDouble
.- pos
the
NonZeroFiniteFloat
to widen- returns
the
Float
value underlying the specifiedNonZeroFiniteFloat
, widened toDouble
and wrapped in aFiniteDouble
.
- implicit def widenToFloat(pos: NonZeroFiniteFloat): Float
Implicit widening conversion from
NonZeroFiniteFloat
toFloat
.Implicit widening conversion from
NonZeroFiniteFloat
toFloat
.- pos
the
NonZeroFiniteFloat
to widen- returns
the
Float
value underlying the specifiedNonZeroFiniteFloat
- implicit def widenToNonZeroDouble(pos: NonZeroFiniteFloat): NonZeroDouble
Implicit widening conversion from
NonZeroFiniteFloat
toNonZeroDouble
.Implicit widening conversion from
NonZeroFiniteFloat
toNonZeroDouble
.- pos
the
NonZeroFiniteFloat
to widen- returns
the
Float
value underlying the specifiedNonZeroFiniteFloat
, widened toDouble
and wrapped in aNonZeroDouble
.
- implicit def widenToNonZeroFiniteDouble(pos: NonZeroFiniteFloat): NonZeroFiniteDouble
Implicit widening conversion from
NonZeroFiniteFloat
toNonZeroFiniteDouble
.Implicit widening conversion from
NonZeroFiniteFloat
toNonZeroFiniteDouble
.- pos
the
NonZeroFiniteFloat
to widen- returns
the
Float
value underlying the specifiedNonZeroFiniteFloat
, widened toDouble
and wrapped in aNonZeroFiniteDouble
.
- implicit def widenToNonZeroFloat(pos: NonZeroFiniteFloat): NonZeroFloat
Implicit widening conversion from
NonZeroFiniteFloat
toNonZeroFloat
.Implicit widening conversion from
NonZeroFiniteFloat
toNonZeroFloat
.- pos
the
NonZeroFiniteFloat
to widen- returns
the
Float
value underlying the specifiedNonZeroFiniteFloat
, widened toFloat
and wrapped in aNonZeroFloat
.