object NegZFiniteFloat
The companion object for NegZFiniteFloat that offers
factory methods that produce NegZFiniteFloats,
implicit widening conversions from NegZFiniteFloat to
other numeric types, and maximum and minimum constant values
for NegZFiniteFloat.
- Source
- NegZFiniteFloat.scala
- Alphabetic
- By Inheritance
- NegZFiniteFloat
- 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: NegZFiniteFloat
The largest value representable as a finite non-positive
Float, which isNegZFiniteFloat(0.0f). - final val MinValue: NegZFiniteFloat
The smallest value representable as a finite non-positive
Float, which isNegZFiniteFloat(-3.4028235E38). - implicit macro def apply(value: Float): NegZFiniteFloat
A factory method, implemented via a macro, that produces a
NegZFiniteFloatif passed a validFloatliteral, otherwise a compile time error.A factory method, implemented via a macro, that produces a
NegZFiniteFloatif 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 finite non-positiveFloatliteral, it will return aNegZFiniteFloatrepresenting that value. Otherwise, the passedFloatexpression is either a literal that is not finite 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 finite non-positive, to return wrapped in aNegZFiniteFloatat run time.- returns
the specified, valid
Floatliteral value wrapped in aNegZFiniteFloat. (If the specified expression is not a validFloatliteral, 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): NegZFiniteFloat
A factory/assertion method that produces a
NegZFiniteFloatgiven a validFloatvalue, or throwsAssertionError, if given an invalidFloatvalue.A factory/assertion method that produces a
NegZFiniteFloatgiven 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 finite non-positiveFloat, it will return aNegZFiniteFloatrepresenting that value. Otherwise, the passedFloatvalue is not finite 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 finite non-positive, return wrapped in aNegZFiniteFloat.- returns
the specified
Floatvalue wrapped in aNegZFiniteFloat, if it is finite non-positive, else throwsAssertionError.
- Exceptions thrown
AssertionErrorif the passed value is not finite 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[NegZFiniteFloat]
A factory method that produces an
Option[NegZFiniteFloat]given aFloatvalue.A factory method that produces an
Option[NegZFiniteFloat]given aFloatvalue.This method will inspect the passed
Floatvalue and if it is a finite non-positiveFloat, it will return aNegZFiniteFloatrepresenting that value wrapped in aSome. Otherwise, the passedFloatvalue is not finite 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 finite non-positive, return wrapped in aSome[NegZFiniteFloat].- returns
the specified
Floatvalue wrapped in aSome[NegZFiniteFloat], if it is finite non-positive, elseNone.
- def fromOrElse(value: Float, default: => NegZFiniteFloat): NegZFiniteFloat
A factory method that produces a
NegZFiniteFloatgiven aFloatvalue and a defaultNegZFiniteFloat.A factory method that produces a
NegZFiniteFloatgiven aFloatvalue and a defaultNegZFiniteFloat.This method will inspect the passed
Floatvalue and if it is a finite non-positiveFloat, it will return aNegZFiniteFloatrepresenting that value. Otherwise, the passedFloatvalue is not finite 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 finite non-positive, return.- default
the
NegZFiniteFloatto return if the passedFloatvalue is not finite non-positive.- returns
the specified
Floatvalue wrapped in aNegZFiniteFloat, if it is finite non-positive, else thedefaultNegZFiniteFloatvalue.
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def goodOrElse[B](value: Float)(f: (Float) => B): Or[NegZFiniteFloat, B]
A factory/validation method that produces a
NegZFiniteFloat, 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
NegZFiniteFloat, 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 finite non-positiveFloat, it will return aNegZFiniteFloatrepresenting that value, wrapped in aGood. Otherwise, the passedFloatvalue is not finite 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 finite non-positive, return wrapped in aGood(NegZFiniteFloat).- returns
the specified
Floatvalue wrapped in aGood(NegZFiniteFloat), if it is finite non-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: Float): Boolean
A predicate method that returns true if a given
Floatvalue is finite non-positive.A predicate method that returns true if a given
Floatvalue is finite non-positive.- value
the
Floatto inspect, and if finite non-positive, return true.- returns
true if the specified
Floatis finite 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[NegZFiniteFloat]
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 finite non-positiveFloat, it will return aPass. Otherwise, the passedFloatvalue is finite 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 finite non-positive.- returns
a
Passif the specifiedFloatvalue is finite non-positive, else aFailcontaining an error value produced by passing the specifiedFloatto the given functionf.
- def rightOrElse[L](value: Float)(f: (Float) => L): Either[L, NegZFiniteFloat]
A factory/validation method that produces a
NegZFiniteFloat, 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
NegZFiniteFloat, 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 finite non-positiveInt, it will return aNegZFiniteFloatrepresenting that value, wrapped in aRight. Otherwise, the passedIntvalue is not finite 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 finite non-positive, return wrapped in aRight(NegZFiniteFloat).- returns
the specified
Intvalue wrapped in aRight(NegZFiniteFloat), if it is finite non-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: Float): Try[NegZFiniteFloat]
A factory/validation method that produces a
NegZFiniteFloat, wrapped in aSuccess, given a validFloatvalue, or if the givenFloatis invalid, anAssertionError, wrapped in aFailure.A factory/validation method that produces a
NegZFiniteFloat, 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 finite non-positiveFloat, it will return aNegZFiniteFloatrepresenting that value, wrapped in aSuccess. Otherwise, the passedFloatvalue is not finite 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 finite non-positive, return wrapped in aSuccess(NegZFiniteFloat).- returns
the specified
Floatvalue wrapped in aSuccess(NegZFiniteFloat), if it is finite non-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: NegZFiniteFloat): Double
Implicit widening conversion from
NegZFiniteFloattoDouble.Implicit widening conversion from
NegZFiniteFloattoDouble.- pos
the
NegZFiniteFloatto widen- returns
the
Floatvalue underlying the specifiedNegZFiniteFloat, widened toDouble.
- implicit def widenToFiniteDouble(pos: NegZFiniteFloat): FiniteDouble
Implicit widening conversion from
NegZFiniteFloattoFiniteDouble.Implicit widening conversion from
NegZFiniteFloattoFiniteDouble.- pos
the
NegZFiniteFloatto widen- returns
the
Floatvalue underlying the specifiedNegZFiniteFloat, widened toDoubleand wrapped in aFiniteDouble.
- implicit def widenToFloat(pos: NegZFiniteFloat): Float
Implicit widening conversion from
NegZFiniteFloattoFloat.Implicit widening conversion from
NegZFiniteFloattoFloat.- pos
the
NegZFiniteFloatto widen- returns
the
Floatvalue underlying the specifiedNegZFiniteFloat
- implicit def widenToNegZDouble(pos: NegZFiniteFloat): NegZDouble
Implicit widening conversion from
NegZFiniteFloattoNegZDouble.Implicit widening conversion from
NegZFiniteFloattoNegZDouble.- pos
the
NegZFiniteFloatto widen- returns
the
Floatvalue underlying the specifiedNegZFiniteFloat, widened toDoubleand wrapped in aNegZDouble.
- implicit def widenToNegZFiniteDouble(pos: NegZFiniteFloat): NegZFiniteDouble
Implicit widening conversion from
NegZFiniteFloattoNegZFiniteDouble.Implicit widening conversion from
NegZFiniteFloattoNegZFiniteDouble.- pos
the
NegZFiniteFloatto widen- returns
the
Floatvalue underlying the specifiedNegZFiniteFloat, widened toDoubleand wrapped in aNegZFiniteDouble.
- implicit def widenToNegZFloat(pos: NegZFiniteFloat): NegZFloat
Implicit widening conversion from
NegZFiniteFloattoNegZFloat.Implicit widening conversion from
NegZFiniteFloattoNegZFloat.- pos
the
NegZFiniteFloatto widen- returns
the
Floatvalue underlying the specifiedNegZFiniteFloat, widened toFloatand wrapped in aNegZFloat.