object PosDouble
The companion object for PosDouble that offers
factory methods that produce PosDoubles,
implicit widening conversions from PosDouble to
other numeric types, and maximum and minimum constant values
for PosDouble.
- Source
- PosDouble.scala
- Alphabetic
- By Inheritance
- PosDouble
- 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: PosDouble
The largest value representable as a positive
Double, which isPosDouble(1.7976931348623157E308). - final val MinPositiveValue: PosDouble
The smallest positive value greater than 0.0d representable as a
PosDouble, which is PosDouble(4.9E-324). - final val MinValue: PosDouble
The smallest value representable as a positive
Double, which isPosDouble(4.9E-324). - final val PositiveInfinity: PosDouble
The positive infinity value, which is
PosDouble.ensuringValid(Double.PositiveInfinity). - implicit macro def apply(value: Double): PosDouble
A factory method, implemented via a macro, that produces a
PosDoubleif passed a validDoubleliteral, otherwise a compile time error.A factory method, implemented via a macro, that produces a
PosDoubleif passed a validDoubleliteral, otherwise a compile time error.The macro that implements this method will inspect the specified
Doubleexpression at compile time. If the expression is a positiveDoubleliteral, it will return aPosDoublerepresenting that value. Otherwise, the passedDoubleexpression is either a literal that is not positive, or is not a literal, so this method will give a compiler error.This factory method differs from the
fromfactory method in that this method is implemented via a macro that inspectsDoubleliterals at compile time, whereasfrominspectsDoublevalues at run time.- value
the
Doubleliteral expression to inspect at compile time, and if positive, to return wrapped in aPosDoubleat run time.- returns
the specified, valid
Doubleliteral value wrapped in aPosDouble. (If the specified expression is not a validDoubleliteral, 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): PosDouble
A factory/assertion method that produces a
PosDoublegiven a validDoublevalue, or throwsAssertionError, if given an invalidDoublevalue.A factory/assertion method that produces a
PosDoublegiven a validDoublevalue, or throwsAssertionError, if given an invalidDoublevalue.This method will inspect the passed
Doublevalue and if it is a positiveDouble, it will return aPosDoublerepresenting that value. Otherwise, the passedDoublevalue is not positive, so this method will throwAssertionError.This factory method differs from the
applyfactory method in thatapplyis implemented via a macro that inspectsDoubleliterals at compile time, whereasfrominspectsDoublevalues at run time. It differs from a vanillaassertorensuringcall in that you get something you didn't already have if the assertion succeeds: a type that promises aDoubleis positive.- value
the
Doubleto inspect, and if positive, return wrapped in aPosDouble.- returns
the specified
Doublevalue wrapped in aPosDouble, if it is positive, else throwsAssertionError.
- Exceptions thrown
AssertionErrorif the passed value is not positive
- 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[PosDouble]
A factory method that produces an
Option[PosDouble]given aDoublevalue.A factory method that produces an
Option[PosDouble]given aDoublevalue.This method will inspect the passed
Doublevalue and if it is a positiveDouble, it will return aPosDoublerepresenting that value, wrapped in aSome. Otherwise, the passedDoublevalue is not positive, so this method will returnNone.This factory method differs from the
applyfactory method in thatapplyis implemented via a macro that inspectsDoubleliterals at compile time, whereasfrominspectsDoublevalues at run time.- value
the
Doubleto inspect, and if positive, return wrapped in aSome[PosDouble].- returns
the specified
Doublevalue wrapped in aSome[PosDouble], if it is PosDouble, elseNone.
- def fromOrElse(value: Double, default: => PosDouble): PosDouble
A factory method that produces a
PosDoublegiven aDoublevalue and a defaultPosDouble.A factory method that produces a
PosDoublegiven aDoublevalue and a defaultPosDouble.This method will inspect the passed
Doublevalue and if it is a positiveDouble, it will return aPosDoublerepresenting that value. Otherwise, the passedDoublevalue is positive, so this method will return the passeddefaultvalue.This factory method differs from the
applyfactory method in thatapplyis implemented via a macro that inspectsDoubleliterals at compile time, whereasfrominspectsDoublevalues at run time.- value
the
Doubleto inspect, and if positive, return.- default
the
PosDoubleto return if the passedDoublevalue is not positive.- returns
the specified
Doublevalue wrapped in aPosDouble, if it is positive, else thedefaultPosDoublevalue.
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def goodOrElse[B](value: Double)(f: (Double) => B): Or[PosDouble, B]
A factory/validation method that produces a
PosDouble, wrapped in aGood, given a validDoublevalue, or if the givenDoubleis invalid, an error value of typeBproduced by passing the given invalidDoublevalue to the given functionf, wrapped in aBad.A factory/validation method that produces a
PosDouble, wrapped in aGood, given a validDoublevalue, or if the givenDoubleis invalid, an error value of typeBproduced by passing the given invalidDoublevalue to the given functionf, wrapped in aBad.This method will inspect the passed
Doublevalue and if it is a positiveDouble, it will return aPosDoublerepresenting that value, wrapped in aGood. Otherwise, the passedDoublevalue is not positive, so this method will return a result of typeBobtained by passing the invalidDoublevalue to the given functionf, wrapped in aBad.This factory method differs from the
applyfactory method in thatapplyis implemented via a macro that inspectsDoubleliterals at compile time, whereas this method inspectsDoublevalues at run time.- value
the
Doubleto inspect, and if positive, return wrapped in aGood(PosDouble).- returns
the specified
Doublevalue wrapped in aGood(PosDouble), if it is positive, 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
Doublevalue is positive.A predicate method that returns true if a given
Doublevalue is positive.- value
the
Doubleto inspect, and if positive, return true.- returns
true if the specified
Doubleis 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[PosDouble]
Implicit Ordering instance.
- def passOrElse[E](value: Double)(f: (Double) => E): Validation[E]
A validation method that produces a
Passgiven a validDoublevalue, or an error value of typeEproduced by passing the given invalidIntvalue to the given functionf, wrapped in aFail.A validation method that produces a
Passgiven a validDoublevalue, or an error value of typeEproduced by passing the given invalidIntvalue to the given functionf, wrapped in aFail.This method will inspect the passed
Doublevalue and if it is a positiveDouble, it will return aPass. Otherwise, the passedDoublevalue is positive, so this method will return a result of typeEobtained by passing the invalidDoublevalue to the given functionf, wrapped in aFail.This factory method differs from the
applyfactory method in thatapplyis implemented via a macro that inspectsDoubleliterals at compile time, whereas this method inspectsDoublevalues at run time.- value
the
Intto validate that it is positive.- returns
a
Passif the specifiedIntvalue is positive, else aFailcontaining an error value produced by passing the specifiedDoubleto the given functionf.
- def rightOrElse[L](value: Double)(f: (Double) => L): Either[L, PosDouble]
A factory/validation method that produces a
PosDouble, wrapped in aRight, given a validDoublevalue, or if the givenDoubleis invalid, an error value of typeLproduced by passing the given invalidDoublevalue to the given functionf, wrapped in aLeft.A factory/validation method that produces a
PosDouble, wrapped in aRight, given a validDoublevalue, or if the givenDoubleis invalid, an error value of typeLproduced by passing the given invalidDoublevalue to the given functionf, wrapped in aLeft.This method will inspect the passed
Doublevalue and if it is a positiveDouble, it will return aPosDoublerepresenting that value, wrapped in aRight. Otherwise, the passedDoublevalue is not positive, so this method will return a result of typeLobtained by passing the invalidDoublevalue to the given functionf, wrapped in aLeft.This factory method differs from the
applyfactory method in thatapplyis implemented via a macro that inspectsDoubleliterals at compile time, whereas this method inspectsDoublevalues at run time.- value
the
Doubleto inspect, and if positive, return wrapped in aRight(PosDouble).- returns
the specified
Doublevalue wrapped in aRight(PosDouble), if it is positive, 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[PosDouble]
A factory/validation method that produces a
PosDouble, wrapped in aSuccess, given a validFloatvalue, or if the givenFloatis invalid, anAssertionError, wrapped in aFailure.A factory/validation method that produces a
PosDouble, wrapped in aSuccess, given a validFloatvalue, or if the givenFloatis 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
ensuringValidcall 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
Floatvalue and if it is a positiveFloat, it will return aPosDoublerepresenting that value, wrapped in aSuccess. Otherwise, the passedFloatvalue is not positive, so this method will return anAssertionError, wrapped in aFailure.This factory method differs from the
applyfactory method in thatapplyis implemented via a macro that inspectsFloatliterals at compile time, whereas this method inspectsFloatvalues at run time.- value
the
Floatto inspect, and if positive, return wrapped in aSuccess(PosDouble).- returns
the specified
Floatvalue wrapped in aSuccess(PosDouble), if it is positive, 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: PosDouble): Double
Implicit widening conversion from
PosDoubletoDouble.Implicit widening conversion from
PosDoubletoDouble.- pos
the
PosDoubleto widen- returns
the
Doublevalue underlying the specifiedPosDouble
- implicit def widenToNonZeroDouble(pos: PosDouble): NonZeroDouble
Implicit widening conversion from
PosDoubletoNonZeroDouble.Implicit widening conversion from
PosDoubletoNonZeroDouble.- pos
the
PosDoubleto widen- returns
the
Doublevalue underlying the specifiedPosDouble, widened toDoubleand wrapped in aNonZeroDouble.
- implicit def widenToPosZDouble(pos: PosDouble): PosZDouble
Implicit widening conversion from
PosDoubletoPosZDouble.Implicit widening conversion from
PosDoubletoPosZDouble.- pos
the
PosDoubleto widen- returns
the
Doublevalue underlying the specifiedPosDouble, widened toDoubleand wrapped in aPosZDouble.
Deprecated Value Members
- val posDoubleOrd: Ordering[PosDouble]
The formerly implicit
posDoubleOrdfield has been deprecated and will be removed in a future version of ScalaTest. Please use theorderingfield instead.The formerly implicit
posDoubleOrdfield has been deprecated and will be removed in a future version of ScalaTest. Please use theorderingfield instead.- Annotations
- @deprecated
- Deprecated
The formerly implicit posDoubleOrd field has been deprecated and will be removed in a future version of ScalaTest. Please use the ordering field instead.