com.twitter.algebird

EventuallySemigroup

class EventuallySemigroup[E, O] extends Semigroup[Either[E, O]]

Classes that support algebraic structures with dynamic switching between two representations, the original type O and the eventual type E. In the case of Semigroup, we specify - Two Semigroups eventualSemigroup and originalSemigroup - A Semigroup homomorphism convert: O => E - A conditional mustConvert: O => Boolean Then we get a Semigroup[Either[E,O]], where: Left(x) + Left(y) = Left(x+y) Left(x) + Right(y) = Left(x+convert(y)) Right(x) + Left(y) = Left(convert(x)+y) Right(x) + Right(y) = Left(convert(x+y)) if mustConvert(x+y) Right(x+y) otherwise. EventuallyMonoid, EventuallyGroup, and EventuallyRing are defined analogously, with the contract that convert respect the appropriate structure.

Linear Supertypes
Semigroup[Either[E, O]], AdditiveSemigroup[Either[E, O]], cats.kernel.Semigroup[Either[E, O]], Serializable, Serializable, AnyRef, Any
Known Subclasses
EventuallyGroup, EventuallyMonoid, EventuallyRing
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. EventuallySemigroup
  2. Semigroup
  3. AdditiveSemigroup
  4. Semigroup
  5. Serializable
  6. Serializable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new EventuallySemigroup(convert: (O) ⇒ E)(mustConvert: (O) ⇒ Boolean)(implicit eventualSemigroup: Semigroup[E], originalSemigroup: Semigroup[O])

Value Members

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. def additive: algebra.Semigroup[Either[E, O]]

    Definition Classes
    Semigroup → AdditiveSemigroup

  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  8. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  9. def combine(l: Either[E, O], r: Either[E, O]): Either[E, O]

    Definition Classes
    Semigroup → Semigroup

  10. def combineAllOption(iter: TraversableOnce[Either[E, O]]): Option[Either[E, O]]

    Definition Classes
    Semigroup → Semigroup

  11. def combineN(a: Either[E, O], n: Int): Either[E, O]

    Definition Classes
    Semigroup

  12. def conditionallyConvert(o: O): Either[E, O]

    Attributes
    protected

  13. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  14. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  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 hashCode(): Int

    Definition Classes
    AnyRef → Any

  18. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  19. def left(e: E): Either[E, O]

    Attributes
    protected

  20. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  21. final def notify(): Unit

    Definition Classes
    AnyRef

  22. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  23. def plus(x: Either[E, O], y: Either[E, O]): Either[E, O]

    Definition Classes
    EventuallySemigroup → AdditiveSemigroup

  24. def positiveSumN(a: Either[E, O], n: Int): Either[E, O]

    Attributes
    protected[this]
    Definition Classes
    AdditiveSemigroup

  25. def repeatedCombineN(a: Either[E, O], n: Int): Either[E, O]

    Attributes
    protected[this]
    Definition Classes
    Semigroup

  26. def sumN(a: Either[E, O], n: Int): Either[E, O]

    Definition Classes
    AdditiveSemigroup

  27. def sumOption(iter: TraversableOnce[Either[E, O]]): Option[Either[E, O]]

    Returns an instance of T calculated by summing all instances in iter in one pass.

    Returns an instance of T calculated by summing all instances in iter in one pass. Returns None if iter is empty, else Some[T].

    iter

    instances of T to be combined

    returns

    None if iter is empty, else an option value containing the summed T

    Definition Classes
    EventuallySemigroup → Semigroup
    Note

    Override if there is a faster way to compute this sum than iter.reduceLeftOption using plus.

  28. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  29. def toString(): String

    Definition Classes
    AnyRef → Any

  30. def trySum(iter: TraversableOnce[Either[E, O]]): Option[Either[E, O]]

    Definition Classes
    Semigroup → AdditiveSemigroup

  31. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  32. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  33. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Semigroup[Either[E, O]]

Inherited from AdditiveSemigroup[Either[E, O]]

Inherited from cats.kernel.Semigroup[Either[E, O]]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped