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

NegFiniteFloat

org.scalactic.anyvals.NegFiniteFloat
See theNegFiniteFloat companion class
object NegFiniteFloat

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

Attributes

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

Members list

Value members

Concrete methods

def ensuringValid(value: Float): NegFiniteFloat

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

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

Attributes

Returns

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

Throws
AssertionError

if the passed value is not finite negative

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

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

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

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

Attributes

Returns

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

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

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

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

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

value

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

Attributes

Returns

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

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

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

Attributes

Returns

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

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

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

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

Value parameters

value

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

Attributes

Returns

true if the specified Float is finite negative, else false.

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

Attributes

Returns

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

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

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

Attributes

Returns

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

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

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

Attributes

Returns

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

Source
NegFiniteFloat.scala

Concrete fields

final val MaxValue: NegFiniteFloat

The largest value representable as a finite negative Float, which is NegFiniteFloat(-1.4E-45).

The largest value representable as a finite negative Float, which is NegFiniteFloat(-1.4E-45).

Attributes

Source
NegFiniteFloat.scala
final val MinValue: NegFiniteFloat

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

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

Attributes

Source
NegFiniteFloat.scala

Implicits

Implicits

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

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

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

Attributes

Returns

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

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

Implicit Ordering instance.

Implicit Ordering instance.

Attributes

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

Implicit widening conversion from NegFiniteFloat to Double.

Implicit widening conversion from NegFiniteFloat to Double.

Value parameters

pos

the NegFiniteFloat to widen

Attributes

Returns

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

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

Implicit widening conversion from NegFiniteFloat to FiniteDouble.

Implicit widening conversion from NegFiniteFloat to FiniteDouble.

Value parameters

pos

the NegFiniteFloat to widen

Attributes

Returns

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

Source
NegFiniteFloat.scala
implicit def widenToFiniteFloat(pos: NegFiniteFloat): FiniteFloat

Implicit widening conversion from NegFiniteFloat to FiniteFloat.

Implicit widening conversion from NegFiniteFloat to FiniteFloat.

Value parameters

pos

the NegFiniteFloat to widen

Attributes

Returns

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

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

Implicit widening conversion from NegFiniteFloat to Float.

Implicit widening conversion from NegFiniteFloat to Float.

Value parameters

pos

the NegFiniteFloat to widen

Attributes

Returns

the Float value underlying the specified NegFiniteFloat

Source
NegFiniteFloat.scala
implicit def widenToNegDouble(pos: NegFiniteFloat): NegDouble

Implicit widening conversion from NegFiniteFloat to NegDouble.

Implicit widening conversion from NegFiniteFloat to NegDouble.

Value parameters

pos

the NegFiniteFloat to widen

Attributes

Returns

the Float value underlying the specified NegFiniteFloat, widened to Double and wrapped in a NegDouble.

Source
NegFiniteFloat.scala
implicit def widenToNegFiniteDouble(pos: NegFiniteFloat): NegFiniteDouble

Implicit widening conversion from NegFiniteFloat to NegFiniteDouble.

Implicit widening conversion from NegFiniteFloat to NegFiniteDouble.

Value parameters

pos

the NegFiniteFloat to widen

Attributes

Returns

the Float value underlying the specified NegFiniteFloat, widened to Double and wrapped in a NegFiniteDouble.

Source
NegFiniteFloat.scala
implicit def widenToNegFloat(pos: NegFiniteFloat): NegFloat

Implicit widening conversion from NegFiniteFloat to NegFloat.

Implicit widening conversion from NegFiniteFloat to NegFloat.

Value parameters

pos

the NegFiniteFloat to widen

Attributes

Returns

the Float value underlying the specified NegFiniteFloat, widened to Float and wrapped in a NegFloat.

Source
NegFiniteFloat.scala
implicit def widenToNegZDouble(pos: NegFiniteFloat): NegZDouble

Implicit widening conversion from NegFiniteFloat to NegZDouble.

Implicit widening conversion from NegFiniteFloat to NegZDouble.

Value parameters

pos

the NegFiniteFloat to widen

Attributes

Returns

the Float value underlying the specified NegFiniteFloat, widened to Double and wrapped in a NegZDouble.

Source
NegFiniteFloat.scala
implicit def widenToNegZFiniteDouble(pos: NegFiniteFloat): NegZFiniteDouble

Implicit widening conversion from NegFiniteFloat to NegZFiniteDouble.

Implicit widening conversion from NegFiniteFloat to NegZFiniteDouble.

Value parameters

pos

the NegFiniteFloat to widen

Attributes

Returns

the Float value underlying the specified NegFiniteFloat, widened to Double and wrapped in a NegZFiniteDouble.

Source
NegFiniteFloat.scala
implicit def widenToNegZFiniteFloat(pos: NegFiniteFloat): NegZFiniteFloat

Implicit widening conversion from NegFiniteFloat to NegZFiniteFloat.

Implicit widening conversion from NegFiniteFloat to NegZFiniteFloat.

Value parameters

pos

the NegFiniteFloat to widen

Attributes

Returns

the Float value underlying the specified NegFiniteFloat, widened to Float and wrapped in a NegZFiniteFloat.

Source
NegFiniteFloat.scala
implicit def widenToNegZFloat(pos: NegFiniteFloat): NegZFloat

Implicit widening conversion from NegFiniteFloat to NegZFloat.

Implicit widening conversion from NegFiniteFloat to NegZFloat.

Value parameters

pos

the NegFiniteFloat to widen

Attributes

Returns

the Float value underlying the specified NegFiniteFloat, widened to Float and wrapped in a NegZFloat.

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

Implicit widening conversion from NegFiniteFloat to NonZeroDouble.

Implicit widening conversion from NegFiniteFloat to NonZeroDouble.

Value parameters

pos

the NegFiniteFloat to widen

Attributes

Returns

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

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

Implicit widening conversion from NegFiniteFloat to NonZeroFloat.

Implicit widening conversion from NegFiniteFloat to NonZeroFloat.

Value parameters

pos

the NegFiniteFloat to widen

Attributes

Returns

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

Source
NegFiniteFloat.scala
Generated with