object NegZFloat
The companion object for NegZFloat that offers
factory methods that produce NegZFloats,
implicit widening conversions from NegZFloat to
other numeric types, and maximum and minimum constant values
for NegZFloat.
- Source
- NegZFloat.scala
- Alphabetic
- By Inheritance
- NegZFloat
- 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: NegZFloatThe largest value representable as a non-positive Float, which isNegZFloat(0.0f).
-   final  val MinValue: NegZFloatThe smallest value representable as a non-positive Float, which isNegZFloat(-3.4028235E38).
-   final  val NegativeInfinity: NegZFloatThe negative infinity value, which is NegZFloat.ensuringValid(Float.NegativeInfinity).
-   implicit macro  def apply(value: Float): NegZFloatA factory method, implemented via a macro, that produces a NegZFloatif passed a validFloatliteral, otherwise a compile time error.A factory method, implemented via a macro, that produces a NegZFloatif passed a validFloatliteral, otherwise a compile time error.The macro that implements this method will inspect the specified Floatexpression at compile time. If the expression is a non-positiveFloatliteral, it will return aNegZFloatrepresenting that value. Otherwise, the passedFloatexpression is either a literal that is not non-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 inspectsFloatliterals at compile time, whereasfrominspectsFloatvalues at run time.- value
- the - Floatliteral expression to inspect at compile time, and if non-positive, to return wrapped in a- NegZFloatat run time.
- returns
- the specified, valid - Floatliteral value wrapped in a- NegZFloat. (If the specified expression is not a valid- Floatliteral, 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): NegZFloatA factory/assertion method that produces a NegZFloatgiven a validFloatvalue, or throwsAssertionError, if given an invalidFloatvalue.A factory/assertion method that produces a NegZFloatgiven a validFloatvalue, or throwsAssertionError, if given an invalidFloatvalue.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 non-positiveFloat, it will return aNegZFloatrepresenting that value. Otherwise, the passedFloatvalue is not non-positive, so this method will throwAssertionError.This factory method differs from the applyfactory method in thatapplyis implemented via a macro that inspectsFloatliterals at compile time, whereasfrominspectsFloatvalues 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 aFloatis positive.- value
- the - Floatto inspect, and if non-positive, return wrapped in a- NegZFloat.
- returns
- the specified - Floatvalue wrapped in a- NegZFloat, if it is non-positive, else throws- AssertionError.
 - Exceptions thrown
- AssertionErrorif the passed value is not non-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: Float): Option[NegZFloat]A factory method that produces an Option[NegZFloat]given aFloatvalue.A factory method that produces an Option[NegZFloat]given aFloatvalue.This method will inspect the passed Floatvalue and if it is a non-positiveFloat, it will return aNegZFloatrepresenting that value wrapped in aSome. Otherwise, the passedFloatvalue is not non-positive, so this method will returnNone.This factory method differs from the applyfactory method in thatapplyis implemented via a macro that inspectsFloatliterals at compile time, whereasfrominspectsFloatvalues at run time.- value
- the - Floatto inspect, and if non-positive, return wrapped in a- Some[NegZFloat].
- returns
- the specified - Floatvalue wrapped in a- Some[NegZFloat], if it is non-positive, else- None.
 
-    def fromOrElse(value: Float, default: => NegZFloat): NegZFloatA factory method that produces a NegZFloatgiven aFloatvalue and a defaultNegZFloat.A factory method that produces a NegZFloatgiven aFloatvalue and a defaultNegZFloat.This method will inspect the passed Floatvalue and if it is a non-positiveFloat, it will return aNegZFloatrepresenting that value. Otherwise, the passedFloatvalue is not non-positive, so this method will return the passeddefaultvalue.This factory method differs from the applyfactory method in thatapplyis implemented via a macro that inspectsFloatliterals at compile time, whereasfrominspectsFloatvalues at run time.- value
- the - Floatto inspect, and if non-positive, return.
- default
- the - NegZFloatto return if the passed- Floatvalue is not non-positive.
- returns
- the specified - Floatvalue wrapped in a- NegZFloat, if it is non-positive, else the- default- NegZFloatvalue.
 
-   final  def getClass(): Class[_ <: AnyRef]- Definition Classes
- AnyRef → Any
- Annotations
- @native()
 
-    def goodOrElse[B](value: Float)(f: (Float) => B): Or[NegZFloat, B]A factory/validation method that produces a NegZFloat, wrapped in aGood, given a validFloatvalue, or if the givenFloatis invalid, an error value of typeBproduced by passing the given invalidFloatvalue to the given functionf, wrapped in aBad.A factory/validation method that produces a NegZFloat, wrapped in aGood, given a validFloatvalue, or if the givenFloatis invalid, an error value of typeBproduced by passing the given invalidFloatvalue to the given functionf, wrapped in aBad.This method will inspect the passed Floatvalue and if it is a non-positiveFloat, it will return aNegZFloatrepresenting that value, wrapped in aGood. Otherwise, the passedFloatvalue is not non-positive, so this method will return a result of typeBobtained by passing the invalidFloatvalue to the given functionf, wrapped in aBad.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 non-positive, return wrapped in a- Good(NegZFloat).
- returns
- the specified - Floatvalue wrapped in a- Good(NegZFloat), if it is non-positive, else a- Bad(f(value)).
 
