Packages

object numeric extends NumericInference

Module for numeric predicates. Predicates that take type parameters support both shapeless' natural numbers (Nat) and numeric singleton types (which are made available by shapeless' Witness - abbreviated as W in refined) which include subtypes of Int, Long, Double, Char etc.

Example: 

scala> import eu.timepit.refined.api.Refined
     | import eu.timepit.refined.numeric.Greater
     | import shapeless.nat._5

scala> refineMV[Greater[_5]](10)
res1: Int Refined Greater[_5] = 10

scala> refineMV[Greater[W.`1.5`.T]](1.6)
res2: Double Refined Greater[W.`1.5`.T] = 1.6

Note: generic.Equal can also be used for numeric types.

Source
numeric.scala
Linear Supertypes
NumericInference, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. numeric
  2. NumericInference
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type Divisible[N] = Modulo[N, _0]

    Predicate that checks if an integral value is evenly divisible by N.

  2. type Even = Modulo[shapeless.Nat._2, _0]

    Predicate that checks if an integral value is evenly divisible by 2.

  3. final case class Greater[N](n: N) extends Product with Serializable

    Predicate that checks if a numeric value is greater than N.

  4. type GreaterEqual[N] = Not[Less[N]]

    Predicate that checks if a numeric value is greater than or equal to N.

  5. final case class Less[N](n: N) extends Product with Serializable

    Predicate that checks if a numeric value is less than N.

  6. type LessEqual[N] = Not[Greater[N]]

    Predicate that checks if a numeric value is less than or equal to N.

  7. final case class Modulo[N, O](n: N, o: O) extends Product with Serializable

    Predicate that checks if an integral value modulo N is O.

  8. type Negative = Less[_0]

    Predicate that checks if a numeric value is negative (< 0).

  9. type NonDivisible[N] = Not[Divisible[N]]

    Predicate that checks if an integral value is not evenly divisible by N.

  10. final case class NonNaN() extends Product with Serializable

    Predicate that checks if a floating-point number value is not NaN.

  11. type NonNegative = Not[Negative]

    Predicate that checks if a numeric value is zero or positive (>= 0).

  12. type NonPositive = Not[Positive]

    Predicate that checks if a numeric value is zero or negative (<= 0).

  13. type Odd = Not[Even]

    Predicate that checks if an integral value is not evenly divisible by 2.

  14. type Positive = Greater[_0]

    Predicate that checks if a numeric value is positive (> 0).

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. implicit def greaterEqualInference[A]: ==>[Greater[A], GreaterEqual[A]]
    Definition Classes
    NumericInference
  11. implicit def greaterInference[C, A, B](implicit wa: WitnessAs[A, C], wb: WitnessAs[B, C], nc: Numeric[C]): ==>[Greater[A], Greater[B]]
    Definition Classes
    NumericInference
  12. implicit def greaterInferenceNat[A <: Nat, B <: Nat](implicit ta: ToInt[A], tb: ToInt[B]): ==>[Greater[A], Greater[B]]
    Definition Classes
    NumericInference
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. implicit def lessEqualInference[A]: ==>[Less[A], LessEqual[A]]
    Definition Classes
    NumericInference
  16. implicit def lessInference[C, A, B](implicit wa: WitnessAs[A, C], wb: WitnessAs[B, C], nc: Numeric[C]): ==>[Less[A], Less[B]]
    Definition Classes
    NumericInference
  17. implicit def lessInferenceNat[A <: Nat, B <: Nat](implicit ta: ToInt[A], tb: ToInt[B]): ==>[Less[A], Less[B]]
    Definition Classes
    NumericInference
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  26. object Greater extends Serializable
  27. object Interval
  28. object Less extends Serializable
  29. object Modulo extends Serializable
  30. object NonNaN extends Serializable

Inherited from NumericInference

Inherited from AnyRef

Inherited from Any

Ungrouped