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

PosFloat

org.scalactic.anyvals.PosFloat
See thePosFloat companion class
object PosFloat

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

Attributes

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

Members list

Value members

Concrete methods

def ensuringValid(value: Float): PosFloat

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

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

Attributes

Returns

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

Throws
AssertionError

if the passed value is not positive

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

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

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

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

Attributes

Returns

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

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

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

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

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

value

the Float to inspect, and if positive, return.

Attributes

Returns

the specified Float value wrapped in a PosFloat, if it is positive, else the default PosFloat value.

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

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

Attributes

Returns

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

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

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

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

Value parameters

value

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

Attributes

Returns

true if the specified Float is positive, else false.

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

Attributes

Returns

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

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

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

Attributes

Returns

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

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

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

Attributes

Returns

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

Source
PosFloat.scala

Concrete fields

final val MaxValue: PosFloat

The largest value representable as a positive Float, which is PosFloat(3.4028235E38).

The largest value representable as a positive Float, which is PosFloat(3.4028235E38).

Attributes

Source
PosFloat.scala
final val MinPositiveValue: PosFloat

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

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

Attributes

Source
PosFloat.scala
final val MinValue: PosFloat

The smallest value representable as a positive Float, which is PosFloat(1.4E-45).

The smallest value representable as a positive Float, which is PosFloat(1.4E-45).

Attributes

Source
PosFloat.scala
final val PositiveInfinity: PosFloat

The positive infinity value, which is PosFloat.ensuringValid(Float.PositiveInfinity).

The positive infinity value, which is PosFloat.ensuringValid(Float.PositiveInfinity).

Attributes

Source
PosFloat.scala

Deprecated fields

val posFloatOrd: Ordering[PosFloat]

The formerly implicit posFloatOrd field has been deprecated and will be removed in a future version of ScalaTest. Please use the ordering field instead.

The formerly implicit posFloatOrd field has been deprecated and will be removed in a future version of ScalaTest. Please use the ordering field instead.

Attributes

Deprecated
true
Source
PosFloat.scala

Implicits

Implicits

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

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

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

Attributes

Returns

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

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

Implicit Ordering instance.

Implicit Ordering instance.

Attributes

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

Implicit widening conversion from PosFloat to Double.

Implicit widening conversion from PosFloat to Double.

Value parameters

pos

the PosFloat to widen

Attributes

Returns

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

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

Implicit widening conversion from PosFloat to Float.

Implicit widening conversion from PosFloat to Float.

Value parameters

pos

the PosFloat to widen

Attributes

Returns

the Float value underlying the specified PosFloat

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

Implicit widening conversion from PosFloat to NonZeroDouble.

Implicit widening conversion from PosFloat to NonZeroDouble.

Value parameters

pos

the PosFloat to widen

Attributes

Returns

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

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

Implicit widening conversion from PosFloat to NonZeroFloat.

Implicit widening conversion from PosFloat to NonZeroFloat.

Value parameters

pos

the PosFloat to widen

Attributes

Returns

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

Source
PosFloat.scala
implicit def widenToPosDouble(pos: PosFloat): PosDouble

Implicit widening conversion from PosFloat to PosDouble.

Implicit widening conversion from PosFloat to PosDouble.

Value parameters

pos

the PosFloat to widen

Attributes

Returns

the Float value underlying the specified PosFloat, widened to Double and wrapped in a PosDouble.

Source
PosFloat.scala
implicit def widenToPosZDouble(pos: PosFloat): PosZDouble

Implicit widening conversion from PosFloat to PosZDouble.

Implicit widening conversion from PosFloat to PosZDouble.

Value parameters

pos

the PosFloat to widen

Attributes

Returns

the Float value underlying the specified PosFloat, widened to Double and wrapped in a PosZDouble.

Source
PosFloat.scala
implicit def widenToPosZFloat(pos: PosFloat): PosZFloat

Implicit widening conversion from PosFloat to PosZFloat.

Implicit widening conversion from PosFloat to PosZFloat.

Value parameters

pos

the PosFloat to widen

Attributes

Returns

the Float value underlying the specified PosFloat, widened to Float and wrapped in a PosZFloat.

Source
PosFloat.scala
Generated with