Trait/Object

dsptools.numbers

RealBits

Related Docs: object RealBits | package numbers

Permalink

trait RealBits[A <: Data] extends Real[A] with ChiselConvertableFrom[A] with BinaryRepresentation[A]

Linear Supertypes
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. RealBits
  2. BinaryRepresentation
  3. ChiselConvertableFrom
  4. Real
  5. IsReal
  6. Signed
  7. Order
  8. PartialOrder
  9. Eq
  10. ConvertableTo
  11. ConvertableTo
  12. Ring
  13. Ring
  14. Rng
  15. AdditiveCommutativeGroup
  16. AdditiveGroup
  17. Rig
  18. MultiplicativeMonoid
  19. Semiring
  20. MultiplicativeSemigroup
  21. AdditiveCommutativeMonoid
  22. AdditiveCommutativeSemigroup
  23. AdditiveMonoid
  24. AdditiveSemigroup
  25. Serializable
  26. Serializable
  27. 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 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
    IsReal
  5. abstract def compare(x: A, y: A): ComparisonBundle

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

    Permalink
    Definition Classes
    Signed
  7. abstract 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
    IsReal
  8. abstract def fromBigDecimal(n: BigDecimal): A

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    ChiselConvertableFrom
  19. abstract def isWhole(a: A): Bool

    Permalink

    Returns true iff a is a an integer.

    Returns true iff a is a an integer.

    Definition Classes
    IsReal
  20. abstract def minusContext(f: A, g: A): A

    Permalink
    Definition Classes
    Ring
  21. abstract def negate(x: A): A

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

    Permalink
    Definition Classes
    Ring
  23. abstract def one: A

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

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

    Permalink
    Definition Classes
    Ring
  26. abstract 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
    IsReal
  27. abstract def shl(a: A, n: UInt): A

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Any
  18. final def isInstanceOf[T0]: Boolean

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Signed
  26. def isZero(a: A)(implicit ev: algebra.Eq[A]): Boolean

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    MultiplicativeMonoid → MultiplicativeSemigroup
  34. 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
  35. 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
  36. 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
  37. 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
  38. 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
  39. def positivePow(a: A, n: Int): A

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

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

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

    Permalink
    Definition Classes
    MultiplicativeMonoid
  43. 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
  44. 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
  45. def sum(as: TraversableOnce[A]): A

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

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

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

    Permalink
    Definition Classes
    BinaryRepresentation
  49. def tryProduct(as: TraversableOnce[A]): Option[A]

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

    Permalink
    Definition Classes
    AdditiveMonoid → AdditiveSemigroup

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