Semigroups (cyclops 10.3.2 API)

public interface Semigroups

A static class with a large number of SemigroupK or Combiners. A semigroup is an Object that can be used to combine objects of the same type. Using raw Semigroups with container types

     
       Semigroup<Maybe<Integer>> m = Semigroups.combineZippables(Semigroups.intMax);
       Semigroup<ReactiveSeq<Integer>> m = Semigroups.combineZippables(Semigroups.intSum);

Field Summary

Fields
Modifier and Type	Field and Description
`static Semigroup<java.math.BigInteger>`	`bigIntMax` Combine two BigIntegers by selecting the max
`static Semigroup<java.math.BigInteger>`	`bigIntMin` Combine two BigIntegers by selecting the min
`static Semigroup<java.math.BigInteger>`	`bigIntMult` Combine two BigIntegers by multiplying them
`static Semigroup<java.math.BigInteger>`	`bigIntSum` Combine two BigIngegers by summing them
`static Semigroup<java.lang.Boolean>`	`booleanConjunction` Combine two booleans by AND'ing them (conjunction)
`static Semigroup<java.lang.Boolean>`	`booleanDisjunction` Combine two booleans by OR'ing them (disjunction)
`static Semigroup<java.lang.Boolean>`	`booleanXDisjunction` Combine two booleans by XOR'ing them (exclusive disjunction)
`static Semigroup<java.lang.Double>`	`doubleMax` Combine two Doubles by selecting the max
`static Semigroup<java.lang.Double>`	`doubleMin` Combine two Doubles by selecting the min
`static Semigroup<java.lang.Double>`	`doubleMult` Combine two Doubles by multiplying them
`static Semigroup<java.lang.Double>`	`doubleSum` Combine two Doubles by summing them
`static Semigroup<java.lang.Integer>`	`intMax` Combine two Integers by selecting the max
`static Semigroup<java.lang.Integer>`	`intMin` Combine two Integers by selecting the min
`static Semigroup<java.lang.Integer>`	`intMult` Combine two Integers by multiplying them
`static Semigroup<java.lang.Integer>`	`intSum` Combine two Integers by summing them
`static Semigroup<java.lang.Long>`	`longMax` Combine two Longs by selecting the max
`static Semigroup<java.lang.Long>`	`longMin` Combine two Longs by selecting the min
`static Semigroup<java.lang.Long>`	`longMult` Combine two Longs by multiplying them
`static Semigroup<java.lang.Long>`	`longSum` Combine two Longs by summing them
`static Semigroup<java.lang.StringBuffer>`	`stringBufferConcat` StringBuffer concatenation
`static Semigroup<java.lang.StringBuilder>`	`stringBuilderConcat` StringBuilder concatenation
`static Semigroup<java.lang.String>`	`stringConcat` String concatenation

Method Summary

