Scalactic 3.3.0-alpha.1
API
Generated with
Scalactic 3.3.0-alpha.1/org.scalactic/org.scalactic.anyvals/FiniteFloat

FiniteFloat

org.scalactic.anyvals.FiniteFloat
See theFiniteFloat companion class
object FiniteFloat

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

Attributes

Companion
class
Source
FiniteFloat.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Value members

Concrete methods

def ensuringValid(value: Float): FiniteFloat

A factory/assertion method that produces a FiniteFloat given a valid Float value, or throws AssertionError, if given an invalid Float value.

A factory/assertion method that produces a FiniteFloat 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 Float, it will return a FiniteFloat representing that value. Otherwise, the passed Float value is not finite, 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 parameters

value

the Float to inspect, and if finite, return wrapped in a FiniteFloat.

Attributes

Returns

the specified Float value wrapped in a FiniteFloat, if it is finite, else throws AssertionError.

Throws
AssertionError

if the passed value is not finite

Source
FiniteFloat.scala
def from(value: Float): Option[FiniteFloat]

A factory method that produces an Option[FiniteFloat] given a Float value.

A factory method that produces an Option[FiniteFloat] given a Float value.

This method will inspect the passed Float value and if it is a finite Float, it will return a FiniteFloat representing that value wrapped in a Some. Otherwise, the passed Float value is not finite, 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 parameters

value

the Float to inspect, and if finite, return wrapped in a Some[FiniteFloat].

Attributes

Returns

the specified Float value wrapped in a Some[FiniteFloat], if it is finite, else None.

Source
FiniteFloat.scala
def fromOrElse(value: Float, default: => FiniteFloat): FiniteFloat

A factory method that produces a FiniteFloat given a Float value and a default FiniteFloat.

A factory method that produces a FiniteFloat given a Float value and a default FiniteFloat.

This method will inspect the passed Float value and if it is a finite Float, it will return a FiniteFloat representing that value. Otherwise, the passed Float value is not finite, 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 parameters

default

the FiniteFloat to return if the passed Float value is not finite.

value

the Float to inspect, and if finite, return.

Attributes

Returns

the specified Float value wrapped in a FiniteFloat, if it is finite, else the default FiniteFloat value.

Source
FiniteFloat.scala
def goodOrElse[B](value: Float)(f: Float => B): Or[FiniteFloat, B]

A factory/validation method that produces a FiniteFloat, 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 FiniteFloat, 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 Float, it will return a FiniteFloat representing that value, wrapped in a Good. Otherwise, the passed Float value is not finite, 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 parameters

value

the Float to inspect, and if finite, return wrapped in a Good(FiniteFloat).

Attributes

Returns

the specified Float value wrapped in a Good(FiniteFloat), if it is finite, else a Bad(f(value)).

Source
FiniteFloat.scala
def isValid(value: Float): Boolean

A predicate method that returns true if a given Float value is finite.

A predicate method that returns true if a given Float value is finite.

Value parameters

value

the Float to inspect, and if finite, return true.

Attributes

Returns

true if the specified Float is finite, else false.

Source
FiniteFloat.scala
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 Float, it will return a Pass. Otherwise, the passed Float value is finite, 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 parameters

value

the Float to validate that it is finite.

Attributes

Returns

a Pass if the specified Float value is finite, else a Fail containing an error value produced by passing the specified Float to the given function f.

Source
FiniteFloat.scala
def rightOrElse[L](value: Float)(f: Float => L): Either[L, FiniteFloat]

A factory/validation method that produces a FiniteFloat, 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 FiniteFloat, 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 Int, it will return a FiniteFloat representing that value, wrapped in a Right. Otherwise, the passed Int value is not finite, 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 parameters

value

the Int to inspect, and if finite, return wrapped in a Right(FiniteFloat).

Attributes

Returns

the specified Int value wrapped in a Right(FiniteFloat), if it is finite, else a Left(f(value)).

Source
FiniteFloat.scala
def tryingValid(value: Float): Try[FiniteFloat]

A factory/validation method that produces a FiniteFloat, 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 FiniteFloat, 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 Float, it will return a FiniteFloat representing that value, wrapped in a Success. Otherwise, the passed Float value is not finite, 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 Float to inspect, and if finite, return wrapped in a Success(FiniteFloat).

Attributes

Returns

the specified Float value wrapped in a Success(FiniteFloat), if it is finite, else a Failure(AssertionError).

Source
FiniteFloat.scala

Concrete fields

final val MaxValue: FiniteFloat

The largest value representable as a finite Float, which is FiniteFloat(3.4028235E38).

The largest value representable as a finite Float, which is FiniteFloat(3.4028235E38).

Attributes

Source
FiniteFloat.scala
final val MinPositiveValue: FiniteFloat

The smallest positive value greater than 0.0d representable as a FiniteFloat, which is FiniteFloat(1.4E-45).

The smallest positive value greater than 0.0d representable as a FiniteFloat, which is FiniteFloat(1.4E-45).

Attributes

Source
FiniteFloat.scala
final val MinValue: FiniteFloat

The smallest value representable as a finite Float, which is FiniteFloat(-3.4028235E38).

The smallest value representable as a finite Float, which is FiniteFloat(-3.4028235E38).

Attributes

Source
FiniteFloat.scala

Implicits

Implicits

implicit inline def apply(value: => Float): FiniteFloat

A factory method, implemented via a macro, that produces a FiniteFloat if passed a valid Float literal, otherwise a compile time error.

A factory method, implemented via a macro, that produces a FiniteFloat 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 Float literal, it will return a FiniteFloat representing that value. Otherwise, the passed Float expression is either a literal that is not finite, 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 parameters

value

the Float literal expression to inspect at compile time, and if finite, to return wrapped in a FiniteFloat at run time.

Attributes

Returns

the specified, valid Float literal value wrapped in a FiniteFloat. (If the specified expression is not a valid Float literal, the invocation of this method will not compile.)

Source
FiniteFloat.scala
implicit val ordering: Ordering[FiniteFloat]

Implicit Ordering instance.

Implicit Ordering instance.

Attributes

Source
FiniteFloat.scala
implicit def widenToDouble(pos: FiniteFloat): Double

Implicit widening conversion from FiniteFloat to Double.

Implicit widening conversion from FiniteFloat to Double.

Value parameters

pos

the FiniteFloat to widen

Attributes

Returns

the Float value underlying the specified FiniteFloat, widened to Double.

Source
FiniteFloat.scala
implicit def widenToFiniteDouble(pos: FiniteFloat): FiniteDouble

Implicit widening conversion from FiniteFloat to FiniteDouble.

Implicit widening conversion from FiniteFloat to FiniteDouble.

Value parameters

pos

the FiniteFloat to widen

Attributes

Returns

the Float value underlying the specified FiniteFloat, widened to Double and wrapped in a FiniteDouble.

Source
FiniteFloat.scala
implicit def widenToFloat(pos: FiniteFloat): Float

Implicit widening conversion from FiniteFloat to Float.

Implicit widening conversion from FiniteFloat to Float.

Value parameters

pos

the FiniteFloat to widen

Attributes

Returns

the Float value underlying the specified FiniteFloat

Source
FiniteFloat.scala
Generated with