forked from functionaljava/functionaljava
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathSemigroup.java
More file actions
653 lines (555 loc) · 17.5 KB
/
Semigroup.java
File metadata and controls
653 lines (555 loc) · 17.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
package fj;
import fj.data.Array;
import fj.data.DList;
import fj.data.List;
import fj.data.IO;
import fj.data.Natural;
import fj.data.NonEmptyList;
import fj.data.Option;
import fj.data.Set;
import fj.data.Stream;
import java.math.BigDecimal;
import java.math.BigInteger;
import static fj.F1Functions.dimap;
import static fj.Function.constant;
import static fj.Function.identity;
import static fj.Monoid.*;
import static fj.data.DList.listDList;
import static fj.data.Option.none;
import static fj.data.Option.some;
/**
* Implementations must satisfy the law of associativity:
* <ul>
* <li><em>Associativity</em>; forall x. forall y. forall z. sum(sum(x, y), z) == sum(x, sum(y, z))</li>
* </ul>
*
* @version %build.number%
*/
public final class Semigroup<A> {
/**
* Primitives functions of Semigroup: minimal definition and overridable methods.
*/
public interface Definition<A> {
A append(A a1, A a2);
default F<A, A> prepend(A a) {
return a2 -> append(a, a2);
}
default A sum(A a, F0<Stream<A>> as) {
return as.f().foldLeft(this::append, a);
}
default A multiply1p(int n, A a) {
if (n <= 0) {
return a;
}
A xTmp = a;
int yTmp = n;
A zTmp = a;
while (true) {
if ((yTmp & 1) == 1) {
zTmp = append(xTmp, zTmp);
if (yTmp == 1) {
return zTmp;
}
}
xTmp = append(xTmp, xTmp);
yTmp = (yTmp) >>> 1;
}
}
default Definition<A> dual() {
return new Definition<A>(){
@Override
public A append(A a1, A a2) {
return Definition.this.append(a2, a1);
}
@Override
public A multiply1p(int n, A a) {
return Definition.this.multiply1p(n, a);
}
};
}
}
/**
* Primitives functions of Semigroup: alternative minimal definition and overridable methods.
*/
public interface AltDefinition<A> extends Definition<A> {
@Override
F<A, A> prepend(A a);
@Override
default A append(A a1, A a2) {
return prepend(a1).f(a2);
}
}
private final Definition<A> def;
private Semigroup(final Definition<A> def) {
this.def = def;
}
/**
* Sums the two given arguments.
*
* @param a1 A value to sum with another.
* @param a2 A value to sum with another.
* @return The of the two given arguments.
*/
public A sum(final A a1, final A a2) {
return def.append(a1, a2);
}
/**
* Returns a function that sums the given value according to this semigroup.
*
* @param a1 The value to sum.
* @return A function that sums the given value according to this semigroup.
*/
public F<A, A> sum(final A a1) {
return def.prepend(a1);
}
/**
* Returns a function that sums according to this semigroup.
*
* @return A function that sums according to this semigroup.
*/
public F<A, F<A, A>> sum() {
return def::prepend;
}
/**
* Returns a value summed <code>n + 1</code> times (
* <code>a + a + ... + a</code>) The default definition uses peasant
* multiplication, exploiting associativity to only require `O(log n)` uses of
* {@link #sum(Object, Object)}.
*
* @param n multiplier
* @param a the value to be reapeatly summed n + 1 times
* @return {@code a} summed {@code n} times. If {@code n <= 0}, returns
* {@code zero()}
*/
public A multiply1p(int n, A a) {
return def.multiply1p(n, a);
}
/**
* Sums the given values with left-fold.
*/
public A sumNel(final NonEmptyList<A> as) {
return as.foldLeft1(def::append);
}
/**
* Sums the given values with left-fold, shortcutting the computation as early as possible.
*/
public A sumStream(A a, F0<Stream<A>> as) {
return def.sum(a, as);
}
/**
* Swaps the arguments when summing.
*/
public Semigroup<A> dual() {
return semigroupDef(def.dual());
}
/**
* Lifts the semigroup to obtain a trivial monoid.
*/
public Monoid<Option<A>> lift() {
Definition<A> def = this.def;
return monoidDef(new Monoid.Definition<Option<A>>() {
@Override
public Option<A> empty() {
return none();
}
@Override
public Option<A> append(Option<A> a1, Option<A> a2) {
return a1.liftM2(a1, def::append).orElse(a1).orElse(a2);
}
@Override
public Option<A> multiply(int n, Option<A> oa) {
return n > 0 ? oa.map(a -> def.multiply1p(n - 1, a)) : none();
}
@Override
public Option<A> sum(F0<Stream<Option<A>>> oas) {
Stream<A> as = oas.f().bind(Option::toStream);
return as.uncons(none(), h -> tail -> some(def.sum(h, tail::_1)));
}
});
}
/**
* Maps the given functions across this monoid as an invariant functor.
*
* @param f The covariant map.
* @param g The contra-variant map.
* @return A new monoid.
*/
public <B> Semigroup<B> xmap(final F<A, B> f, final F<B, A> g) {
Definition<A> def = this.def;
return semigroupDef(new Definition<B>() {
@Override
public B append(B a1, B a2) {
return f.f(def.append(g.f(a1), g.f(a2)));
}
@Override
public F<B, B> prepend(B b) {
return dimap(def.prepend(g.f(b)), g, f);
}
@Override
public B multiply1p(int n, B b) {
return f.f(def.multiply1p(n , g.f(b)));
}
@Override
public B sum(B b, F0<Stream<B>> bs) {
return f.f(def.sum(g.f(b), () -> bs.f().map(g)));
}
});
}
public <B, C> Semigroup<C> compose(Semigroup<B> sb, final F<C, B> b, final F<C, A> a, final F2<A, B, C> c) {
Definition<A> saDef = this.def;
Definition<B> sbDef = sb.def;
return semigroupDef(new Definition<C>() {
@Override
public C append(C c1, C c2) {
return c.f(saDef.append(a.f(c1), a.f(c2)), sbDef.append(b.f(c1), b.f(c2)));
}
@Override
public F<C, C> prepend(C c1) {
F<A, A> prependA = saDef.prepend(a.f(c1));
F<B, B> prependB = sbDef.prepend(b.f(c1));
return c2 -> c.f(prependA.f(a.f(c2)), prependB.f(b.f(c2)));
}
@Override
public C multiply1p(int n, C c1) {
return c.f(saDef.multiply1p(n, a.f(c1)), sbDef.multiply1p(n, b.f(c1)));
}
@Override
public C sum(C c1, F0<Stream<C>> cs) {
return c.f(saDef.sum(a.f(c1), () -> cs.f().map(a)), sbDef.sum(b.f(c1), () -> cs.f().map(b)));
}
});
}
/**
* Constructs a monoid from this semigroup and a zero value, which must follow the monoidal laws.
*
* @param zero The zero for the monoid.
* @return A monoid instance that uses the given sun function and zero value.
*/
public Monoid<A> monoid(A zero) {
return monoidDef(this.def, zero);
}
/**
* Constructs a semigroup from the given definition.
*
* @param def The definition to construct this semigroup with.
* @return A semigroup from the given definition.
*/
public static <A> Semigroup<A> semigroupDef(final Definition<A> def) {
return new Semigroup<>(def);
}
/**
* Constructs a semigroup from the given definition.
*
* @param def The definition to construct this semigroup with.
* @return A semigroup from the given definition.
*/
public static <A> Semigroup<A> semigroupDef(final AltDefinition<A> def) {
return new Semigroup<>(def);
}
/**
* Constructs a semigroup from the given function.
* Java 8+ users: use {@link #semigroupDef(AltDefinition)} instead.
*
* @param sum The function to construct this semigroup with.
* @return A semigroup from the given function.
*/
public static <A> Semigroup<A> semigroup(final F<A, F<A, A>> sum) {
return semigroupDef(sum::f);
}
/**
* Constructs a semigroup from the given function.
* Java 8+ users: use {@link #semigroupDef(Definition)} instead.
*
* @param sum The function to construct this semigroup with.
* @return A semigroup from the given function.
*/
public static <A> Semigroup<A> semigroup(final F2<A, A, A> sum) {
return new Semigroup<>(sum::f);
}
/**
* A semigroup that adds integers.
*/
public static final Semigroup<Integer> intAdditionSemigroup = intAdditionMonoid.semigroup();
/**
* @deprecated Since 4.7. Due to rounding errors, addition of doubles does not comply with monoid laws
*/
@Deprecated
public static final Semigroup<Double> doubleAdditionSemigroup = semigroupDef((d1, d2) -> d1 + d2);
/**
* A semigroup that multiplies integers.
*/
public static final Semigroup<Integer> intMultiplicationSemigroup = intMultiplicationMonoid.semigroup();
/**
* @deprecated Since 4.7. Due to rounding errors, addition of doubles does not comply with monoid laws
*/
@Deprecated
public static final Semigroup<Double> doubleMultiplicationSemigroup = semigroupDef((d1, d2) -> d1 * d2);
/**
* A semigroup that yields the maximum of integers.
*/
public static final Semigroup<Integer> intMaximumSemigroup = intMaxMonoid.semigroup();
/**
* A semigroup that yields the minimum of integers.
*/
public static final Semigroup<Integer> intMinimumSemigroup = intMinMonoid.semigroup();
/**
* A semigroup that adds big integers.
*/
public static final Semigroup<BigInteger> bigintAdditionSemigroup = bigintAdditionMonoid.semigroup();
/**
* A semigroup that multiplies big integers.
*/
public static final Semigroup<BigInteger> bigintMultiplicationSemigroup =
semigroup(BigInteger::multiply);
/**
* A semigroup that yields the maximum of big integers.
*/
public static final Semigroup<BigInteger> bigintMaximumSemigroup = Ord.bigintOrd.maxSemigroup();
/**
* A semigroup that yields the minimum of big integers.
*/
public static final Semigroup<BigInteger> bigintMinimumSemigroup = Ord.bigintOrd.minSemigroup();
/**
* A semigroup that adds big decimals.
*/
public static final Semigroup<BigDecimal> bigdecimalAdditionSemigroup = bigdecimalAdditionMonoid.semigroup();
/**
* A semigroup that multiplies big decimals.
*/
public static final Semigroup<BigDecimal> bigdecimalMultiplicationSemigroup = bigdecimalMultiplicationMonoid.semigroup();
/**
* A semigroup that yields the maximum of big decimals.
*/
public static final Semigroup<BigDecimal> bigDecimalMaximumSemigroup = Ord.bigdecimalOrd.maxSemigroup();
/**
* A semigroup that yields the minimum of big decimals.
*/
public static final Semigroup<BigDecimal> bigDecimalMinimumSemigroup = Ord.bigdecimalOrd.minSemigroup();
/**
* A semigroup that multiplies natural numbers.
*/
public static final Semigroup<Natural> naturalMultiplicationSemigroup = naturalMultiplicationMonoid.semigroup();
/**
* A semigroup that adds natural numbers.
*/
public static final Semigroup<Natural> naturalAdditionSemigroup = naturalAdditionMonoid.semigroup();
/**
* A semigroup that yields the maximum of natural numbers.
*/
public static final Semigroup<Natural> naturalMaximumSemigroup = Ord.naturalOrd.maxSemigroup();
/**
* A semigroup that yields the minimum of natural numbers.
*/
public static final Semigroup<Natural> naturalMinimumSemigroup = Ord.naturalOrd.minSemigroup();
/**
* A semigroup that adds longs.
*/
public static final Semigroup<Long> longAdditionSemigroup = longAdditionMonoid.semigroup();
/**
* A semigroup that multiplies longs.
*/
public static final Semigroup<Long> longMultiplicationSemigroup = longMultiplicationMonoid.semigroup();
/**
* A semigroup that yields the maximum of longs.
*/
public static final Semigroup<Long> longMaximumSemigroup = Ord.longOrd.maxSemigroup();
/**
* A semigroup that yields the minimum of longs.
*/
public static final Semigroup<Long> longMinimumSemigroup = Ord.longOrd.minSemigroup();
/**
* A semigroup that ORs booleans.
*/
public static final Semigroup<Boolean> disjunctionSemigroup = disjunctionMonoid.semigroup();
/**
* A semigroup that XORs booleans.
*/
public static final Semigroup<Boolean> exclusiveDisjunctionSemiGroup = exclusiveDisjunctionMonoid.semigroup();
/**
* A semigroup that ANDs booleans.
*/
public static final Semigroup<Boolean> conjunctionSemigroup = conjunctionMonoid.semigroup();
/**
* A semigroup that appends strings.
*/
public static final Semigroup<String> stringSemigroup = stringMonoid.semigroup();
/**
* A semigroup that appends string buffers.
*/
public static final Semigroup<StringBuffer> stringBufferSemigroup = stringBufferMonoid.semigroup();
/**
* A semigroup that appends string builders.
*/
public static final Semigroup<StringBuilder> stringBuilderSemigroup = stringBuilderMonoid.semigroup();
/**
* A semigroup which always uses the "first" (left-hand side) value.
*/
public static <A> Semigroup<A> firstSemigroup() {
return semigroupDef(new Definition<A>() {
@Override
public A append(A a1, A a2) {
return a1;
}
@Override
public F<A, A> prepend(A a) {
return constant(a);
}
@Override
public A multiply1p(int n, A a) {
return a;
}
@Override
public A sum(A a, F0<Stream<A>> as) {
return a;
}
});
}
/**
* A semigroup which always uses the "last" (right-hand side) value.
*/
public static <A> Semigroup<A> lastSemigroup() {
return semigroupDef(new Definition<A>() {
@Override
public A append(A a1, A a2) {
return a2;
}
@Override
public F<A, A> prepend(A a) {
return identity();
}
@Override
public A multiply1p(int n, A a) {
return a;
}
});
}
/**
* A semigroup for functions.
*
* @param sb The smeigroup for the codomain.
* @return A semigroup for functions.
*/
public static <A, B> Semigroup<F<A, B>> functionSemigroup(final Semigroup<B> sb) {
Definition<B> sbDef = sb.def;
return semigroupDef((a1, a2) -> a -> sbDef.append(a1.f(a), a2.f(a)));
}
/**
* A semigroup for lists.
*
* @return A semigroup for lists.
*/
public static <A> Semigroup<List<A>> listSemigroup() {
return Monoid.<A>listMonoid().semigroup();
}
/**
* A semigroup for non-empty lists.
*
* @return A semigroup for non-empty lists.
*/
public static <A> Semigroup<NonEmptyList<A>> nonEmptyListSemigroup() {
return semigroupDef(new Definition<NonEmptyList<A>>() {
@Override
public NonEmptyList<A> append(NonEmptyList<A> a1, NonEmptyList<A> a2) {
return a1.append(a2);
}
@Override
public NonEmptyList<A> sum(NonEmptyList<A> nea, F0<Stream<NonEmptyList<A>>> neas) {
List<A> tail = neas.f().map(nel -> listDList(nel.toList())).foldLeft(DList::append, DList.<A>nil()).run();
return nea.append(tail);
}
});
}
/**
* A semigroup for optional values.
* @deprecated since 4.7. Use {@link #firstOptionSemigroup()}.
*
** @return A semigroup for optional values.
*/
public static <A> Semigroup<Option<A>> optionSemigroup() {
return firstOptionSemigroup();
}
/**
* A semigroup for optional values that take the first available value.
*
* @return A semigroup for optional values that take the first available value.
*/
public static <A> Semigroup<Option<A>> firstOptionSemigroup() {
return Monoid.<A>firstOptionMonoid().semigroup();
}
/**
* A semigroup for optional values that take the last available value.
*
* @return A semigroup for optional values that take the last available value.
*/
public static <A> Semigroup<Option<A>> lastOptionSemigroup() {
return Monoid.<A>lastOptionMonoid().semigroup();
}
/**
* A semigroup for streams.
*
* @return A semigroup for streams.
*/
public static <A> Semigroup<Stream<A>> streamSemigroup() {
return Monoid.<A>streamMonoid().semigroup();
}
/**
* A semigroup for arrays.
*
* @return A semigroup for arrays.
*/
public static <A> Semigroup<Array<A>> arraySemigroup() {
return Monoid.<A>arrayMonoid().semigroup();
}
/**
* A lazy semigroup for unary products.
*
* @param sa A semigroup for the product's type.
* @return A semigroup for unary products.
*/
public static <A> Semigroup<P1<A>> p1Semigroup(final Semigroup<A> sa) {
Definition<A> def = sa.def;
return semigroupDef(new Definition<P1<A>>() {
@Override
public P1<A> append(P1<A> a1, P1<A> a2) {
return P.lazy(() -> def.append(a1._1(), a2._1()));
}
@Override
public P1<A> multiply1p(int n, P1<A> ap1) {
return P.lazy(() -> def.multiply1p(n, ap1._1()));
}
@Override
public P1<A> sum(P1<A> ap1, F0<Stream<P1<A>>> as) {
return P.lazy(() -> def.sum(ap1._1(), () -> as.f().map(P1.__1())));
}
});
}
/**
* A lazy semigroup for binary products.
*
* @param sa A semigroup for the product's first type.
* @param sb A semigroup for the product's second type.
* @return A semigroup for binary products.
*/
public static <A, B> Semigroup<P2<A, B>> p2Semigroup(final Semigroup<A> sa, final Semigroup<B> sb) {
return semigroupDef((a1, a2) -> P.lazy(() -> sa.sum(a1._1(), a2._1()), () -> sb.sum(a1._2(), a2._2())));
}
/**
* A semigroup for IO values.
*/
public static <A> Semigroup<IO<A>> ioSemigroup(final Semigroup <A> sa) {
Definition<A> def = sa.def;
return semigroupDef((a1, a2) -> () -> def.append(a1.run(), a2.run()));
}
/**
* A semigroup for the Unit value.
*/
public static final Semigroup<Unit> unitSemigroup = unitMonoid.semigroup();
/**
* A semigroup for sets.
*
* @return a semigroup for sets.
*/
public static <A> Semigroup<Set<A>> setSemigroup() {
return semigroupDef(Set::union);
}
}