Class

com.twitter.algebird

SemigroupCombinator

Related Doc: package algebird

Permalink

class SemigroupCombinator[A, B] extends Semigroup[(A, B)]

This is a combinator on semigroups, after you do the plus, you transform B with a fold function This will not be valid for all fold functions. You need to prove that it is still associative.

Clearly only values of (a,b) are valid if fold(a,b) == b, so keep that in mind.

I have not yet found a sufficient condition on (A,B) => B that makes it correct Clearly a (trivial) constant function {(l,r) => r} works. Also, if B is List[T], and (l:A,r:List[T]) = r.sortBy(fn(l)) this works as well (due to the associativity on A, and the fact that the list never loses data).

For approximate lists (like top-K applications) this might work (or be close enough to associative that for approximation algorithms it is fine), and in fact, that is the main motivation of this code: Produce some ordering in A, and use it to do sorted-topK on the list in B.

Seems like an open topic here.... you are obliged to think on your own about this.

Linear Supertypes
Semigroup[(A, B)], AdditiveSemigroup[(A, B)], cats.kernel.Semigroup[(A, B)], Serializable, Serializable, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SemigroupCombinator
  2. Semigroup
  3. AdditiveSemigroup
  4. Semigroup
  5. Serializable
  6. Serializable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SemigroupCombinator(fold: (A, B) ⇒ B)(implicit arg0: Semigroup[A], arg1: Semigroup[B])

    Permalink

Value Members

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. def additive: algebra.Semigroup[(A, B)]

    Permalink
    Definition Classes
    Semigroup → AdditiveSemigroup
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def combine(l: (A, B), r: (A, B)): (A, B)

    Permalink
    Definition Classes
    Semigroup → Semigroup
  8. def combineAllOption(iter: TraversableOnce[(A, B)]): Option[(A, B)]

    Permalink
    Definition Classes
    Semigroup → Semigroup
  9. def combineN(a: (A, B), n: Int): (A, B)

    Permalink
    Definition Classes
    Semigroup
  10. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  11. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  12. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  14. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  15. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  17. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  19. def plus(left: (A, B), right: (A, B)): (A, B)

    Permalink
    Definition Classes
    SemigroupCombinator → AdditiveSemigroup
  20. def positiveSumN(a: (A, B), n: Int): (A, B)

    Permalink
    Attributes
    protected[this]
    Definition Classes
    AdditiveSemigroup
  21. def repeatedCombineN(a: (A, B), n: Int): (A, B)

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Semigroup
  22. def sumN(a: (A, B), n: Int): (A, B)

    Permalink
    Definition Classes
    AdditiveSemigroup
  23. def sumOption(iter: TraversableOnce[(A, B)]): Option[(A, B)]

    Permalink

    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
    Semigroup
    Note

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

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

    Permalink
    Definition Classes
    AnyRef
  25. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  26. def trySum(iter: TraversableOnce[(A, B)]): Option[(A, B)]

    Permalink
    Definition Classes
    Semigroup → AdditiveSemigroup
  27. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Semigroup[(A, B)]

Inherited from AdditiveSemigroup[(A, B)]

Inherited from cats.kernel.Semigroup[(A, B)]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped