Trait/Object

dsptools.numbers

IsIntegral

Related Docs: object IsIntegral | package numbers

Permalink

trait IsIntegral[A <: Data] extends IsReal[A]

Linear Supertypes
IsReal[A], Signed[A], Order[A], PartialOrder[A], Eq[A], Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. IsIntegral
  2. IsReal
  3. Signed
  4. Order
  5. PartialOrder
  6. Eq
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

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

    Permalink

    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 compare(x: A, y: A): ComparisonBundle

    Permalink
    Definition Classes
    Order
  3. abstract def context_abs(a: A): A

    Permalink
    Definition Classes
    Signed
  4. abstract def getClass(): Class[_]

    Permalink
    Definition Classes
    Any
  5. abstract def isOdd(a: A): Bool

    Permalink
  6. abstract def mod(a: A, b: A): A

    Permalink
  7. abstract def signum(a: A): ComparisonBundle

    Permalink

    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

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def ceil(a: A): A

    Permalink

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

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

    Definition Classes
    IsIntegralIsReal
  6. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    Any
  7. def eqv(x: A, y: A): Bool

    Permalink

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

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

    Definition Classes
    OrderPartialOrderEq
  8. def floor(a: A): A

    Permalink

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

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

    Definition Classes
    IsIntegralIsReal
  9. def gt(x: A, y: A): Bool

    Permalink
    Definition Classes
    OrderPartialOrder
  10. def gteqv(x: A, y: A): Bool

    Permalink
    Definition Classes
    OrderPartialOrder
  11. def hashCode(): Int

    Permalink
    Definition Classes
    Any
  12. def isEven(a: A): Bool

    Permalink
  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  14. def isSignNegative(a: A): Bool

    Permalink
    Definition Classes
    Signed
  15. def isSignNonNegative(a: A): Bool

    Permalink
    Definition Classes
    Signed
  16. def isSignNonPositive(a: A): Bool

    Permalink
    Definition Classes
    Signed
  17. def isSignNonZero(a: A): Bool

    Permalink
    Definition Classes
    Signed
  18. def isSignPositive(a: A): Bool

    Permalink
    Definition Classes
    Signed
  19. def isSignZero(a: A): Bool

    Permalink
    Definition Classes
    Signed
  20. def isWhole(a: A): Bool

    Permalink

    Returns true iff a is a an integer.

    Returns true iff a is a an integer.

    Definition Classes
    IsIntegralIsReal
  21. def lt(x: A, y: A): Bool

    Permalink
    Definition Classes
    OrderPartialOrder
  22. def lteqv(x: A, y: A): Bool

    Permalink
    Definition Classes
    OrderPartialOrder
  23. def max(x: A, y: A): A

    Permalink
    Definition Classes
    Order
  24. def min(x: A, y: A): A

    Permalink
    Definition Classes
    Order
  25. def neqv(x: A, y: A): Bool

    Permalink

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

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

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

    Permalink

    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
    OrderPartialOrderEq
  27. def partialCompare(x: A, y: A): ValidIO[ComparisonBundle]

    Permalink

    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
    OrderPartialOrder
  28. def pmax(x: A, y: A): ValidIO[A]

    Permalink

    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
  29. def pmin(x: A, y: A): ValidIO[A]

    Permalink

    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
  30. def reverse: Order[A]

    Permalink

    Defines an ordering on A where all arrows switch direction.

    Defines an ordering on A where all arrows switch direction.

    Definition Classes
    OrderPartialOrder
  31. def round(a: A): A

    Permalink

    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)

    Definition Classes
    IsIntegralIsReal
  32. def sign(a: A): Sign

    Permalink

    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
  33. def toString(): String

    Permalink
    Definition Classes
    Any
  34. def truncate(a: A): A

    Permalink
    Definition Classes
    IsIntegralIsReal

Inherited from IsReal[A]

Inherited from Signed[A]

Inherited from Order[A]

Inherited from PartialOrder[A]

Inherited from Eq[A]

Inherited from Any

Ungrouped