object NonZeroFiniteDouble
The companion object for NonZeroFiniteDouble
that offers
factory methods that produce NonZeroFiniteDouble
s,
implicit widening conversions from NonZeroFiniteDouble
to
other numeric types, and maximum and minimum constant values
for NonZeroFiniteDouble
.
- Alphabetic
- By Inheritance
- NonZeroFiniteDouble
- 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: NonZeroFiniteDouble
The largest value representable as a finite non-zero
Double
, which isNonZeroFiniteDouble(1.7976931348623157E308)
. - final val MinPositiveValue: NonZeroFiniteDouble
The smallest positive value greater than 0.0d representable as a
NonZeroFiniteDouble
, which is NonZeroFiniteDouble(4.9E-324). - final val MinValue: NonZeroFiniteDouble
The smallest value representable as a finite non-zero
Double
, which isNonZeroFiniteDouble(-1.7976931348623157E308)
. - implicit macro def apply(value: Double): NonZeroFiniteDouble
A factory method, implemented via a macro, that produces a
NonZeroFiniteDouble
if passed a validDouble
literal, otherwise a compile time error.A factory method, implemented via a macro, that produces a
NonZeroFiniteDouble
if passed a validDouble
literal, otherwise a compile time error.The macro that implements this method will inspect the specified
Double
expression at compile time. If the expression is a finite non-zeroDouble
literal, it will return aNonZeroFiniteDouble
representing that value. Otherwise, the passedDouble
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 inspectsDouble
literals at compile time, whereasfrom
inspectsDouble
values at run time.- value
the
Double
literal expression to inspect at compile time, and if finite non-zero, to return wrapped in aNonZeroFiniteDouble
at run time.- returns
the specified, valid
Double
literal value wrapped in aNonZeroFiniteDouble
. (If the specified expression is not a validDouble
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: Double): NonZeroFiniteDouble
A factory/assertion method that produces a
NonZeroFiniteDouble
given a validDouble
value, or throwsAssertionError
, if given an invalidDouble
value.A factory/assertion method that produces a
NonZeroFiniteDouble
given a validDouble
value, or throwsAssertionError
, if given an invalidDouble
value.This method will inspect the passed
Double
value and if it is a finite non-zeroDouble
, it will return aNonZeroFiniteDouble
representing that value. Otherwise, the passedDouble
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 inspectsDouble
literals at compile time, whereasfrom
inspectsDouble
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 aDouble
is finite non-zero.- value
the
Double
to inspect, and if finite non-zero, return wrapped in aNonZeroFiniteDouble
.- returns
the specified
Double
value wrapped in aNonZeroFiniteDouble
, 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: Double): Option[NonZeroFiniteDouble]
A factory method that produces an
Option[NonZeroFiniteDouble]
given aDouble
value.A factory method that produces an
Option[NonZeroFiniteDouble]
given aDouble
value.This method will inspect the passed
Double
value and if it is a finite non-zeroDouble
, it will return aNonZeroFiniteDouble
representing that value, wrapped in aSome
. Otherwise, the passedDouble
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 inspectsDouble
literals at compile time, whereasfrom
inspectsDouble
values at run time.- value
the
Double
to inspect, and if finite non-zero, return wrapped in aSome[NonZeroFiniteDouble]
.- returns
the specified
Double
value wrapped in aSome[NonZeroFiniteDouble]
, if it is NonZeroFiniteDouble, elseNone
.
- def fromOrElse(value: Double, default: => NonZeroFiniteDouble): NonZeroFiniteDouble
A factory method that produces a
NonZeroFiniteDouble
given aDouble
value and a defaultNonZeroFiniteDouble
.A factory method that produces a
NonZeroFiniteDouble
given aDouble
value and a defaultNonZeroFiniteDouble
.This method will inspect the passed
Double
value and if it is a finite non-zeroDouble
, it will return aNonZeroFiniteDouble
representing that value. Otherwise, the passedDouble
value is 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 inspectsDouble
literals at compile time, whereasfrom
inspectsDouble
values at run time.- value
the
Double
to inspect, and if finite non-zero, return.- default
the
NonZeroFiniteDouble
to return if the passedDouble
value is not finite non-zero.- returns
the specified
Double
value wrapped in aNonZeroFiniteDouble
, if it is finite non-zero, else thedefault
NonZeroFiniteDouble
value.
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def goodOrElse[B](value: Double)(f: (Double) => B): Or[NonZeroFiniteDouble, B]
A factory/validation method that produces a
NonZeroFiniteDouble
, wrapped in aGood
, given a validDouble
value, or if the givenDouble
is invalid, an error value of typeB
produced by passing the given invalidDouble
value to the given functionf
, wrapped in aBad
.A factory/validation method that produces a
NonZeroFiniteDouble
, wrapped in aGood
, given a validDouble
value, or if the givenDouble
is invalid, an error value of typeB
produced by passing the given invalidDouble
value to the given functionf
, wrapped in aBad
.This method will inspect the passed
Double
value and if it is a finite non-zeroDouble
, it will return aNonZeroFiniteDouble
representing that value, wrapped in aGood
. Otherwise, the passedDouble
value is not finite non-zero, so this method will return a result of typeB
obtained by passing the invalidDouble
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 inspectsDouble
literals at compile time, whereas this method inspectsDouble
values at run time.- value
the
Double
to inspect, and if finite non-zero, return wrapped in aGood(NonZeroFiniteDouble)
.- returns
the specified
Double
value wrapped in aGood(NonZeroFiniteDouble)
, 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: Double): Boolean
A predicate method that returns true if a given
Double
value is finite non-zero.A predicate method that returns true if a given
Double
value is finite non-zero.- value
the
Double
to inspect, and if finite non-zero, return true.- returns
true if the specified
Double
is positive, 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[NonZeroFiniteDouble]
Implicit Ordering instance.
- def passOrElse[E](value: Double)(f: (Double) => E): Validation[E]
A validation method that produces a
Pass
given a validDouble
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 validDouble
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
Double
value and if it is a finite non-zeroDouble
, it will return aPass
. Otherwise, the passedDouble
value is finite non-zero, so this method will return a result of typeE
obtained by passing the invalidDouble
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 inspectsDouble
literals at compile time, whereas this method inspectsDouble
values at run time.- value
the
Int
to validate that it is finite non-zero.- returns
a
Pass
if the specifiedInt
value is finite non-zero, else aFail
containing an error value produced by passing the specifiedDouble
to the given functionf
.
- def rightOrElse[L](value: Double)(f: (Double) => L): Either[L, NonZeroFiniteDouble]
A factory/validation method that produces a
NonZeroFiniteDouble
, wrapped in aRight
, given a validDouble
value, or if the givenDouble
is invalid, an error value of typeL
produced by passing the given invalidDouble
value to the given functionf
, wrapped in aLeft
.A factory/validation method that produces a
NonZeroFiniteDouble
, wrapped in aRight
, given a validDouble
value, or if the givenDouble
is invalid, an error value of typeL
produced by passing the given invalidDouble
value to the given functionf
, wrapped in aLeft
.This method will inspect the passed
Double
value and if it is a finite non-zeroDouble
, it will return aNonZeroFiniteDouble
representing that value, wrapped in aRight
. Otherwise, the passedDouble
value is not finite non-zero, so this method will return a result of typeL
obtained by passing the invalidDouble
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 inspectsDouble
literals at compile time, whereas this method inspectsDouble
values at run time.- value
the
Double
to inspect, and if finite non-zero, return wrapped in aRight(NonZeroFiniteDouble)
.- returns
the specified
Double
value wrapped in aRight(NonZeroFiniteDouble)
, 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: Double): Try[NonZeroFiniteDouble]
A factory/validation method that produces a
NonZeroFiniteDouble
, wrapped in aSuccess
, given a validFloat
value, or if the givenFloat
is invalid, anAssertionError
, wrapped in aFailure
.A factory/validation method that produces a
NonZeroFiniteDouble
, wrapped in aSuccess
, given a validFloat
value, or if the givenFloat
is invalid, anAssertionError
, wrapped in aFailure
.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 aNonZeroFiniteDouble
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(NonZeroFiniteDouble)
.- returns
the specified
Float
value wrapped in aSuccess(NonZeroFiniteDouble)
, 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: NonZeroFiniteDouble): Double
Implicit widening conversion from
NonZeroFiniteDouble
toDouble
.Implicit widening conversion from
NonZeroFiniteDouble
toDouble
.- pos
the
NonZeroFiniteDouble
to widen- returns
the
Double
value underlying the specifiedNonZeroFiniteDouble
- implicit def widenToNonZeroDouble(pos: NonZeroFiniteDouble): NonZeroDouble
Implicit widening conversion from
NonZeroFiniteDouble
toNonZeroDouble
.Implicit widening conversion from
NonZeroFiniteDouble
toNonZeroDouble
.- pos
the
NonZeroFiniteDouble
to widen- returns
the
Double
value underlying the specifiedNonZeroFiniteDouble
, widened toDouble
and wrapped in aNonZeroDouble
.