All Methods Static Methods Default Methods
Modifier and Type	Method and Description
`static <T> Semigroup<org.reactivestreams.Publisher<T>>`	`amb()`
`static <T> Semigroup<ReactiveSeq<T>>`	`ambReactiveSeq()`
`static <T> Semigroup<Bag<T>>`	`bagConcat()`
`static <T> Semigroup<BankersQueue<T>>`	`bankersQueueConcat()`
`static <T> Semigroup<ReactiveSeq<T>>`	`combineReactiveSeq()`
`static <T,A extends Zippable<T>> Semigroup<A>`	`combineScalarFunctors(java.util.function.BiFunction<T,T,T> semigroup)` `BinaryOperator<Maybe<Integer>> sumMaybes = Semigroups.combineScalarFunctors(Semigroups.intSum); Maybe.just(1) .combine(sumMaybes, Maybe.just(5)) //Maybe[6]`
`static <T> Semigroup<java.util.stream.Stream<T>>`	`combineStream()`
`static <T,A extends Zippable<T>> Semigroup<A>`	`combineZippables(java.util.function.BiFunction<T,T,T> semigroup)` `BinaryOperator<Seq<Integer>> sumInts = Semigroups.combineZippables(Semigroups.intSum); sumInts.apply(Seq.of(1,2,3), Seq.of(4,5,6)); //List[5,7,9];`
`static <T> Semigroup<java.util.concurrent.CompletableFuture<T>>`	`firstCompleteCompletableFuture()`
`static <T> Semigroup<Future<T>>`	`firstCompleteFuture()`
`static <ST,PT> Semigroup<Either<ST,PT>>`	`firstLeftEither()`
`static <T,C extends java.util.Collection<T>> Semigroup<C>`	`firstNonEmpty()`
`static <T> Semigroup<ReactiveSeq<T>>`	`firstNonEmptyReactiveSeq()`
`static <T> Semigroup<T>`	`firstNonNull()`
`static <T> Semigroup<Maybe<T>>`	`firstPresentMaybe()`
`static <T> Semigroup<java.util.Optional<T>>`	`firstPresentOptional()`
`static <ST,PT> Semigroup<Ior<ST,PT>>`	`firstPrimaryIor()`
`static <ST,PT> Semigroup<Either<ST,PT>>`	`firstRightEither()`
`static <ST,PT> Semigroup<Ior<ST,PT>>`	`firstSecondaryIor()`
`static <T> Semigroup<Future<T>>`	`firstSuccessfulFuture()`
`static <T,X extends java.lang.Throwable> Semigroup<Try<T,X>>`	`firstTryFailure()`
`static <T,X extends java.lang.Throwable> Semigroup<Try<T,X>>`	`firstTrySuccess()`
`static <A> Semigroup<java.util.function.Function<A,A>>`	`functionComposition()`
`static <T> Semigroup<HashSet<T>>`	`hashSetConcat()`
`static <T,C extends ImmutableList<T>> Semigroup<C>`	`immutableListConcat()`
`static <T> Semigroup<IntMap<T>>`	`intMapConcat()`
`static <ST,PT> Semigroup<Either<ST,PT>>`	`lastLeftEither()`
`static <T,C extends java.util.Collection<T>> Semigroup<C>`	`lastNonEmpty()`
`static <T> Semigroup<Maybe<T>>`	`lastPresentMaybe()`
`static <T> Semigroup<java.util.Optional<T>>`	`lastPresentOptional()`
`static <ST,PT> Semigroup<Ior<ST,PT>>`	`lastPrimaryIor()`
`static <ST,PT> Semigroup<Either<ST,PT>>`	`lastRightEither()`
`static <ST,PT> Semigroup<Ior<ST,PT>>`	`lastSecondaryIor()`
`static <T,X extends java.lang.Throwable> Semigroup<Try<T,X>>`	`lastTryFailure()`
`static <T,X extends java.lang.Throwable> Semigroup<Try<T,X>>`	`lastTrySuccess()`
`static <T> Semigroup<LazySeq<T>>`	`lazySeqConcat()`
`static <T> Semigroup<LazyString>`	`lazyStringConcat()`
`static <T,T2 extends java.lang.Comparable<T>> Semigroup<T2>`	`maxComparable()`
`static <T> Semigroup<org.reactivestreams.Publisher<T>>`	`mergeLatest()`
`static <T> Semigroup<ReactiveSeq<T>>`	`mergeLatestReactiveSeq()`
`static <T,T2 extends java.lang.Comparable<T>> Semigroup<T2>`	`minComparable()`
`static <A> Semigroup<NaturalTransformation<A,A>>`	`naturalTransformationComposition()`
`static <T> Semigroup<NonEmptyList<T>>`	`nonEmptyListConcat()`
`static <T,C extends PersistentCollection<T>> Semigroup<C>`	`persistentCollectionConcat()`
`static <T> Semigroup<Seq<T>>`	`seqConcat()`
`static Semigroup<java.lang.StringBuffer>`	`stringBufferJoin(java.lang.String joiner)`
`static Semigroup<java.lang.StringBuilder>`	`stringBuilderJoin(java.lang.String joiner)`
`static Semigroup<java.lang.String>`	`stringJoin(java.lang.String joiner)`
`static <T> Semigroup<TreeSet<T>>`	`treeSetConcat()`
`static <T> Semigroup<TrieSet<T>>`	`trieSetConcat()`
`static <T> Semigroup<Vector<T>>`	`vectorConcat()`
`static <T> Semigroup<Future<T>>`	`zippedFutures(Semigroup<T> s)`
`static <T> Semigroup<ReactiveSeq<T>>`	`zipReactiveSeq(Semigroup<T> s)`

