-
Notifications
You must be signed in to change notification settings - Fork 5
/
Set.php
448 lines (392 loc) · 9.82 KB
/
Set.php
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
<?php
declare(strict_types = 1);
namespace Innmind\Immutable;
use Innmind\Immutable\Exception\CannotGroupEmptyStructure;
/**
* @template T
*/
final class Set implements \Countable
{
private string $type;
private ValidateArgument $validate;
private Set\Implementation $implementation;
/**
* {@inheritdoc}
*/
private function __construct(string $type, Set\Implementation $implementation)
{
$this->type = $type;
$this->validate = Type::of($type);
$this->implementation = $implementation;
}
/**
* @param T $values
*
* @return self<T>
*/
public static function of(string $type, ...$values): self
{
return new self($type, new Set\Primitive($type, ...$values));
}
/**
* It will load the values inside the generator only upon the first use
* of the set
*
* Use this mode when the amount of data may not fit in memory
*
* @param \Generator<T> $generator
*
* @return self<T>
*/
public static function defer(string $type, \Generator $generator): self
{
return new self($type, new Set\Defer($type, $generator));
}
/**
* It will call the given function every time a new operation is done on the
* set. This means the returned structure may not be truly immutable as
* between the calls the underlying source may change.
*
* Use this mode when calling to an external source (meaning IO bound) such
* as parsing a file or calling an API
*
* @param callable(): \Generator<T> $generator
*
* @return self<T>
*/
public static function lazy(string $type, callable $generator): self
{
return new self($type, new Set\Lazy($type, $generator));
}
/**
* @param mixed $values
*
* @return self<mixed>
*/
public static function mixed(...$values): self
{
return new self('mixed', new Set\Primitive('mixed', ...$values));
}
/**
* @return self<int>
*/
public static function ints(int ...$values): self
{
/** @var self<int> */
$self = new self('int', new Set\Primitive('int', ...$values));
return $self;
}
/**
* @return self<float>
*/
public static function floats(float ...$values): self
{
/** @var self<float> */
$self = new self('float', new Set\Primitive('float', ...$values));
return $self;
}
/**
* @return self<string>
*/
public static function strings(string ...$values): self
{
/** @var self<string> */
$self = new self('string', new Set\Primitive('string', ...$values));
return $self;
}
/**
* @return self<object>
*/
public static function objects(object ...$values): self
{
/** @var self<object> */
$self = new self('object', new Set\Primitive('object', ...$values));
return $self;
}
public function isOfType(string $type): bool
{
return $this->type === $type;
}
/**
* Return the type of this set
*/
public function type(): string
{
return $this->type;
}
public function size(): int
{
return $this->implementation->size();
}
/**
* {@inheritdoc}
*/
public function count(): int
{
return $this->implementation->size();
}
/**
* Intersect this set with the given one
*
* @param self<T> $set
*
* @return self<T>
*/
public function intersect(self $set): self
{
assertSet($this->type, $set, 1);
$newSet = clone $this;
$newSet->implementation = $this->implementation->intersect(
$set->implementation,
);
return $newSet;
}
/**
* Add an element to the set
*
* @param T $element
*
* @return self<T>
*/
public function add($element): self
{
return ($this)($element);
}
/**
* Add an element to the set
*
* Example:
* <code>
* Set::of('int')(1)(3)
* </code>
*
* @param T $element
*
* @return self<T>
*/
public function __invoke($element): self
{
($this->validate)($element, 1);
$self = clone $this;
$self->implementation = ($this->implementation)($element);
return $self;
}
/**
* Check if the set contains the given element
*
* @param T $element
*/
public function contains($element): bool
{
($this->validate)($element, 1);
return $this->implementation->contains($element);
}
/**
* Remove the element from the set
*
* @param T $element
*
* @return self<T>
*/
public function remove($element): self
{
($this->validate)($element, 1);
$self = clone $this;
$self->implementation = $this->implementation->remove($element);
return $self;
}
/**
* Return the diff between this set and the given one
*
* @param self<T> $set
*
* @return self<T>
*/
public function diff(self $set): self
{
assertSet($this->type, $set, 1);
$self = clone $this;
$self->implementation = $this->implementation->diff(
$set->implementation,
);
return $self;
}
/**
* Check if the given set is identical to this one
*
* @param self<T> $set
*/
public function equals(self $set): bool
{
assertSet($this->type, $set, 1);
return $this->implementation->equals($set->implementation);
}
/**
* Return all elements that satisfy the given predicate
*
* @param callable(T): bool $predicate
*
* @return self<T>
*/
public function filter(callable $predicate): self
{
$set = clone $this;
$set->implementation = $this->implementation->filter($predicate);
return $set;
}
/**
* Apply the given function to all elements of the set
*
* @param callable(T): void $function
*/
public function foreach(callable $function): void
{
$this->implementation->foreach($function);
}
/**
* Return a new map of pairs grouped by keys determined with the given
* discriminator function
*
* @template D
* @param callable(T): D $discriminator
*
* @throws CannotGroupEmptyStructure
*
* @return Map<D, self<T>>
*/
public function groupBy(callable $discriminator): Map
{
return $this->implementation->groupBy($discriminator);
}
/**
* Return a new set by applying the given function to all elements
*
* @param callable(T): T $function
*
* @return self<T>
*/
public function map(callable $function): self
{
$self = $this->clear();
$self->implementation = $this->implementation->map($function);
return $self;
}
/**
* Create a new Set with the exact same number of elements but with a
* new type transformed via the given function
*
* @template S
*
* @param callable(T): S $map
*
* @return self<S>
*/
public function mapTo(string $type, callable $map): self
{
/** @psalm-suppress MixedArgument */
return $this->toSetOf(
$type,
static fn($value): \Generator => yield $map($value),
);
}
/**
* Return a sequence of 2 sets partitioned according to the given predicate
*
* @param callable(T): bool $predicate
*
* @return Map<bool, self<T>>
*/
public function partition(callable $predicate): Map
{
return $this->implementation->partition($predicate);
}
/**
* Return a sequence sorted with the given function
*
* @param callable(T, T): int $function
*
* @return Sequence<T>
*/
public function sort(callable $function): Sequence
{
return $this->implementation->sort($function);
}
/**
* Create a new set with elements of both sets
*
* @param self<T> $set
*
* @return self<T>
*/
public function merge(self $set): self
{
assertSet($this->type, $set, 1);
$self = clone $this;
$self->implementation = $this->implementation->merge(
$set->implementation,
);
return $self;
}
/**
* Reduce the set to a single value
*
* @template R
* @param R $carry
* @param callable(R, T): R $reducer
*
* @return R
*/
public function reduce($carry, callable $reducer)
{
return $this->implementation->reduce($carry, $reducer);
}
/**
* Return a set of the same type but without any value
*
* @return self<T>
*/
public function clear(): self
{
$self = clone $this;
$self->implementation = $this->implementation->clear();
return $self;
}
public function empty(): bool
{
return $this->implementation->empty();
}
/**
* @template ST
*
* @param null|callable(T): \Generator<ST> $mapper
*
* @return Sequence<ST>
*/
public function toSequenceOf(string $type, callable $mapper = null): Sequence
{
return $this->implementation->toSequenceOf($type, $mapper);
}
/**
* @template ST
*
* @param null|callable(T): \Generator<ST> $mapper
*
* @return self<ST>
*/
public function toSetOf(string $type, callable $mapper = null): self
{
return $this->implementation->toSetOf($type, $mapper);
}
/**
* @template MT
* @template MS
*
* @param callable(T): \Generator<MT, MS> $mapper
*
* @return Map<MT, MS>
*/
public function toMapOf(string $key, string $value, callable $mapper): Map
{
return $this->implementation->toMapOf($key, $value, $mapper);
}
}