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.
Attributes
- Companion
- class
- Source
- PosDouble.scala
- Graph
-
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
PosDouble.type
Members list
Value members
Concrete methods
A factory/assertion method that produces a PosDouble given a valid Double value, or throws AssertionError, if given an invalid Double value.
A factory/assertion method that produces a PosDouble given a valid Double value, or throws AssertionError, if given an invalid Double value.
This method will inspect the passed Double value and if it is a positive Double, it will return a PosDouble representing that value. Otherwise, the passed Double value is not positive, 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 Double literals at compile time, whereas from inspects Double 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 Double is positive.
Value parameters
- value
-
the
Doubleto inspect, and if positive, return wrapped in aPosDouble.
Attributes
- Returns
-
the specified
Doublevalue wrapped in aPosDouble, if it is positive, else throwsAssertionError. - Throws
-
AssertionError
if the passed value is not positive
- Source
- PosDouble.scala
A factory method that produces an Option[PosDouble] given a Double value.
A factory method that produces an Option[PosDouble] given a Double value.
This method will inspect the passed Double value and if it is a positive Double, it will return a PosDouble representing that value, wrapped in a Some. Otherwise, the passed Double value is not positive, 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 Double literals at compile time, whereas from inspects Double values at run time.
Value parameters
- value
-
the
Doubleto inspect, and if positive, return wrapped in aSome[PosDouble].
Attributes
- Returns
-
the specified
Doublevalue wrapped in aSome[PosDouble], if it is PosDouble, elseNone. - Source
- PosDouble.scala
A factory method that produces a PosDouble given a Double value and a default PosDouble.
A factory method that produces a PosDouble given a Double value and a default PosDouble.
This method will inspect the passed Double value and if it is a positive Double, it will return a PosDouble representing that value. Otherwise, the passed Double value is positive, 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 Double literals at compile time, whereas from inspects Double values at run time.
Value parameters
- default
-
the
PosDoubleto return if the passedDoublevalue is not positive. - value
-
the
Doubleto inspect, and if positive, return.
Attributes
- Returns
-
the specified
Doublevalue wrapped in aPosDouble, if it is positive, else thedefaultPosDoublevalue. - Source
- PosDouble.scala
A factory/validation method that produces a PosDouble, wrapped in a Good, given a valid Double value, or if the given Double is invalid, an error value of type B produced by passing the given invalid Double value to the given function f, wrapped in a Bad.
A factory/validation method that produces a PosDouble, wrapped in a Good, given a valid Double value, or if the given Double is invalid, an error value of type B produced by passing the given invalid Double value to the given function f, wrapped in a Bad.
This method will inspect the passed Double value and if it is a positive Double, it will return a PosDouble representing that value, wrapped in a Good. Otherwise, the passed Double value is not positive, so this method will return a result of type B obtained by passing the invalid Double 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 Double literals at compile time, whereas this method inspects Double values at run time.
Value parameters
- value
-
the
Doubleto inspect, and if positive, return wrapped in aGood(PosDouble).
Attributes
- Returns
-
the specified
Doublevalue wrapped in aGood(PosDouble), if it is positive, else aBad(f(value)). - Source
- PosDouble.scala
A predicate method that returns true if a given Double value is positive.
A predicate method that returns true if a given Double value is positive.
Value parameters
- value
-
the
Doubleto inspect, and if positive, return true.
Attributes
- Returns
-
true if the specified
Doubleis positive, else false. - Source
- PosDouble.scala
A validation method that produces a Pass given a valid Double 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 Double 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 Double value and if it is a positive Double, it will return a Pass. Otherwise, the passed Double value is positive, so this method will return a result of type E obtained by passing the invalid Double 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 Double literals at compile time, whereas this method inspects Double values at run time.
Value parameters
- value
-
the
Intto validate that it is positive.
Attributes
- Returns
-
a
Passif the specifiedIntvalue is positive, else aFailcontaining an error value produced by passing the specifiedDoubleto the given functionf. - Source
- PosDouble.scala
A factory/validation method that produces a PosDouble, wrapped in a Right, given a valid Double value, or if the given Double is invalid, an error value of type L produced by passing the given invalid Double value to the given function f, wrapped in a Left.
A factory/validation method that produces a PosDouble, wrapped in a Right, given a valid Double value, or if the given Double is invalid, an error value of type L produced by passing the given invalid Double value to the given function f, wrapped in a Left.
This method will inspect the passed Double value and if it is a positive Double, it will return a PosDouble representing that value, wrapped in a Right. Otherwise, the passed Double value is not positive, so this method will return a result of type L obtained by passing the invalid Double 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 Double literals at compile time, whereas this method inspects Double values at run time.
Value parameters
- value
-
the
Doubleto inspect, and if positive, return wrapped in aRight(PosDouble).
Attributes
- Returns
-
the specified
Doublevalue wrapped in aRight(PosDouble), if it is positive, else aLeft(f(value)). - Source
- PosDouble.scala
A factory/validation method that produces a PosDouble, 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 PosDouble, wrapped in a Success, given a valid Float value, or if the given Float is invalid, an AssertionError, wrapped in a Failure.
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 positive Float, it will return a PosDouble representing that value, wrapped in a Success. Otherwise, the passed Float value is not positive, 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
Floatto inspect, and if positive, return wrapped in aSuccess(PosDouble).
Attributes
- Returns
-
the specified
Floatvalue wrapped in aSuccess(PosDouble), if it is positive, else aFailure(AssertionError). - Source
- PosDouble.scala
Concrete fields
The largest value representable as a positive Double, which is PosDouble(1.7976931348623157E308).
The largest value representable as a positive Double, which is PosDouble(1.7976931348623157E308).
Attributes
- Source
- PosDouble.scala
The smallest positive value greater than 0.0d representable as a PosDouble, which is PosDouble(4.9E-324).
The smallest positive value greater than 0.0d representable as a PosDouble, which is PosDouble(4.9E-324).
Attributes
- Source
- PosDouble.scala
The smallest value representable as a positive Double, which is PosDouble(4.9E-324).
The smallest value representable as a positive Double, which is PosDouble(4.9E-324).
Attributes
- Source
- PosDouble.scala
The positive infinity value, which is PosDouble.ensuringValid(Double.PositiveInfinity).
The positive infinity value, which is PosDouble.ensuringValid(Double.PositiveInfinity).
Attributes
- Source
- PosDouble.scala
Deprecated fields
The formerly implicit posDoubleOrd field has been deprecated and will be removed in a future version of ScalaTest. Please use the ordering field instead.
The formerly implicit posDoubleOrd field has been deprecated and will be removed in a future version of ScalaTest. Please use the ordering field instead.
Attributes
- Deprecated
- true
- Source
- PosDouble.scala
Implicits
Implicits
A factory method, implemented via a macro, that produces a PosDouble if passed a valid Double literal, otherwise a compile time error.
A factory method, implemented via a macro, that produces a PosDouble if passed a valid Double 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 positive Double literal, it will return a PosDouble representing that value. Otherwise, the passed Double expression 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 from factory method in that this method is implemented via a macro that inspects Double literals at compile time, whereas from inspects Double values at run time.
Value parameters
- value
-
the
Doubleliteral expression to inspect at compile time, and if positive, to return wrapped in aPosDoubleat run time.
Attributes
- 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.) - Source
- PosDouble.scala
Implicit Ordering instance.
Implicit widening conversion from PosDouble to Double.
Implicit widening conversion from PosDouble to Double.
Value parameters
- pos
-
the
PosDoubleto widen
Attributes
- Returns
-
the
Doublevalue underlying the specifiedPosDouble - Source
- PosDouble.scala
Implicit widening conversion from PosDouble to NonZeroDouble.
Implicit widening conversion from PosDouble to NonZeroDouble.
Value parameters
- pos
-
the
PosDoubleto widen
Attributes
- Returns
-
the
Doublevalue underlying the specifiedPosDouble, widened toDoubleand wrapped in aNonZeroDouble. - Source
- PosDouble.scala
Implicit widening conversion from PosDouble to PosZDouble.
Implicit widening conversion from PosDouble to PosZDouble.
Value parameters
- pos
-
the
PosDoubleto widen
Attributes
- Returns
-
the
Doublevalue underlying the specifiedPosDouble, widened toDoubleand wrapped in aPosZDouble. - Source
- PosDouble.scala