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

NegZFiniteDouble

org.scalactic.anyvals.NegZFiniteDouble
See theNegZFiniteDouble companion class
object NegZFiniteDouble

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

Attributes

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

Members list

Value members

Concrete methods

def ensuringValid(value: Double): NegZFiniteDouble

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

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

This method will inspect the passed Double value and if it is a finite non-positive Double, it will return a NegZFiniteDouble representing that value. Otherwise, the passed Double value is not finite 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 Double literals at compile time, whereas from inspects Double 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 Double is finite non-positive.

Value parameters

value

the Double to inspect, and if finite non-positive, return wrapped in a NegZFiniteDouble.

Attributes

Returns

the specified Double value wrapped in a NegZFiniteDouble, if it is finite non-positive, else throws AssertionError.

Throws
AssertionError

if the passed value is not finite non-positive

Source
NegZFiniteDouble.scala
def from(value: Double): Option[NegZFiniteDouble]

A factory method that produces an Option[NegZFiniteDouble] given a Double value.

A factory method that produces an Option[NegZFiniteDouble] given a Double value.

This method will inspect the passed Double value and if it is a finite non-positive Double, it will return a NegZFiniteDouble representing that value, wrapped in a Some. Otherwise, the passed Double value is not finite 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 Double literals at compile time, whereas from inspects Double values at run time.

Value parameters

value

the Double to inspect, and if finite non-positive, return wrapped in a Some[NegZFiniteDouble].

Attributes

Returns

the specified Double value wrapped in a Some[NegZFiniteDouble], if it is NegZFiniteDouble, else None.

Source
NegZFiniteDouble.scala
def fromOrElse(value: Double, default: => NegZFiniteDouble): NegZFiniteDouble

A factory method that produces a NegZFiniteDouble given a Double value and a default NegZFiniteDouble.

A factory method that produces a NegZFiniteDouble given a Double value and a default NegZFiniteDouble.

This method will inspect the passed Double value and if it is a finite non-positive Double, it will return a NegZFiniteDouble representing that value. Otherwise, the passed Double value is finite 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 Double literals at compile time, whereas from inspects Double values at run time.

Value parameters

default

the NegZFiniteDouble to return if the passed Double value is not finite non-positive.

value

the Double to inspect, and if finite non-positive, return.

Attributes

Returns

the specified Double value wrapped in a NegZFiniteDouble, if it is finite non-positive, else the default NegZFiniteDouble value.

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

A factory/validation method that produces a NegZFiniteDouble, wrapped in a Good, given a valid Double value, or if the given Double is invalid, an error value of type B produced by passing the given invalid Double value to the given function f, wrapped in a Bad.

A factory/validation method that produces a NegZFiniteDouble, wrapped in a Good, given a valid Double value, or if the given Double is invalid, an error value of type B produced by passing the given invalid Double value to the given function f, wrapped in a Bad.

This method will inspect the passed Double value and if it is a finite non-positive Double, it will return a NegZFiniteDouble representing that value, wrapped in a Good. Otherwise, the passed Double value is not finite non-positive, so this method will return a result of type B obtained by passing the invalid Double 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 Double literals at compile time, whereas this method inspects Double values at run time.

Value parameters

value

the Double to inspect, and if finite non-positive, return wrapped in a Good(NegZFiniteDouble).

Attributes

Returns

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

Source
NegZFiniteDouble.scala
def isValid(value: Double): Boolean

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

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

Value parameters

value

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

Attributes

Returns

true if the specified Double is positive, else false.

Source
NegZFiniteDouble.scala
def passOrElse[E](value: Double)(f: Double => E): Validation[E]

A validation method that produces a Pass given a valid Double 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 Double 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 Double value and if it is a finite non-positive Double, it will return a Pass. Otherwise, the passed Double value is finite non-positive, so this method will return a result of type E obtained by passing the invalid Double 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 Double literals at compile time, whereas this method inspects Double values at run time.

Value parameters

value

the Int to validate that it is finite non-positive.

Attributes

Returns

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

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

A factory/validation method that produces a NegZFiniteDouble, wrapped in a Right, given a valid Double value, or if the given Double is invalid, an error value of type L produced by passing the given invalid Double value to the given function f, wrapped in a Left.

A factory/validation method that produces a NegZFiniteDouble, wrapped in a Right, given a valid Double value, or if the given Double is invalid, an error value of type L produced by passing the given invalid Double value to the given function f, wrapped in a Left.

This method will inspect the passed Double value and if it is a finite non-positive Double, it will return a NegZFiniteDouble representing that value, wrapped in a Right. Otherwise, the passed Double value is not finite non-positive, so this method will return a result of type L obtained by passing the invalid Double 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 Double literals at compile time, whereas this method inspects Double values at run time.

Value parameters

value

the Double to inspect, and if finite non-positive, return wrapped in a Right(NegZFiniteDouble).

Attributes

Returns

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

Source
NegZFiniteDouble.scala
def tryingValid(value: Double): Try[NegZFiniteDouble]

A factory/validation method that produces a NegZFiniteDouble, 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 NegZFiniteDouble, wrapped in a Success, given a valid Float value, or if the given Float is invalid, an AssertionError, wrapped in a Failure.

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-positive Float, it will return a NegZFiniteDouble representing that value, wrapped in a Success. Otherwise, the passed Float value is not finite 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 finite non-positive, return wrapped in a Success(NegZFiniteDouble).

Attributes

Returns

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

Source
NegZFiniteDouble.scala

Concrete fields

final val MaxValue: NegZFiniteDouble

The largest value representable as a finite non-positive Double, which is NegZFiniteDouble(0.0).

The largest value representable as a finite non-positive Double, which is NegZFiniteDouble(0.0).

Attributes

Source
NegZFiniteDouble.scala
final val MinValue: NegZFiniteDouble

The smallest value representable as a finite non-positive Double, which is NegZFiniteDouble(-1.7976931348623157E308).

The smallest value representable as a finite non-positive Double, which is NegZFiniteDouble(-1.7976931348623157E308).

Attributes

Source
NegZFiniteDouble.scala

Implicits

Implicits

implicit inline def apply(value: => Double): NegZFiniteDouble

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

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

The macro that implements this method will inspect the specified Double expression at compile time. If the expression is a finite non-positive Double literal, it will return a NegZFiniteDouble representing that value. Otherwise, the passed Double expression is either a literal that is not finite 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 Double literals at compile time, whereas from inspects Double values at run time.

Value parameters

value

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

Attributes

Returns

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

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

Implicit Ordering instance.

Implicit Ordering instance.

Attributes

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

Implicit widening conversion from NegZFiniteDouble to Double.

Implicit widening conversion from NegZFiniteDouble to Double.

Value parameters

pos

the NegZFiniteDouble to widen

Attributes

Returns

the Double value underlying the specified NegZFiniteDouble

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

Implicit widening conversion from NegZFiniteDouble to NegZDouble.

Implicit widening conversion from NegZFiniteDouble to NegZDouble.

Value parameters

pos

the NegZFiniteDouble to widen

Attributes

Returns

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

Source
NegZFiniteDouble.scala
Generated with