Trait/Object

dsptools.numbers

IntegerBits

Related Docs: object IntegerBits | package numbers

Permalink

trait IntegerBits[A <: Data] extends RealBits[A] with Integer[A]

Linear Supertypes
Integer[A], IsIntegral[A], RealBits[A], BinaryRepresentation[A], ChiselConvertableFrom[A], Real[A], IsReal[A], Signed[A], Order[A], PartialOrder[A], Eq[A], ConvertableTo[A], spire.math.ConvertableTo[A], Ring[A], algebra.ring.Ring[A], Rng[A], AdditiveCommutativeGroup[A], algebra.ring.AdditiveGroup[A], Rig[A], MultiplicativeMonoid[A], Semiring[A], MultiplicativeSemigroup[A], AdditiveCommutativeMonoid[A], AdditiveCommutativeSemigroup[A], AdditiveMonoid[A], AdditiveSemigroup[A], Serializable, Serializable, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. IntegerBits
  2. Integer
  3. IsIntegral
  4. RealBits
  5. BinaryRepresentation
  6. ChiselConvertableFrom
  7. Real
  8. IsReal
  9. Signed
  10. Order
  11. PartialOrder
  12. Eq
  13. ConvertableTo
  14. ConvertableTo
  15. Ring
  16. Ring
  17. Rng
  18. AdditiveCommutativeGroup
  19. AdditiveGroup
  20. Rig
  21. MultiplicativeMonoid
  22. Semiring
  23. MultiplicativeSemigroup
  24. AdditiveCommutativeMonoid
  25. AdditiveCommutativeSemigroup
  26. AdditiveMonoid
  27. AdditiveSemigroup
  28. Serializable
  29. Serializable
  30. 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 asFixed(a: A, proto: FixedPoint): FixedPoint

    Permalink
    Definition Classes
    ChiselConvertableFrom
  3. abstract def asReal(a: A): DspReal

    Permalink
    Definition Classes
    ChiselConvertableFrom
  4. abstract def compare(x: A, y: A): ComparisonBundle

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

    Permalink
    Definition Classes
    Signed
  6. abstract def fromBigDecimal(n: BigDecimal): A

    Permalink
    Definition Classes
    ConvertableTo
  7. abstract def fromByte(n: Byte): A

    Permalink
    Definition Classes
    ConvertableTo
  8. abstract def fromDouble(d: Double, a: A): A

    Permalink
    Definition Classes
    ConvertableTo
  9. abstract def fromDouble(n: Double): A

    Permalink
    Definition Classes
    ConvertableTo
  10. abstract def fromDoubleWithFixedWidth(d: Double, a: A): A

    Permalink
    Definition Classes
    ConvertableTo
  11. abstract def fromFloat(n: Float): A

    Permalink
    Definition Classes
    ConvertableTo
  12. abstract def fromLong(n: Long): A

    Permalink
    Definition Classes
    ConvertableTo
  13. abstract def fromShort(n: Short): A

    Permalink
    Definition Classes
    ConvertableTo
  14. abstract def fromType[B](b: B)(implicit arg0: spire.math.ConvertableFrom[B]): A

    Permalink
    Definition Classes
    ConvertableTo
  15. abstract def getClass(): Class[_]

    Permalink
    Definition Classes
    Any
  16. abstract def intPart(a: A): SInt

    Permalink
    Definition Classes
    ChiselConvertableFrom
  17. abstract def isOdd(a: A): Bool

    Permalink
    Definition Classes
    IsIntegral
  18. abstract def minusContext(f: A, g: A): A

    Permalink
    Definition Classes
    Ring
  19. abstract def mod(a: A, b: A): A

    Permalink
    Definition Classes
    IsIntegral
  20. abstract def negate(x: A): A

    Permalink
    Definition Classes
    AdditiveGroup
  21. abstract def negateContext(f: A): A

    Permalink
    Definition Classes
    Ring
  22. abstract def one: A

    Permalink
    Definition Classes
    MultiplicativeMonoid
  23. abstract def plus(x: A, y: A): A

    Permalink
    Definition Classes
    AdditiveSemigroup
  24. abstract def plusContext(f: A, g: A): A

    Permalink
    Definition Classes
    Ring
  25. abstract def shl(a: A, n: UInt): A

    Permalink
    Definition Classes
    BinaryRepresentation
  26. abstract def shl(a: A, n: Int): A

    Permalink
    Definition Classes
    BinaryRepresentation
  27. abstract def shr(a: A, n: UInt): A

    Permalink
    Definition Classes
    BinaryRepresentation
  28. abstract def shr(a: A, n: Int): A

    Permalink
    Definition Classes
    BinaryRepresentation
  29. abstract def signBit(a: A): Bool

    Permalink
    Definition Classes
    BinaryRepresentation
  30. 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
  31. abstract def times(x: A, y: A): A

    Permalink
    Definition Classes
    MultiplicativeSemigroup
  32. abstract def timesContext(f: A, g: A): A

    Permalink
    Definition Classes
    Ring
  33. abstract def trimBinary(a: A, n: Option[Int]): A

    Permalink
    Definition Classes
    BinaryRepresentation
  34. abstract def zero: A

    Permalink
    Definition Classes
    AdditiveMonoid

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. def additive: CommutativeGroup[A]

    Permalink
    Definition Classes
    AdditiveCommutativeGroup → AdditiveCommutativeMonoid → AdditiveCommutativeSemigroup → AdditiveGroup → AdditiveMonoid → AdditiveSemigroup
  5. def asFixed(a: A): FixedPoint

    Permalink
    Definition Classes
    ChiselConvertableFrom
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. 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
  8. def div2(a: A, n: Int): A

    Permalink
    Definition Classes
    BinaryRepresentation
  9. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    Any
  10. 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
  11. 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
  12. def fromAlgebraic(a: Algebraic): A

    Permalink
    Definition Classes
    Real → ConvertableTo
  13. def fromBigInt(n: BigInt): A

    Permalink
    Definition Classes
    Ring
  14. def fromInt(n: Int): A

    Permalink
    Definition Classes
    Ring
  15. def fromRational(a: Rational): A

    Permalink
    Definition Classes
    Real → ConvertableTo
  16. def fromReal(a: spire.math.Real): A

    Permalink
    Definition Classes
    Real → ConvertableTo
  17. def gt(x: A, y: A): Bool

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

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

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

    Permalink
    Definition Classes
    IsIntegral
  21. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  22. def isOne(a: A)(implicit ev: algebra.Eq[A]): Boolean

    Permalink
    Definition Classes
    MultiplicativeMonoid
  23. def isSignNegative(a: A): Bool

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

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

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

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

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

    Permalink
    Definition Classes
    Signed
  29. 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
  30. def isZero(a: A)(implicit ev: algebra.Eq[A]): Boolean

    Permalink
    Definition Classes
    AdditiveMonoid
  31. def lt(x: A, y: A): Bool

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

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

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

    Permalink
    Definition Classes
    Order
  35. def minus(x: A, y: A): A

    Permalink
    Definition Classes
    AdditiveGroup
  36. def mul2(a: A, n: Int): A

    Permalink
    Definition Classes
    BinaryRepresentation
  37. def multiplicative: Monoid[A]

    Permalink
    Definition Classes
    MultiplicativeMonoid → MultiplicativeSemigroup
  38. 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
  39. 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
  40. 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
  41. 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
  42. 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
  43. def positivePow(a: A, n: Int): A

    Permalink
    Attributes
    protected[this]
    Definition Classes
    MultiplicativeSemigroup
  44. def positiveSumN(a: A, n: Int): A

    Permalink
    Attributes
    protected[this]
    Definition Classes
    AdditiveSemigroup
  45. def pow(a: A, n: Int): A

    Permalink
    Definition Classes
    MultiplicativeMonoid → MultiplicativeSemigroup
  46. def product(as: TraversableOnce[A]): A

    Permalink
    Definition Classes
    MultiplicativeMonoid
  47. 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
  48. 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
  49. 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
  50. def sum(as: TraversableOnce[A]): A

    Permalink
    Definition Classes
    AdditiveMonoid
  51. def sumN(a: A, n: Int): A

    Permalink
    Definition Classes
    AdditiveGroup → AdditiveMonoid → AdditiveSemigroup
  52. def toString(): String

    Permalink
    Definition Classes
    Any
  53. def trimBinary(a: A, n: Int): A

    Permalink
    Definition Classes
    BinaryRepresentation
  54. def truncate(a: A): A

    Permalink
    Definition Classes
    IsIntegralIsReal
  55. def tryProduct(as: TraversableOnce[A]): Option[A]

    Permalink
    Definition Classes
    MultiplicativeMonoid → MultiplicativeSemigroup
  56. def trySum(as: TraversableOnce[A]): Option[A]

    Permalink
    Definition Classes
    AdditiveMonoid → AdditiveSemigroup

Inherited from Integer[A]

Inherited from IsIntegral[A]

Inherited from RealBits[A]

Inherited from BinaryRepresentation[A]

Inherited from ChiselConvertableFrom[A]

Inherited from Real[A]

Inherited from IsReal[A]

Inherited from Signed[A]

Inherited from Order[A]

Inherited from PartialOrder[A]

Inherited from Eq[A]

Inherited from ConvertableTo[A]

Inherited from spire.math.ConvertableTo[A]

Inherited from Ring[A]

Inherited from algebra.ring.Ring[A]

Inherited from Rng[A]

Inherited from AdditiveCommutativeGroup[A]

Inherited from algebra.ring.AdditiveGroup[A]

Inherited from Rig[A]

Inherited from MultiplicativeMonoid[A]

Inherited from Semiring[A]

Inherited from MultiplicativeSemigroup[A]

Inherited from AdditiveCommutativeMonoid[A]

Inherited from AdditiveCommutativeSemigroup[A]

Inherited from AdditiveMonoid[A]

Inherited from AdditiveSemigroup[A]

Inherited from Serializable

Inherited from Serializable

Inherited from Any

Ungrouped