Packages

trait IsReal[A <: Data] extends Order[A] with Signed[A]

A simple type class for numeric types that are a subset of the reals.

Linear Supertypes
Signed[A], Order[A], PartialOrder[A], Eq[A], Any
Known Subclasses
DspRealRealImpl, DspRealIsReal, DspRealReal, FixedPointRealImpl, FixedPointIsReal, FixedPointReal, Integer, IntegerBits, IsIntegral, Real, RealBits, SIntIntegerImpl, SIntInteger, SIntIsReal, UIntIntegerImpl, UIntInteger, UIntIsReal
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. IsReal
  2. Signed
  3. Order
  4. PartialOrder
  5. Eq
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def abs(a: A): A

    An idempotent function that ensures an object has a non-negative sign.

    An idempotent function that ensures an object has a non-negative sign.

    Definition Classes
    Signed
  2. abstract def ceil(a: A): A

    Rounds a the nearest integer that is greater than or equal to a.

  3. abstract def compare(x: A, y: A): ComparisonBundle
    Definition Classes
    Order
  4. abstract def context_abs(a: A): A
    Definition Classes
    Signed
  5. abstract def floor(a: A): A

    Rounds a the nearest integer that is less than or equal to a.

  6. abstract def getClass(): Class[_]
    Definition Classes
    Any
  7. abstract def isWhole(a: A): Bool

    Returns true iff a is a an integer.

  8. abstract def round(a: A): A

    Rounds a to the nearest integer (When the fractional part is 0.5, tie breaking rounds to positive infinity i.e.

    Rounds a to the nearest integer (When the fractional part is 0.5, tie breaking rounds to positive infinity i.e. round half up)

  9. abstract def signum(a: A): ComparisonBundle

    Returns 0 if a is 0, > 0 if a is positive, and < 0 is a is negative.

    Returns 0 if a is 0, > 0 if a is positive, and < 0 is a is negative.

    Definition Classes
    Signed
  10. abstract def truncate(a: A): A

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    Any
  2. final def ##(): Int
    Definition Classes
    Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def equals(arg0: Any): Boolean
    Definition Classes
    Any
  6. def eqv(x: A, y: A): Bool

    Returns true if x and y are equivalent, false otherwise.

    Returns true if x and y are equivalent, false otherwise.

    Definition Classes
    Order → PartialOrder → Eq
  7. def gt(x: A, y: A): Bool
    Definition Classes
    Order → PartialOrder
  8. def gteqv(x: A, y: A): Bool
    Definition Classes
    Order → PartialOrder
  9. def hashCode(): Int
    Definition Classes
    Any
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. def isSignNegative(a: A): Bool
    Definition Classes
    Signed
  12. def isSignNonNegative(a: A): Bool
    Definition Classes
    Signed
  13. def isSignNonPositive(a: A): Bool
    Definition Classes
    Signed
  14. def isSignNonZero(a: A): Bool
    Definition Classes
    Signed
  15. def isSignPositive(a: A): Bool
    Definition Classes
    Signed
  16. def isSignZero(a: A): Bool
    Definition Classes
    Signed
  17. def lt(x: A, y: A): Bool
    Definition Classes
    Order → PartialOrder
  18. def lteqv(x: A, y: A): Bool
    Definition Classes
    Order → PartialOrder
  19. def max(x: A, y: A): A
    Definition Classes
    Order
  20. def min(x: A, y: A): A
    Definition Classes
    Order
  21. def neqv(x: A, y: A): Bool

    Returns false if x and y are equivalent, true otherwise.

    Returns false if x and y are equivalent, true otherwise.

    Definition Classes
    Eq
  22. def on[B <: Data](f: (B) ⇒ A): Order[B]

    Defines an order on B by mapping B to A using f and using As order to order B.

    Defines an order on B by mapping B to A using f and using As order to order B.

    Definition Classes
    Order → PartialOrder → Eq
  23. def partialCompare(x: A, y: A): ValidIO[ComparisonBundle]

    Result of comparing x with y.

    Result of comparing x with y. Returns ValidIO[ComparisonBundle] with valid false if operands are not comparable. If operands are comparable, bits.lt will be true if x < y and bits.eq will be true if x = y

    Definition Classes
    Order → PartialOrder
  24. def pmax(x: A, y: A): ValidIO[A]

    Returns Some(x) if x >= y, Some(y) if x < y, otherwise None.

    Returns Some(x) if x >= y, Some(y) if x < y, otherwise None.

    Definition Classes
    PartialOrder
  25. def pmin(x: A, y: A): ValidIO[A]

    Returns Some(x) if x <= y, Some(y) if x > y, otherwise None.

    Returns Some(x) if x <= y, Some(y) if x > y, otherwise None.

    Definition Classes
    PartialOrder
  26. def reverse: Order[A]

    Defines an ordering on A where all arrows switch direction.

    Defines an ordering on A where all arrows switch direction.

    Definition Classes
    Order → PartialOrder
  27. def sign(a: A): Sign

    Returns Zero if a is 0, Positive if a is positive, and Negative is a is negative.

    Returns Zero if a is 0, Positive if a is positive, and Negative is a is negative.

    Definition Classes
    Signed
  28. def toString(): String
    Definition Classes
    Any

Inherited from Signed[A]

Inherited from Order[A]

Inherited from PartialOrder[A]

Inherited from Eq[A]

Inherited from Any

Ungrouped