object NegDouble
The companion object for NegDouble that offers
factory methods that produce NegDoubles,
implicit widening conversions from NegDouble to
other numeric types, and maximum and minimum constant values
for NegDouble.
- Source
- NegDouble.scala
- Alphabetic
- By Inheritance
- NegDouble
- 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: NegDouble
The largest value representable as a negative
Double, which isNegDouble(-4.9E-324). - final val MinValue: NegDouble
The smallest value representable as a negative
Double, which isNegDouble(-1.7976931348623157E308). - final val NegativeInfinity: NegDouble
The negative infinity value, which is
NegDouble.ensuringValid(Double.NegativeInfinity). - implicit macro def apply(value: Double): NegDouble
A factory method, implemented via a macro, that produces a
NegDoubleif passed a validDoubleliteral, otherwise a compile time error.A factory method, implemented via a macro, that produces a
NegDoubleif 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 negativeDoubleliteral, it will return aNegDoublerepresenting that value. Otherwise, the passedDoubleexpression is either a literal that is not negative, 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 negative, to return wrapped in aNegDoubleat run time.- returns
the specified, valid
Doubleliteral value wrapped in aNegDouble. (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): NegDouble
A factory/assertion method that produces a
NegDoublegiven a validDoublevalue, or throwsAssertionError, if given an invalidDoublevalue.A factory/assertion method that produces a
NegDoublegiven a validDoublevalue, or throwsAssertionError, if given an invalidDoublevalue.This method will inspect the passed
Doublevalue and if it is a negativeDouble, it will return aNegDoublerepresenting that value. Otherwise, the passedDoublevalue is not negative, 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 negative.- value
the
Doubleto inspect, and if negative, return wrapped in aNegDouble.- returns
the specified
Doublevalue wrapped in aNegDouble, if it is negative, else throwsAssertionError.
- Exceptions thrown
AssertionErrorif the passed value is not negative
- 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[NegDouble]
A factory method that produces an
Option[NegDouble]given aDoublevalue.A factory method that produces an
Option[NegDouble]given aDoublevalue.This method will inspect the passed
Doublevalue and if it is a negativeDouble, it will return aNegDoublerepresenting that value, wrapped in aSome. Otherwise, the passedDoublevalue is not negative, 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 negative, return wrapped in aSome[NegDouble].- returns
the specified
Doublevalue wrapped in aSome[NegDouble], if it is NegDouble, elseNone.
- def fromOrElse(value: Double, default: => NegDouble): NegDouble
A factory method that produces a
NegDoublegiven aDoublevalue and a defaultNegDouble.A factory method that produces a
NegDoublegiven aDoublevalue and a defaultNegDouble.This method will inspect the passed
Doublevalue and if it is a negativeDouble, it will return aNegDoublerepresenting that value. Otherwise, the passedDoublevalue is negative, 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 negative, return.- default
the
NegDoubleto return if the passedDoublevalue is not negative.- returns
the specified
Doublevalue wrapped in aNegDouble, if it is negative, else thedefaultNegDoublevalue.
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def goodOrElse[B](value: Double)(f: (Double) => B): Or[NegDouble, B]
A factory/validation method that produces a
NegDouble, 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
NegDouble, 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 negativeDouble, it will return aNegDoublerepresenting that value, wrapped in aGood. Otherwise, the passedDoublevalue is not negative, 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 negative, return wrapped in aGood(NegDouble).- returns
the specified
Doublevalue wrapped in aGood(NegDouble), if it is negative, 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 negative.A predicate method that returns true if a given
Doublevalue is negative.- value
the
Doubleto inspect, and if negative, 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[NegDouble]
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 negativeDouble, it will return aPass. Otherwise, the passedDoublevalue is negative, 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 negative.- returns
a
Passif the specifiedIntvalue is negative, else aFailcontaining an error value produced by passing the specifiedDoubleto the given functionf.
- def rightOrElse[L](value: Double)(f: (Double) => L): Either[L, NegDouble]
A factory/validation method that produces a
NegDouble, 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
NegDouble, 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 negativeDouble, it will return aNegDoublerepresenting that value, wrapped in aRight. Otherwise, the passedDoublevalue is not negative, 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 negative, return wrapped in aRight(NegDouble).- returns
the specified
Doublevalue wrapped in aRight(NegDouble), if it is negative, 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[NegDouble]
A factory/validation method that produces a
NegDouble, wrapped in aSuccess, given a validFloatvalue, or if the givenFloatis invalid, anAssertionError, wrapped in aFailure.A factory/validation method that produces a
NegDouble, 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 negativeFloat, it will return aNegDoublerepresenting that value, wrapped in aSuccess. Otherwise, the passedFloatvalue is not negative, 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 negative, return wrapped in aSuccess(NegDouble).- returns
the specified
Floatvalue wrapped in aSuccess(NegDouble), if it is negative, 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: NegDouble): Double
Implicit widening conversion from
NegDoubletoDouble.Implicit widening conversion from
NegDoubletoDouble.- pos
the
NegDoubleto widen- returns
the
Doublevalue underlying the specifiedNegDouble
- implicit def widenToNegZDouble(pos: NegDouble): NegZDouble
Implicit widening conversion from
NegDoubletoNegZDouble.Implicit widening conversion from
NegDoubletoNegZDouble.- pos
the
NegDoubleto widen- returns
the
Doublevalue underlying the specifiedNegDouble, widened toDoubleand wrapped in aNegZDouble.
- implicit def widenToNonZeroDouble(pos: NegDouble): NonZeroDouble
Implicit widening conversion from
NegDoubletoNonZeroDouble.Implicit widening conversion from
NegDoubletoNonZeroDouble.- pos
the
NegDoubleto widen- returns
the
Doublevalue underlying the specifiedNegDouble, widened toDoubleand wrapped in aNonZeroDouble.