Field Detail

intSum

static final Semigroup<java.lang.Integer> intSum

Combine two Integers by summing them

longSum

static final Semigroup<java.lang.Long> longSum

Combine two Longs by summing them

doubleSum

static final Semigroup<java.lang.Double> doubleSum

Combine two Doubles by summing them

bigIntSum

static final Semigroup<java.math.BigInteger> bigIntSum

Combine two BigIngegers by summing them

intMult

static final Semigroup<java.lang.Integer> intMult

Combine two Integers by multiplying them

longMult

static final Semigroup<java.lang.Long> longMult

Combine two Longs by multiplying them

doubleMult

static final Semigroup<java.lang.Double> doubleMult

Combine two Doubles by multiplying them

bigIntMult

static final Semigroup<java.math.BigInteger> bigIntMult

Combine two BigIntegers by multiplying them

intMax

static final Semigroup<java.lang.Integer> intMax

Combine two Integers by selecting the max

longMax

static final Semigroup<java.lang.Long> longMax

Combine two Longs by selecting the max

doubleMax

static final Semigroup<java.lang.Double> doubleMax

Combine two Doubles by selecting the max

bigIntMax

static final Semigroup<java.math.BigInteger> bigIntMax

Combine two BigIntegers by selecting the max

intMin

static final Semigroup<java.lang.Integer> intMin

Combine two Integers by selecting the min

longMin

static final Semigroup<java.lang.Long> longMin

Combine two Longs by selecting the min

doubleMin

static final Semigroup<java.lang.Double> doubleMin

Combine two Doubles by selecting the min

bigIntMin

static final Semigroup<java.math.BigInteger> bigIntMin

Combine two BigIntegers by selecting the min

stringConcat

static final Semigroup<java.lang.String> stringConcat

String concatenation

stringBufferConcat

static final Semigroup<java.lang.StringBuffer> stringBufferConcat

StringBuffer concatenation

stringBuilderConcat

static final Semigroup<java.lang.StringBuilder> stringBuilderConcat

StringBuilder concatenation

booleanDisjunction
```
static final Semigroup<java.lang.Boolean> booleanDisjunction
```
Combine two booleans by OR'ing them (disjunction)

booleanXDisjunction
```
static final Semigroup<java.lang.Boolean> booleanXDisjunction
```
Combine two booleans by XOR'ing them (exclusive disjunction)

booleanConjunction
```
static final Semigroup<java.lang.Boolean> booleanConjunction
```
Combine two booleans by AND'ing them (conjunction)

Method Detail

persistentCollectionConcat

static <T,C extends PersistentCollection<T>> Semigroup<C> persistentCollectionConcat()

immutableListConcat

static <T,C extends ImmutableList<T>> Semigroup<C> immutableListConcat()

nonEmptyListConcat

static <T> Semigroup<NonEmptyList<T>> nonEmptyListConcat()

lazySeqConcat

static <T> Semigroup<LazySeq<T>> lazySeqConcat()

seqConcat

static <T> Semigroup<Seq<T>> seqConcat()

vectorConcat

static <T> Semigroup<Vector<T>> vectorConcat()

intMapConcat

