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

NonZeroFiniteFloat

org.scalactic.anyvals.NonZeroFiniteFloat
See theNonZeroFiniteFloat companion class
object NonZeroFiniteFloat

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

Attributes

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

Members list

Value members

Concrete methods

def ensuringValid(value: Float): NonZeroFiniteFloat

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

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

Attributes

Returns

the specified Float value wrapped in a NonZeroFiniteFloat, if it is finite non-zero, else throws AssertionError.

Throws
AssertionError

if the passed value is not finite non-zero

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

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

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

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

Attributes

Returns

the specified Float value wrapped in a Some[NonZeroFiniteFloat], if it is finite non-zero, else None.

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

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

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

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

value

the Float to inspect, and if finite non-zero, return.

Attributes

Returns

the specified Float value wrapped in a NonZeroFiniteFloat, if it is finite non-zero, else the default NonZeroFiniteFloat value.

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

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

Attributes

Returns

the specified Float value wrapped in a Good(NonZeroFiniteFloat), if it is finite non-zero, else a Bad(f(value)).

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

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

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

Value parameters

value

the Float to inspect, and if finite non-zero, return true.

Attributes

Returns

true if the specified Float is finite non-zero, else false.

Source
NonZeroFiniteFloat.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 non-zero Float, it will return a Pass. Otherwise, the passed Float value is finite non-zero, 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 non-zero.

Attributes

Returns

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

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

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

Attributes

Returns

the specified Int value wrapped in a Right(NonZeroFiniteFloat), if it is finite non-zero, else a Left(f(value)).

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

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

Attributes

Returns

the specified Float value wrapped in a Success(NonZeroFiniteFloat), if it is finite non-zero, else a Failure(AssertionError).

Source
NonZeroFiniteFloat.scala

Concrete fields

final val MaxValue: NonZeroFiniteFloat

The largest value representable as a finite non-zero Float, which is NonZeroFiniteFloat(3.4028235E38).

The largest value representable as a finite non-zero Float, which is NonZeroFiniteFloat(3.4028235E38).

Attributes

Source
NonZeroFiniteFloat.scala
final val MinPositiveValue: NonZeroFiniteFloat

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

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

Attributes

Source
NonZeroFiniteFloat.scala
final val MinValue: NonZeroFiniteFloat

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

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

Attributes

Source
NonZeroFiniteFloat.scala

Implicits

Implicits

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

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

A factory method, implemented via a macro, that produces a NonZeroFiniteFloat 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 non-zero Float literal, it will return a NonZeroFiniteFloat representing that value. Otherwise, the passed Float expression is either a literal that is not finite non-zero, 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 non-zero, to return wrapped in a NonZeroFiniteFloat at run time.

Attributes

Returns

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

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

Implicit Ordering instance.

Implicit Ordering instance.

Attributes

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

Implicit widening conversion from NonZeroFiniteFloat to Double.

Implicit widening conversion from NonZeroFiniteFloat to Double.

Value parameters

pos

the NonZeroFiniteFloat to widen

Attributes

Returns

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

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

Implicit widening conversion from NonZeroFiniteFloat to FiniteDouble.

Implicit widening conversion from NonZeroFiniteFloat to FiniteDouble.

Value parameters

pos

the NonZeroFiniteFloat to widen

Attributes

Returns

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

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

Implicit widening conversion from NonZeroFiniteFloat to Float.

Implicit widening conversion from NonZeroFiniteFloat to Float.

Value parameters

pos

the NonZeroFiniteFloat to widen

Attributes

Returns

the Float value underlying the specified NonZeroFiniteFloat

Source
NonZeroFiniteFloat.scala
implicit def widenToNonZeroDouble(pos: NonZeroFiniteFloat): NonZeroDouble

Implicit widening conversion from NonZeroFiniteFloat to NonZeroDouble.

Implicit widening conversion from NonZeroFiniteFloat to NonZeroDouble.

Value parameters

pos

the NonZeroFiniteFloat to widen

Attributes

Returns

the Float value underlying the specified NonZeroFiniteFloat, widened to Double and wrapped in a NonZeroDouble.

Source
NonZeroFiniteFloat.scala
implicit def widenToNonZeroFiniteDouble(pos: NonZeroFiniteFloat): NonZeroFiniteDouble

Implicit widening conversion from NonZeroFiniteFloat to NonZeroFiniteDouble.

Implicit widening conversion from NonZeroFiniteFloat to NonZeroFiniteDouble.

Value parameters

pos

the NonZeroFiniteFloat to widen

Attributes

Returns

the Float value underlying the specified NonZeroFiniteFloat, widened to Double and wrapped in a NonZeroFiniteDouble.

Source
NonZeroFiniteFloat.scala
implicit def widenToNonZeroFloat(pos: NonZeroFiniteFloat): NonZeroFloat

Implicit widening conversion from NonZeroFiniteFloat to NonZeroFloat.

Implicit widening conversion from NonZeroFiniteFloat to NonZeroFloat.

Value parameters

pos

the NonZeroFiniteFloat to widen

Attributes

Returns

the Float value underlying the specified NonZeroFiniteFloat, widened to Float and wrapped in a NonZeroFloat.

Source
NonZeroFiniteFloat.scala
Generated with