NegZFloat

object NegZFloat

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

Companion:
class
Source:
NegZFloat.scala
class Object
trait Matchable
class Any

Value members

Concrete methods

def ensuringValid(value: Float): NegZFloat

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

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

the Float to inspect, and if non-positive, return wrapped in a NegZFloat.

Returns:

the specified Float value wrapped in a NegZFloat, if it is non-positive, else throws AssertionError.

Throws:
AssertionError

if the passed value is not non-positive

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

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

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

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

the Float to inspect, and if non-positive, return wrapped in a Some[NegZFloat].

Returns:

the specified Float value wrapped in a Some[NegZFloat], if it is non-positive, else None.

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

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

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

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

the NegZFloat to return if the passed Float value is not non-positive.

value

the Float to inspect, and if non-positive, return.

Returns:

the specified Float value wrapped in a NegZFloat, if it is non-positive, else the default NegZFloat value.

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

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

the Float to inspect, and if non-positive, return wrapped in a Good(NegZFloat).

Returns:

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

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

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

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

Value parameters:
value

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

Returns:

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

Source:
NegZFloat.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 non-positive Float, it will return a Pass. Otherwise, the passed Float value is non-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 parameters:
value

the Float to validate that it is non-positive.

Returns:

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

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

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

the Int to inspect, and if non-positive, return wrapped in a Right(NegZFloat).

Returns:

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

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

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

the Float to inspect, and if non-positive, return wrapped in a Success(NegZFloat).

Returns:

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

Source:
NegZFloat.scala

Concrete fields

final val MaxValue: NegZFloat

The largest value representable as a non-positive Float, which is NegZFloat(0.0f).

The largest value representable as a non-positive Float, which is NegZFloat(0.0f).

Source:
NegZFloat.scala
final val MinValue: NegZFloat

The smallest value representable as a non-positive Float, which is NegZFloat(-3.4028235E38).

The smallest value representable as a non-positive Float, which is NegZFloat(-3.4028235E38).

Source:
NegZFloat.scala

The negative infinity value, which is NegZFloat.ensuringValid(Float.NegativeInfinity).

The negative infinity value, which is NegZFloat.ensuringValid(Float.NegativeInfinity).

Source:
NegZFloat.scala

Implicits

Implicits

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

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

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

the Float literal expression to inspect at compile time, and if non-positive, to return wrapped in a NegZFloat at run time.

Returns:

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

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

Implicit Ordering instance.

Implicit Ordering instance.

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

Implicit widening conversion from NegZFloat to Double.

Implicit widening conversion from NegZFloat to Double.

Value parameters:
pos

the NegZFloat to widen

Returns:

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

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

Implicit widening conversion from NegZFloat to Float.

Implicit widening conversion from NegZFloat to Float.

Value parameters:
pos

the NegZFloat to widen

Returns:

the Float value underlying the specified NegZFloat

Source:
NegZFloat.scala

Implicit widening conversion from NegZFloat to NegZDouble.

Implicit widening conversion from NegZFloat to NegZDouble.

Value parameters:
pos

the NegZFloat to widen

Returns:

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

Source:
NegZFloat.scala