Packages

c

spire.algebra.Sign

SignAlgebra

class SignAlgebra extends CMonoid[Sign] with Signed[Sign] with Order[Sign]

Linear Supertypes
Order[Sign], PartialOrder[Sign], Eq[Sign], Signed[Sign], CMonoid[Sign], CSemigroup[Sign], Monoid[Sign], Semigroup[Sign], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SignAlgebra
  2. Order
  3. PartialOrder
  4. Eq
  5. Signed
  6. CMonoid
  7. CSemigroup
  8. Monoid
  9. Semigroup
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SignAlgebra()

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. def abs(a: Sign): Sign

    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
    SignAlgebra → Signed
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def combine(as: TraversableOnce[Sign]): Sign

    Given a sequence of as, combine them using the monoid and return the total.

    Given a sequence of as, combine them using the monoid and return the total.

    Definition Classes
    Monoid
  8. def combineOption(as: TraversableOnce[Sign]): Option[Sign]

    Given a sequence of as, combine them using the semigroup and return the total.

    Given a sequence of as, combine them using the semigroup and return the total.

    If the sequence is empty, returns None. Otherwise, returns Some(total).

    Definition Classes
    Semigroup
  9. def combinen(a: Sign, n: Int): Sign

    Return a combined with itself n times.

    Return a combined with itself n times.

    Definition Classes
    Monoid → Semigroup
  10. def combinenAboveOne(a: Sign, n: Int): Sign
    Attributes
    protected
    Definition Classes
    Semigroup
  11. def compare(x: Sign, y: Sign): Int
    Definition Classes
    SignAlgebra → Order
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def eqv(x: Sign, y: Sign): Boolean

    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
  15. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  17. def gt(x: Sign, y: Sign): Boolean
    Definition Classes
    Order → PartialOrder
  18. def gteqv(x: Sign, y: Sign): Boolean
    Definition Classes
    Order → PartialOrder
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  20. def id: Sign

    Return the identity element for this monoid.

    Return the identity element for this monoid.

    Definition Classes
    SignAlgebra → Monoid
  21. def isId(a: Sign)(implicit ev: Eq[Sign]): Boolean

    Tests if a is the identity.

    Tests if a is the identity.

    Definition Classes
    Monoid
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. def isSignNegative(a: Sign): Boolean
    Definition Classes
    Signed
  24. def isSignNonNegative(a: Sign): Boolean
    Definition Classes
    Signed
  25. def isSignNonPositive(a: Sign): Boolean
    Definition Classes
    Signed
  26. def isSignNonZero(a: Sign): Boolean
    Definition Classes
    Signed
  27. def isSignPositive(a: Sign): Boolean
    Definition Classes
    Signed
  28. def isSignZero(a: Sign): Boolean
    Definition Classes
    Signed
  29. def lt(x: Sign, y: Sign): Boolean
    Definition Classes
    Order → PartialOrder
  30. def lteqv(x: Sign, y: Sign): Boolean
    Definition Classes
    Order → PartialOrder
  31. def max(x: Sign, y: Sign): Sign
    Definition Classes
    Order
  32. def min(x: Sign, y: Sign): Sign
    Definition Classes
    Order
  33. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  34. def neqv(x: Sign, y: Sign): Boolean

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

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

    Definition Classes
    Eq
  35. final def notify(): Unit
    Definition Classes
    AnyRef
  36. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  37. def on[B](f: (B) ⇒ Sign): 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
  38. def op(a: Sign, b: Sign): Sign
    Definition Classes
    SignAlgebra → Semigroup
  39. def partialCompare(x: Sign, y: Sign): Double

    Result of comparing x with y.

    Result of comparing x with y. Returns NaN if operands are not comparable. If operands are comparable, returns a Double whose sign is: - negative iff x < y - zero iff x === y - positive iff x > y

    Definition Classes
    Order → PartialOrder
  40. def pmax(x: Sign, y: Sign): Option[Sign]

    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
  41. def pmin(x: Sign, y: Sign): Option[Sign]

    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 reverse: Order[Sign]

    Defines an ordering on A where all arrows switch direction.

    Defines an ordering on A where all arrows switch direction.

    Definition Classes
    Order → PartialOrder
  43. def sign(a: Sign): 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
    SignAlgebra → Signed
  44. def signum(a: Sign): Int

    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
    SignAlgebra → Signed
  45. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  46. def toString(): String
    Definition Classes
    AnyRef → Any
  47. def tryCompare(x: Sign, y: Sign): Option[Int]

    Result of comparing x with y.

    Result of comparing x with y. Returns None if operands are not comparable. If operands are comparable, returns Some[Int] where the Int sign is: - negative iff x < y - zero iff x == y - positive iff x > y

    Definition Classes
    PartialOrder
  48. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  49. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  50. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Order[Sign]

Inherited from PartialOrder[Sign]

Inherited from Eq[Sign]

Inherited from Signed[Sign]

Inherited from CMonoid[Sign]

Inherited from CSemigroup[Sign]

Inherited from Monoid[Sign]

Inherited from Semigroup[Sign]

Inherited from AnyRef

Inherited from Any

Ungrouped