static <T> Semigroup<IntMap<T>> intMapConcat()

hashSetConcat

static <T> Semigroup<HashSet<T>> hashSetConcat()

trieSetConcat

static <T> Semigroup<TrieSet<T>> trieSetConcat()

treeSetConcat

static <T> Semigroup<TreeSet<T>> treeSetConcat()

bagConcat

static <T> Semigroup<Bag<T>> bagConcat()

bankersQueueConcat

static <T> Semigroup<BankersQueue<T>> bankersQueueConcat()

lazyStringConcat

static <T> Semigroup<LazyString> lazyStringConcat()

combineZippables

static <T,A extends Zippable<T>> Semigroup<A> combineZippables(java.util.function.BiFunction<T,T,T> semigroup)

 
  BinaryOperator<Seq<Integer>> sumInts = Semigroups.combineZippables(Semigroups.intSum);

        sumInts.apply(Seq.of(1,2,3), Seq.of(4,5,6));

        //List[5,7,9];

Parameters:: semigroup - Semigroup to combine the values inside the zippables
Returns:: Combination of two Zippables

combineScalarFunctors

static <T,A extends Zippable<T>> Semigroup<A> combineScalarFunctors(java.util.function.BiFunction<T,T,T> semigroup)

 

  BinaryOperator<Maybe<Integer>> sumMaybes = Semigroups.combineScalarFunctors(Semigroups.intSum);
  Maybe.just(1)
       .combine(sumMaybes, Maybe.just(5))

  //Maybe[6]

Parameters:: semigroup - Semigroup to combine the values inside the Scalar Functors (Maybe, Xor, Ior, Try, Eva, FeatureToggle etc)
Returns:: Combination of two Scalar Functors

combineReactiveSeq
```
static <T> Semigroup<ReactiveSeq<T>> combineReactiveSeq()
```
Returns:

Combination of two ReactiveSeq Streams b is appended to a

firstNonEmptyReactiveSeq

static <T> Semigroup<ReactiveSeq<T>> firstNonEmptyReactiveSeq()

ambReactiveSeq

static <T> Semigroup<ReactiveSeq<T>> ambReactiveSeq()

mergeLatestReactiveSeq

static <T> Semigroup<ReactiveSeq<T>> mergeLatestReactiveSeq()

mergeLatest

static <T> Semigroup<org.reactivestreams.Publisher<T>> mergeLatest()

amb

static <T> Semigroup<org.reactivestreams.Publisher<T>> amb()

zipReactiveSeq

static <T> Semigroup<ReactiveSeq<T>> zipReactiveSeq(Semigroup<T> s)

combineStream

static <T> Semigroup<java.util.stream.Stream<T>> combineStream()

Returns:: Combination of two Stream's : b is appended to a

firstNonEmpty

static <T,C extends java.util.Collection<T>> Semigroup<C> firstNonEmpty()

Returns:: Combination of two Collection, first non-zero is returned

lastNonEmpty

static <T,C extends java.util.Collection<T>> Semigroup<C> lastNonEmpty()

Returns:: Combination of two Collection, last non-zero is returned

firstNonNull
```
static <T> Semigroup<T> firstNonNull()
```
Returns:

Combination of two Objects of same type, first non-null is returned

firstCompleteCompletableFuture

static <T> Semigroup<java.util.concurrent.CompletableFuture<T>> firstCompleteCompletableFuture()

Returns:: Combine two CompletableFuture's by taking the first present

firstCompleteFuture
```
static <T> Semigroup<Future<T>> firstCompleteFuture()
```
Returns:

Combine two Future's by taking the first result

zippedFutures

static <T> Semigroup<Future<T>> zippedFutures(Semigroup<T> s)

firstSuccessfulFuture
```
static <T> Semigroup<Future<T>> firstSuccessfulFuture()
```
Returns:

Combine two Future's by taking the first successful

