PosFiniteFloat

Companion class PosFiniteFloat

object PosFiniteFloat

The companion object for PosFiniteFloat that offers factory methods that produce PosFiniteFloats, implicit widening conversions from PosFiniteFloat to other numeric types, and maximum and minimum constant values for PosFiniteFloat.

Source: PosFiniteFloat.scala

Linear Supertypes

AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

PosFiniteFloat
AnyRef
Any

Hide All
Show All

Visibility

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: PosFiniteFloat
The largest value representable as a finite positive Float, which is PosFiniteFloat(3.4028235E38).
final val MinPositiveValue: PosFloat
The smallest positive value greater than 0.0d representable as a PosFloat, which is PosFloat(1.4E-45).
final val MinValue: PosFiniteFloat
The smallest value representable as a finite positive Float, which is PosFiniteFloat(1.4E-45).
implicit macro def apply(value: Float): PosFiniteFloat
A factory method, implemented via a macro, that produces a PosFiniteFloat if passed a valid Float literal, otherwise a compile time error.
A factory method, implemented via a macro, that produces a PosFiniteFloat if passed a valid Float literal, otherwise a compile time error.
The macro that implements this method will inspect the specified Float expression at compile time. If the expression is a finite positive Float literal, it will return a PosFiniteFloat representing that value. Otherwise, the passed Float expression is either a literal that is not finite 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 Float literals at compile time, whereas from inspects Float values at run time.
value
the Float literal expression to inspect at compile time, and if finite positive, to return wrapped in a PosFiniteFloat at run time.
returns
the specified, valid Float literal value wrapped in a PosFiniteFloat. (If the specified expression is not a valid Float literal, 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): PosFiniteFloat
A factory/assertion method that produces a PosFiniteFloat given a valid Float value, or throws AssertionError, if given an invalid Float value.
A factory/assertion method that produces a PosFiniteFloat given a valid Float value, or throws AssertionError, if given an invalid Float value.
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 finite positive Float, it will return a PosFiniteFloat representing that value. Otherwise, the passed Float value is not finite 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 Float literals at compile time, whereas from inspects Float 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 Float is positive.
value
the Float to inspect, and if finite positive, return wrapped in a PosFiniteFloat.
returns
the specified Float value wrapped in a PosFiniteFloat, if it is finite positive, else throws AssertionError.
Exceptions thrown
AssertionError if the passed value is not finite 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[PosFiniteFloat]
A factory method that produces an Option[PosFiniteFloat] given a Float value.
A factory method that produces an Option[PosFiniteFloat] given a Float value.
This method will inspect the passed Float value and if it is a finite positive Float, it will return a PosFiniteFloat representing that value wrapped in a Some. Otherwise, the passed Float value is not finite 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 Float literals at compile time, whereas from inspects Float values at run time.
value
the Float to inspect, and if finite positive, return wrapped in a Some[PosFiniteFloat].
returns
the specified Float value wrapped in a Some[PosFiniteFloat], if it is finite positive, else None.
def fromOrElse(value: Float, default: => PosFiniteFloat): PosFiniteFloat
A factory method that produces a PosFiniteFloat given a Float value and a default PosFiniteFloat.
A factory method that produces a PosFiniteFloat given a Float value and a default PosFiniteFloat.
This method will inspect the passed Float value and if it is a finite positive Float, it will return a PosFiniteFloat representing that value. Otherwise, the passed Float value is not finite 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 Float literals at compile time, whereas from inspects Float values at run time.
value
the Float to inspect, and if finite positive, return.
default
the PosFiniteFloat to return if the passed Float value is not finite positive.
returns
the specified Float value wrapped in a PosFiniteFloat, if it is finite positive, else the default PosFiniteFloat value.
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native()
def goodOrElse[B](value: Float)(f: (Float) => B): Or[PosFiniteFloat, B]
A factory/validation method that produces a PosFiniteFloat, wrapped in a Good, given a valid Float value, or if the given Float is invalid, an error value of type B produced by passing the given invalid Float value to the given function f, wrapped in a Bad.
A factory/validation method that produces a PosFiniteFloat, wrapped in a Good, given a valid Float value, or if the given Float is invalid, an error value of type B produced by passing the given invalid Float value to the given function f, wrapped in a Bad.
This method will inspect the passed Float value and if it is a finite positive Float, it will return a PosFiniteFloat representing that value, wrapped in a Good. Otherwise, the passed Float value is not finite positive, so this method will return a result of type B obtained by passing the invalid Float 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 Float literals at compile time, whereas this method inspects Float values at run time.
value
the Float to inspect, and if finite positive, return wrapped in a Good(PosFiniteFloat).
returns
the specified Float value wrapped in a Good(PosFiniteFloat), if it is finite 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): Boolean
A predicate method that returns true if a given Float value is finite positive.
A predicate method that returns true if a given Float value is finite positive.
value
the Float to inspect, and if finite positive, return true.
returns
true if the specified Float is finite 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[PosFiniteFloat]
Implicit Ordering instance.
def passOrElse[E](value: Float)(f: (Float) => E): Validation[E]
A validation method that produces a Pass given a valid Float 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 Float 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 Float value and if it is a finite positive Float, it will return a Pass. Otherwise, the passed Float value is finite positive, so this method will return a result of type E obtained by passing the invalid Float 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 Float literals at compile time, whereas this method inspects Float values at run time.
value
the Float to validate that it is finite positive.
returns
a Pass if the specified Float value is finite positive, else a Fail containing an error value produced by passing the specified Float to the given function f.
def rightOrElse[L](value: Float)(f: (Float) => L): Either[L, PosFiniteFloat]
A factory/validation method that produces a PosFiniteFloat, wrapped in a Right, given a valid Int value, or if the given Int is invalid, an error value of type L produced by passing the given invalid Int value to the given function f, wrapped in a Left.
A factory/validation method that produces a PosFiniteFloat, wrapped in a Right, given a valid Int value, or if the given Int is invalid, an error value of type L produced by passing the given invalid Int value to the given function f, wrapped in a Left.
This method will inspect the passed Int value and if it is a finite positive Int, it will return a PosFiniteFloat representing that value, wrapped in a Right. Otherwise, the passed Int value is not finite positive, so this method will return a result of type L obtained by passing the invalid Int 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 Int literals at compile time, whereas this method inspects Int values at run time.
value
the Int to inspect, and if finite positive, return wrapped in a Right(PosFiniteFloat).
returns
the specified Int value wrapped in a Right(PosFiniteFloat), if it is finite 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[PosFiniteFloat]
A factory/validation method that produces a PosFiniteFloat, 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 PosFiniteFloat, wrapped in a Success, given a valid Float value, or if the given Float is invalid, an AssertionError, wrapped in a Failure.
This method will inspect the passed Float value and if it is a finite positive Float, it will return a PosFiniteFloat representing that value, wrapped in a Success. Otherwise, the passed Float value is not finite 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
the Float to inspect, and if finite positive, return wrapped in a Success(PosFiniteFloat).
returns
the specified Float value wrapped in a Success(PosFiniteFloat), if it is finite 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: PosFiniteFloat): Double
Implicit widening conversion from PosFiniteFloat to Double.
Implicit widening conversion from PosFiniteFloat to Double.
pos
the PosFiniteFloat to widen
returns
the Float value underlying the specified PosFiniteFloat, widened to Double.
implicit def widenToFiniteDouble(pos: PosFiniteFloat): FiniteDouble
Implicit widening conversion from PosFiniteFloat to FiniteDouble.
Implicit widening conversion from PosFiniteFloat to FiniteDouble.
pos
the PosFiniteFloat to widen
returns
the Float value underlying the specified PosFiniteFloat, widened to Double and wrapped in a FiniteDouble.
implicit def widenToFiniteFloat(pos: PosFiniteFloat): FiniteFloat
Implicit widening conversion from PosFiniteFloat to FiniteFloat.
Implicit widening conversion from PosFiniteFloat to FiniteFloat.
pos
the PosFiniteFloat to widen
returns
the Float value underlying the specified PosFiniteFloat, widened to Float and wrapped in a FiniteFloat.
implicit def widenToFloat(pos: PosFiniteFloat): Float
Implicit widening conversion from PosFiniteFloat to Float.
Implicit widening conversion from PosFiniteFloat to Float.
pos
the PosFiniteFloat to widen
returns
the Float value underlying the specified PosFiniteFloat
implicit def widenToNonZeroDouble(pos: PosFiniteFloat): NonZeroDouble
Implicit widening conversion from PosFiniteFloat to NonZeroDouble.
Implicit widening conversion from PosFiniteFloat to NonZeroDouble.
pos
the PosFiniteFloat to widen
returns
the Float value underlying the specified PosFiniteFloat, widened to Double and wrapped in a NonZeroDouble.
implicit def widenToNonZeroFloat(pos: PosFiniteFloat): NonZeroFloat
Implicit widening conversion from PosFiniteFloat to NonZeroFloat.
Implicit widening conversion from PosFiniteFloat to NonZeroFloat.
pos
the PosFiniteFloat to widen
returns
the Float value underlying the specified PosFiniteFloat, widened to Float and wrapped in a NonZeroFloat.
implicit def widenToPosDouble(pos: PosFiniteFloat): PosDouble
Implicit widening conversion from PosFiniteFloat to PosDouble.
Implicit widening conversion from PosFiniteFloat to PosDouble.
pos
the PosFiniteFloat to widen
returns
the Float value underlying the specified PosFiniteFloat, widened to Double and wrapped in a PosDouble.
implicit def widenToPosFiniteDouble(pos: PosFiniteFloat): PosFiniteDouble
Implicit widening conversion from PosFiniteFloat to PosFiniteDouble.
Implicit widening conversion from PosFiniteFloat to PosFiniteDouble.
pos
the PosFiniteFloat to widen
returns
the Float value underlying the specified PosFiniteFloat, widened to Double and wrapped in a PosFiniteDouble.
implicit def widenToPosFloat(pos: PosFiniteFloat): PosFloat
Implicit widening conversion from PosFiniteFloat to PosFloat.
Implicit widening conversion from PosFiniteFloat to PosFloat.
pos
the PosFiniteFloat to widen
returns
the Float value underlying the specified PosFiniteFloat, widened to Float and wrapped in a PosFloat.
implicit def widenToPosZDouble(pos: PosFiniteFloat): PosZDouble
Implicit widening conversion from PosFiniteFloat to PosZDouble.
Implicit widening conversion from PosFiniteFloat to PosZDouble.
pos
the PosFiniteFloat to widen
returns
the Float value underlying the specified PosFiniteFloat, widened to Double and wrapped in a PosZDouble.
implicit def widenToPosZFiniteDouble(pos: PosFiniteFloat): PosZFiniteDouble
Implicit widening conversion from PosFiniteFloat to PosZFiniteDouble.
Implicit widening conversion from PosFiniteFloat to PosZFiniteDouble.
pos
the PosFiniteFloat to widen
returns
the Float value underlying the specified PosFiniteFloat, widened to Double and wrapped in a PosZFiniteDouble.
implicit def widenToPosZFiniteFloat(pos: PosFiniteFloat): PosZFiniteFloat
Implicit widening conversion from PosFiniteFloat to PosZFiniteFloat.
Implicit widening conversion from PosFiniteFloat to PosZFiniteFloat.
pos
the PosFiniteFloat to widen
returns
the Float value underlying the specified PosFiniteFloat, widened to Float and wrapped in a PosZFiniteFloat.
implicit def widenToPosZFloat(pos: PosFiniteFloat): PosZFloat
Implicit widening conversion from PosFiniteFloat to PosZFloat.
Implicit widening conversion from PosFiniteFloat to PosZFloat.
pos
the PosFiniteFloat to widen
returns
the Float value underlying the specified PosFiniteFloat, widened to Float and wrapped in a PosZFloat.

Packages

PosFiniteFloat

Companion class PosFiniteFloat

object PosFiniteFloat

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

PosFiniteFloat

Companion class PosFiniteFloat

object PosFiniteFloat

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

PosFiniteFloat