-    def hashCode(): Int- Definition Classes
- AnyRef → Any
- Annotations
- @native()
 
-   final  def isInstanceOf[T0]: Boolean- Definition Classes
- Any
 
-    def isValid(value: Float): BooleanA predicate method that returns true if a given Floatvalue is non-positive.A predicate method that returns true if a given Floatvalue is non-positive.- value
- the - Floatto inspect, and if non-positive, return true.
- returns
- true if the specified - Floatis non-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[NegZFloat]Implicit Ordering instance. 
-    def passOrElse[E](value: Float)(f: (Float) => E): Validation[E]A validation method that produces a Passgiven a validFloatvalue, 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 validFloatvalue, or an error value of typeEproduced by passing the given invalidIntvalue to the given functionf, wrapped in aFail.This method will inspect the passed Floatvalue and if it is a non-positiveFloat, it will return aPass. Otherwise, the passedFloatvalue is non-positive, so this method will return a result of typeEobtained by passing the invalidFloatvalue to the given functionf, wrapped in aFail.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 validate that it is non-positive.
- returns
- a - Passif the specified- Floatvalue is non-positive, else a- Failcontaining an error value produced by passing the specified- Floatto the given function- f.
 
-    def rightOrElse[L](value: Float)(f: (Float) => L): Either[L, NegZFloat]A factory/validation method that produces a NegZFloat, wrapped in aRight, given a validIntvalue, or if the givenIntis invalid, an error value of typeLproduced by passing the given invalidIntvalue to the given functionf, wrapped in aLeft.A factory/validation method that produces a NegZFloat, wrapped in aRight, given a validIntvalue, or if the givenIntis invalid, an error value of typeLproduced by passing the given invalidIntvalue to the given functionf, wrapped in aLeft.This method will inspect the passed Intvalue and if it is a non-positiveInt, it will return aNegZFloatrepresenting that value, wrapped in aRight. Otherwise, the passedIntvalue is not non-positive, so this method will return a result of typeLobtained by passing the invalidIntvalue to the given functionf, wrapped in aLeft.This factory method differs from the applyfactory method in thatapplyis implemented via a macro that inspectsIntliterals at compile time, whereas this method inspectsIntvalues at run time.- value
- the - Intto inspect, and if non-positive, return wrapped in a- Right(NegZFloat).
- returns
- the specified - Intvalue wrapped in a- Right(NegZFloat), if it is non-positive, else a- Left(f(value)).
 
-   final  def synchronized[T0](arg0: => T0): T0- Definition Classes
- AnyRef
 
-    def toString(): String- Definition Classes
- AnyRef → Any
 
-    def tryingValid(value: Float): Try[NegZFloat]A factory/validation method that produces a NegZFloat, wrapped in aSuccess, given a validFloatvalue, or if the givenFloatis invalid, anAssertionError, wrapped in aFailure.A factory/validation method that produces a NegZFloat, wrapped in aSuccess, given a validFloatvalue, or if the givenFloatis invalid, anAssertionError, wrapped in aFailure.This method will inspect the passed Floatvalue and if it is a non-positiveFloat, it will return aNegZFloatrepresenting that value, wrapped in aSuccess. Otherwise, the passedFloatvalue is not non-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 non-positive, return wrapped in a- Success(NegZFloat).
- returns
- the specified - Floatvalue wrapped in a- Success(NegZFloat), if it is non-positive, else a- Failure(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: NegZFloat): DoubleImplicit widening conversion from NegZFloattoDouble.Implicit widening conversion from NegZFloattoDouble.- pos
- the - NegZFloatto widen
- returns
- the - Floatvalue underlying the specified- NegZFloat, widened to- Double.
 
-   implicit  def widenToFloat(pos: NegZFloat): FloatImplicit widening conversion from NegZFloattoFloat.Implicit widening conversion from NegZFloattoFloat.- pos
- the - NegZFloatto widen
- returns
- the - Floatvalue underlying the specified- NegZFloat
 
-   implicit  def widenToNegZDouble(pos: NegZFloat): NegZDoubleImplicit widening conversion from NegZFloattoNegZDouble.Implicit widening conversion from NegZFloattoNegZDouble.- pos
- the - NegZFloatto widen
- returns
- the - Floatvalue underlying the specified- NegZFloat, widened to- Doubleand wrapped in a- NegZDouble.