firstRightEither
```
static <ST,PT> Semigroup<Either<ST,PT>> firstRightEither()
```
Returns:

Combine two Eithers by taking the first right

firstLeftEither
```
static <ST,PT> Semigroup<Either<ST,PT>> firstLeftEither()
```
Returns:

Combine two Eithers by taking the first left

lastRightEither
```
static <ST,PT> Semigroup<Either<ST,PT>> lastRightEither()
```
Returns:

Combine two Eithers by taking the last right

lastLeftEither
```
static <ST,PT> Semigroup<Either<ST,PT>> lastLeftEither()
```
Returns:

Combine two Eithers by taking the last left

firstTrySuccess

static <T,X extends java.lang.Throwable> Semigroup<Try<T,X>> firstTrySuccess()

Returns:: Combine two Try's by taking the first right

firstTryFailure

static <T,X extends java.lang.Throwable> Semigroup<Try<T,X>> firstTryFailure()

Returns:: Combine two Try's by taking the first left

lastTrySuccess

static <T,X extends java.lang.Throwable> Semigroup<Try<T,X>> lastTrySuccess()

Returns:: Combine two Tryr's by taking the last right

lastTryFailure

static <T,X extends java.lang.Throwable> Semigroup<Try<T,X>> lastTryFailure()

Returns:: Combine two Try's by taking the last left

firstPrimaryIor
```
static <ST,PT> Semigroup<Ior<ST,PT>> firstPrimaryIor()
```
Returns:

Combine two Ior's by taking the first right

firstSecondaryIor
```
static <ST,PT> Semigroup<Ior<ST,PT>> firstSecondaryIor()
```
Returns:

Combine two Ior's by taking the first left

lastPrimaryIor
```
static <ST,PT> Semigroup<Ior<ST,PT>> lastPrimaryIor()
```
Returns:

Combine two Ior's by taking the last right

lastSecondaryIor
```
static <ST,PT> Semigroup<Ior<ST,PT>> lastSecondaryIor()
```
Returns:

Combine two Ior's by taking the last left

firstPresentMaybe
```
static <T> Semigroup<Maybe<T>> firstPresentMaybe()
```
Returns:

Combine two Maybe's by taking the first present

firstPresentOptional
```
static <T> Semigroup<java.util.Optional<T>> firstPresentOptional()
```
Returns:

Combine two optionals by taking the first present

lastPresentMaybe
```
static <T> Semigroup<Maybe<T>> lastPresentMaybe()
```
Returns:

Combine two Maybes by taking the last present

lastPresentOptional
```
static <T> Semigroup<java.util.Optional<T>> lastPresentOptional()
```
Returns:

Combine two optionals by taking the last present

stringJoin
```
static Semigroup<java.lang.String> stringJoin(java.lang.String joiner)
```
Parameters:

joiner - Separator in joined String

Returns:

Combine two strings separated by the supplied joiner

stringBuilderJoin
```
static Semigroup<java.lang.StringBuilder> stringBuilderJoin(java.lang.String joiner)
```
Parameters:

joiner - Separator in joined String

Returns:

Combine two StringBuilders separated by the supplied joiner

stringBufferJoin
```
static Semigroup<java.lang.StringBuffer> stringBufferJoin(java.lang.String joiner)
```
Parameters:

joiner - Separator in joined String

Returns:

Combine two StringBuffers separated by the supplied joiner

minComparable

static <T,T2 extends java.lang.Comparable<T>> Semigroup<T2> minComparable()

Returns:: Combine two Comparables taking the lowest each time

maxComparable

static <T,T2 extends java.lang.Comparable<T>> Semigroup<T2> maxComparable()

Returns:: Combine two Comparables taking the highest each time

functionComposition

static <A> Semigroup<java.util.function.Function<A,A>> functionComposition()

Returns:: Combine function

naturalTransformationComposition

static <A> Semigroup<NaturalTransformation<A,A>> naturalTransformationComposition()

Interface Semigroups