-
Notifications
You must be signed in to change notification settings - Fork 668
/
SliceOps.java
1356 lines (1150 loc) · 72.4 KB
/
SliceOps.java
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
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (c) 2012, 2016, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package java.util.stream;
import java.util.Spliterator;
import java.util.concurrent.CountedCompleter;
import java.util.function.IntFunction;
/**
* Factory for instances of a short-circuiting stateful intermediate operations that produce subsequences of their input stream.
*
* @since 1.8
*/
// 应用在有状态的中间阶段的辅助类,服务于limit(long)方法和skip(long)方法
final class SliceOps {
private SliceOps() {
}
/**
* Appends a "slice" operation to the provided stream. The slice operation
* may be may be skip-only, limit-only, or skip-and-limit.
*
* @param <T> the type of both input and output elements
* @param upstream a reference stream with element type T
* @param skip the number of elements to skip. Must be >= 0.
* @param limit the maximum size of the resulting stream, or -1 if no limit is to be imposed
*/
/*
* 构造有状态的中间阶段的流,适用于limit(long)方法和skip(long)方法(引用类型版本)
*
* upstream: 上个阶段的流
* skip : 需要跳过的元素数量,必须>=0
* limit : 返回的流中可以包含的最大元素数量,-1表示没限制
*/
public static <T> Stream<T> makeRef(AbstractPipeline<?, T, ?> upstream, long skip, long limit) {
if(skip<0) {
throw new IllegalArgumentException("Skip must be non-negative: " + skip);
}
// 返回一个有状态的流的中间阶段;该阶段的操作会对upstream流阶段发来的数据进行跳过或选择保存一段数据
return new ReferencePipeline.StatefulOp<T, T>(upstream, StreamShape.REFERENCE, flags(limit)) {
// 构造并返回属于当前流阶段的sink,该sink通常与downSink形成一个链条,以决定如何处理上个流阶段发来的数据
@Override
Sink<T> opWrapSink(int flags, Sink<T> downSink) {
// 返回一个链式Sink,其中downstream的值就是downSink,即下个流阶段的sink
return new Sink.ChainedReference<T, T>(downSink) {
// 需要跳过的元素数量
long n = skip;
// 发送给下游的元素数量上限
long m = limit >= 0 ? limit : Long.MAX_VALUE;
@Override
public void begin(long size) {
// 计算需要发给下游的元素数量
size = calcSize(size, skip, m);
downstream.begin(size);
}
@Override
public void accept(T t) {
// 如果该跳过的元素都跳过了
if(n == 0) {
// 如果待发送元素量大于0,则向下游发送一个元素
if(m>0) {
m--;
downstream.accept(t);
}
// 如果还有未跳过的元素,则计数递减
} else {
n--;
}
}
@Override
public boolean cancellationRequested() {
// 如果已经没有待发送元素了,或者下游反馈了取消择取的信号,则此处也要向上游反馈"取消"信号
return m == 0 || downstream.cancellationRequested();
}
};
}
/*
* 并行处理helper流阶段输出的元素,然后将处理结果封装到流迭代器中返回。
*
* 通常,如果helper流阶段的数据已经满足当前阶段的预期,则会直接包装helper流阶段的数据到流迭代器中。
* 否则,会视情形创建终端sink来处理helper流阶段的数据,并同样将其封装到流迭代器中返回。
* 还可能会对spliterator做进一步的包装,返回一个与当前操作匹配的流迭代器。
*
* helper : 某个流阶段,通常需要在当前终端操作中处理从helper阶段输出的数据
* spliterator: 待处理的数据的源头,该流迭代器属于helper之前的(depth==0)的流阶段(包含helper阶段)
*
* 不同的中间操作会重写该方法,以在该方法中使用不同的方式处理数据。
* 返回值代表了当前阶段的流处理器。
*
* 该方法仅在有状态的中间(操作)阶段上调用,如果某阶段的opIsStateful()返回true,则实现必须重写该方法。
*/
@Override
<P_IN> Spliterator<T> opEvaluateParallelLazy(PipelineHelper<T> helper, Spliterator<P_IN> spliterator) {
/*
* 返回一个"包装"流迭代器,使用该流迭代器可以获取helper流流阶段的输出元素。
*
* spliterator: 相对于helper流阶段的上个(depth==0)的流阶段的流迭代器
*/
Spliterator<T> wrapSpliterator = helper.wrapSpliterator(spliterator);
/*
* 初始时,尝试返回spliterator中的元素总量。如果无法获取精确值,则返回-1。
* 当访问过spliterator中的元素后,此处的返回值可能是元素总量,也可能是剩余未访问的元素数量,依实现而定。
*
* 注:通常在流拥有SIZED参数(相当于spliterator有SIZED参数)时可以获取到一个精确值。
*/
long size = helper.exactOutputSizeIfKnown(spliterator);
// 1.如果流中元素的数量以及切割后的子流中的元素数量均是有限的,则可以直接切片
if(size>0 && spliterator.hasCharacteristics(Spliterator.SUBSIZED)) {
// 计算切片的终止索引
long sliceFence = calcSliceFence(skip, limit);
// 返回一个"分片"流迭代器
return new StreamSpliterators.SliceSpliterator.OfRef<>(wrapSpliterator, skip, sliceFence);
}
// 获取helper流阶段的组合参数
int streamAndOpFlags = helper.getStreamAndOpFlags();
// 2.如果helper流阶段的元素没有固定的遭遇顺序,则使用"无序"流迭代器
if(!StreamOpFlag.ORDERED.isKnown(streamAndOpFlags)) {
// 返回一个"无序"流迭代器
return unorderedSkipLimitSpliterator(wrapSpliterator, skip, limit, size);
}
/*
* OOMEs will occur for LongStream.range(0, Long.MAX_VALUE).filter(i -> true).limit(n)
* when n * parallelismLevel is sufficiently large.
*
* Need to adjust the target size of splitting for the
* SliceTask from say (size / k) to say min(size / k, 1 << 14)
* This will limit the size of the buffers created at the leaf nodes
* cancellation will be more aggressive cancelling later tasks
* if the target slice size has been reached from a given task,
* cancellation should also clear local results if any
*/
/*
* 3.至此说明元素数量无限或未知,但是有固定的遭遇顺序。
* 此时需要使用特定的task来完成"分片"操作。
*/
// 返回用于创建T类型数组的函数表达式
IntFunction<T[]> generator = Nodes.castingArray();
// 构造"分片"任务,用来跳过某段元素,并保留指定数量的元素
SliceTask<P_IN, T> sliceTask = new SliceTask<>(this, helper, spliterator, generator, skip, limit);
// 执行任务,返回执行结果
Node<T> node = sliceTask.invoke();
// 返回可以代表node的流迭代器
return node.spliterator();
}
/*
* 并行处理helper流阶段输出的元素,返回处理后的结果。
*
* 通常,如果helper流阶段的数据已经满足当前阶段的预期,则会直接返回helper流阶段的数据。
* 否则,会视情形创建终端sink来处理helper流阶段的数据并返回。
* 还可能不经过sink,而是直接处理helper流阶段的数据,并将处理后的数据返回。
*
* helper : 某个流阶段,通常需要在当前终端操作中处理从helper阶段输出的数据
* spliterator: 待处理的数据的源头,该流迭代器属于helper之前的(depth==0)的流阶段(包含helper阶段)
* generator : 必要的时候,创建存储处理结果的定长数组
*
* 不同的中间操作会重写该方法,以在该方法中使用不同的方式处理数据。
* 返回值代表了当前(操作)阶段处理后的数据。
*
* 该方法仅在有状态的中间(操作)阶段上调用,如果某阶段的opIsStateful()返回true,则实现必须重写该方法。
*/
@Override
<P_IN> Node<T> opEvaluateParallel(PipelineHelper<T> helper, Spliterator<P_IN> spliterator, IntFunction<T[]> generator) {
/*
* 初始时,尝试返回spliterator中的元素总量。如果无法获取精确值,则返回-1。
* 当访问过spliterator中的元素后,此处的返回值可能是元素总量,也可能是剩余未访问的元素数量,依实现而定。
*
* 注:通常在流拥有SIZED参数(相当于spliterator有SIZED参数)时可以获取到一个精确值。
*/
long size = helper.exactOutputSizeIfKnown(spliterator);
// 1.如果流中元素的数量以及切割后的子流中的元素数量均是有限的,则可以直接切片
if(size>0 && spliterator.hasCharacteristics(Spliterator.SUBSIZED)) {
/*
* Because the pipeline is SIZED the slice spliterator
* can be created from the source, this requires matching
* to shape of the source, and is potentially more efficient
* than creating the slice spliterator from the pipeline wrapping spliterator
*/
// 返回一个"分片"流迭代器
Spliterator<P_IN> sliceSpliterator = sliceSpliterator(helper.getSourceShape(), spliterator, skip, limit);
/*
* 并行搜集元素,中间依然会经过sink的择取操作(引用类型版本)。
* 将sliceSpliterator中的元素并行地收集到generator生成的数组中,然后将该数组封装到Node中返回。
*/
return Nodes.collect(helper, sliceSpliterator, true, generator);
}
// 获取helper流阶段的组合参数
int streamAndOpFlags = helper.getStreamAndOpFlags();
// 2.如果helper流阶段的元素没有固定的遭遇顺序,则使用"无序"流迭代器
if(!StreamOpFlag.ORDERED.isKnown(streamAndOpFlags)) {
/*
* 返回一个"包装"流迭代器,使用该流迭代器可以获取helper流流阶段的输出元素。
*
* spliterator: 相对于helper流阶段的上个(depth==0)的流阶段的流迭代器
*/
Spliterator<T> wrapSpliterator = helper.wrapSpliterator(spliterator);
// 返回一个"无序"流迭代器
Spliterator<T> unorderedSpliterator = unorderedSkipLimitSpliterator(wrapSpliterator, skip, limit, size);
/*
* Collect using this pipeline, which is empty and therefore
* can be used with the pipeline wrapping spliterator
* Note that we cannot create a slice spliterator from
* the source spliterator if the pipeline is not SIZED
*/
/*
* 并行搜集元素,中间依然会经过sink的择取操作(引用类型版本)。
* 将sliceSpliterator中的元素并行地收集到generator生成的数组中,然后将该数组封装到Node中返回。
*/
return Nodes.collect(this, unorderedSpliterator, true, generator);
}
/*
* 3.至此说明元素数量无限或未知,但是有固定的遭遇顺序。
* 此时需要使用特定的task来完成"分片"操作。
*/
// 构造"分片"任务,用来跳过某段元素,并保留指定数量的元素
SliceTask<P_IN, T> sliceTask = new SliceTask<>(this, helper, spliterator, generator, skip, limit);
// 执行任务,返回执行结果
return sliceTask.invoke();
}
// 返回一个"无序"流迭代器
Spliterator<T> unorderedSkipLimitSpliterator(Spliterator<T> spliterator, long skip, long limit, long sizeIfKnown) {
// 如果跳过的元素小于估计的元素数量,则需要调整skip和limit
if(skip<=sizeIfKnown) {
// Use just the limit if the number of elements to skip is <= the known pipeline size
limit = limit >= 0 ? Math.min(limit, sizeIfKnown - skip) : sizeIfKnown - skip;
skip = 0;
}
return new StreamSpliterators.UnorderedSliceSpliterator.OfRef<>(spliterator, skip, limit);
}
};
}
/**
* Appends a "slice" operation to the provided IntStream. The slice
* operation may be may be skip-only, limit-only, or skip-and-limit.
*
* @param upstream An IntStream
* @param skip The number of elements to skip. Must be >= 0.
* @param limit The maximum size of the resulting stream, or -1 if no limit
* is to be imposed
*/
/*
* 构造有状态的中间阶段的流,适用于limit(long)方法和skip(long)方法(int类型版本)
*
* upstream: 上个阶段的流
* skip : 需要跳过的元素数量,必须>=0
* limit : 返回的流中可以包含的最大元素数量,-1表示没限制
*/
public static IntStream makeInt(AbstractPipeline<?, Integer, ?> upstream, long skip, long limit) {
if(skip<0) {
throw new IllegalArgumentException("Skip must be non-negative: " + skip);
}
// 返回一个有状态的流的中间阶段;该阶段的操作会对upstream流阶段发来的数据进行跳过或选择保存一段数据
return new IntPipeline.StatefulOp<Integer>(upstream, StreamShape.INT_VALUE, flags(limit)) {
// 构造并返回属于当前流阶段的sink,该sink通常与downSink形成一个链条,以决定如何处理上个流阶段发来的数据
@Override
Sink<Integer> opWrapSink(int flags, Sink<Integer> downSink) {
// 返回一个链式Sink,其中downstream的值就是downSink,即下个流阶段的sink
return new Sink.ChainedInt<Integer>(downSink) {
// 需要跳过的元素数量
long n = skip;
// 发送给下游的元素数量上限
long m = limit >= 0 ? limit : Long.MAX_VALUE;
@Override
public void begin(long size) {
// 计算需要发给下游的元素数量
size = calcSize(size, skip, m);
downstream.begin(size);
}
@Override
public void accept(int t) {
// 如果该跳过的元素都跳过了
if(n == 0) {
// 如果待发送元素量大于0,则向下游发送一个元素
if(m>0) {
m--;
downstream.accept(t);
}
// 如果还有未跳过的元素,则计数递减
} else {
n--;
}
}
@Override
public boolean cancellationRequested() {
// 如果已经没有待发送元素了,或者下游反馈了取消择取的信号,则此处也要向上游反馈"取消"信号
return m == 0 || downstream.cancellationRequested();
}
};
}
/*
* 并行处理helper流阶段输出的元素,然后将处理结果封装到流迭代器中返回。
*
* 通常,如果helper流阶段的数据已经满足当前阶段的预期,则会直接包装helper流阶段的数据到流迭代器中。
* 否则,会视情形创建终端sink来处理helper流阶段的数据,并同样将其封装到流迭代器中返回。
* 还可能会对spliterator做进一步的包装,返回一个与当前操作匹配的流迭代器。
*
* helper : 某个流阶段,通常需要在当前终端操作中处理从helper阶段输出的数据
* spliterator: 待处理的数据的源头,该流迭代器属于helper之前的(depth==0)的流阶段(包含helper阶段)
*
* 不同的中间操作会重写该方法,以在该方法中使用不同的方式处理数据。
* 返回值代表了当前阶段的流处理器。
*
* 该方法仅在有状态的中间(操作)阶段上调用,如果某阶段的opIsStateful()返回true,则实现必须重写该方法。
*/
@Override
<P_IN> Spliterator<Integer> opEvaluateParallelLazy(PipelineHelper<Integer> helper, Spliterator<P_IN> spliterator) {
/*
* 返回一个"包装"流迭代器,使用该流迭代器可以获取helper流流阶段的输出元素。
*
* spliterator: 相对于helper流阶段的上个(depth==0)的流阶段的流迭代器
*/
Spliterator<Integer> wrapSpliterator = helper.wrapSpliterator(spliterator);
/*
* 初始时,尝试返回spliterator中的元素总量。如果无法获取精确值,则返回-1。
* 当访问过spliterator中的元素后,此处的返回值可能是元素总量,也可能是剩余未访问的元素数量,依实现而定。
*
* 注:通常在流拥有SIZED参数(相当于spliterator有SIZED参数)时可以获取到一个精确值。
*/
long size = helper.exactOutputSizeIfKnown(spliterator);
// 1.如果流中元素的数量以及切割后的子流中的元素数量均是有限的,则可以直接切片
if(size>0 && spliterator.hasCharacteristics(Spliterator.SUBSIZED)) {
// 计算切片的终止索引
long sliceFence = calcSliceFence(skip, limit);
// 返回一个"分片"流迭代器
return new StreamSpliterators.SliceSpliterator.OfInt((Spliterator.OfInt) wrapSpliterator, skip, sliceFence);
}
// 获取helper流阶段的组合参数
int streamAndOpFlags = helper.getStreamAndOpFlags();
// 2.如果helper流阶段的元素没有固定的遭遇顺序,则使用"无序"流迭代器
if(!StreamOpFlag.ORDERED.isKnown(streamAndOpFlags)) {
// 返回一个"无序"流迭代器
return unorderedSkipLimitSpliterator((Spliterator.OfInt) wrapSpliterator, skip, limit, size);
}
/*
* 3.至此说明元素数量无限或未知,但是有固定的遭遇顺序。
* 此时需要使用特定的task来完成"分片"操作。
*/
// 构造"分片"任务,用来跳过某段元素,并保留指定数量的元素
SliceTask<P_IN, Integer> sliceTask = new SliceTask<>(this, helper, spliterator, Integer[]::new, skip, limit);
// 执行任务,返回执行结果
Node<Integer> node = sliceTask.invoke();
// 返回可以代表node的流迭代器
return node.spliterator();
}
/*
* 并行处理helper流阶段输出的元素,返回处理后的结果。
*
* 通常,如果helper流阶段的数据已经满足当前阶段的预期,则会直接返回helper流阶段的数据。
* 否则,会视情形创建终端sink来处理helper流阶段的数据并返回。
* 还可能不经过sink,而是直接处理helper流阶段的数据,并将处理后的数据返回。
*
* helper : 某个流阶段,通常需要在当前终端操作中处理从helper阶段输出的数据
* spliterator: 待处理的数据的源头,该流迭代器属于helper之前的(depth==0)的流阶段(包含helper阶段)
* generator : 必要的时候,创建存储处理结果的定长数组
*
* 不同的中间操作会重写该方法,以在该方法中使用不同的方式处理数据。
* 返回值代表了当前(操作)阶段处理后的数据。
*
* 该方法仅在有状态的中间(操作)阶段上调用,如果某阶段的opIsStateful()返回true,则实现必须重写该方法。
*/
@Override
<P_IN> Node<Integer> opEvaluateParallel(PipelineHelper<Integer> helper, Spliterator<P_IN> spliterator, IntFunction<Integer[]> generator) {
/*
* 初始时,尝试返回spliterator中的元素总量。如果无法获取精确值,则返回-1。
* 当访问过spliterator中的元素后,此处的返回值可能是元素总量,也可能是剩余未访问的元素数量,依实现而定。
*
* 注:通常在流拥有SIZED参数(相当于spliterator有SIZED参数)时可以获取到一个精确值。
*/
long size = helper.exactOutputSizeIfKnown(spliterator);
// 1.如果流中元素的数量以及切割后的子流中的元素数量均是有限的,则可以直接切片
if(size>0 && spliterator.hasCharacteristics(Spliterator.SUBSIZED)) {
/*
* Because the pipeline is SIZED the slice spliterator
* can be created from the source, this requires matching
* to shape of the source, and is potentially more efficient
* than creating the slice spliterator from the pipeline wrapping spliterator
*/
// 返回一个"分片"流迭代器
Spliterator<P_IN> sliceSpliterator = sliceSpliterator(helper.getSourceShape(), spliterator, skip, limit);
/*
* 并行搜集元素,中间依然会经过sink的择取操作(int类型版本)。
* 将sliceSpliterator中的元素并行地收集到generator生成的数组中,然后将该数组封装到Node中返回。
*/
return Nodes.collectInt(helper, sliceSpliterator, true);
}
// 获取helper流阶段的组合参数
int streamAndOpFlags = helper.getStreamAndOpFlags();
// 2.如果helper流阶段的元素没有固定的遭遇顺序,则使用"无序"流迭代器
if(!StreamOpFlag.ORDERED.isKnown(streamAndOpFlags)) {
/*
* 返回一个"包装"流迭代器,使用该流迭代器可以获取helper流流阶段的输出元素。
*
* spliterator: 相对于helper流阶段的上个(depth==0)的流阶段的流迭代器
*/
Spliterator<Integer> wrapSpliterator = helper.wrapSpliterator(spliterator);
// 返回一个"无序"流迭代器
Spliterator.OfInt unorderedSpliterator = unorderedSkipLimitSpliterator((Spliterator.OfInt) wrapSpliterator, skip, limit, size);
/*
* Collect using this pipeline, which is empty and therefore
* can be used with the pipeline wrapping spliterator
* Note that we cannot create a slice spliterator from
* the source spliterator if the pipeline is not SIZED
*/
/*
* 并行搜集元素,中间依然会经过sink的择取操作(int类型版本)。
* 将sliceSpliterator中的元素并行地收集到generator生成的数组中,然后将该数组封装到Node中返回。
*/
return Nodes.collectInt(this, unorderedSpliterator, true);
}
/*
* 3.至此说明元素数量无限或未知,但是有固定的遭遇顺序。
* 此时需要使用特定的task来完成"分片"操作。
*/
// 构造"分片"任务,用来跳过某段元素,并保留指定数量的元素
SliceTask<P_IN, Integer> sliceTask = new SliceTask<>(this, helper, spliterator, generator, skip, limit);
// 执行任务,返回执行结果
return sliceTask.invoke();
}
// 返回一个"无序"流迭代器
Spliterator.OfInt unorderedSkipLimitSpliterator(Spliterator.OfInt s, long skip, long limit, long sizeIfKnown) {
// 如果跳过的元素小于估计的元素数量,则需要调整skip和limit
if(skip<=sizeIfKnown) {
// Use just the limit if the number of elements to skip is <= the known pipeline size
limit = limit >= 0 ? Math.min(limit, sizeIfKnown - skip) : sizeIfKnown - skip;
skip = 0;
}
return new StreamSpliterators.UnorderedSliceSpliterator.OfInt(s, skip, limit);
}
};
}
/**
* Appends a "slice" operation to the provided LongStream. The slice
* operation may be may be skip-only, limit-only, or skip-and-limit.
*
* @param upstream A LongStream
* @param skip The number of elements to skip. Must be >= 0.
* @param limit The maximum size of the resulting stream, or -1 if no limit
* is to be imposed
*/
/*
* 构造有状态的中间阶段的流,适用于limit(long)方法和skip(long)方法(long类型版本)
*
* upstream: 上个阶段的流
* skip : 需要跳过的元素数量,必须>=0
* limit : 返回的流中可以包含的最大元素数量,-1表示没限制
*/
public static LongStream makeLong(AbstractPipeline<?, Long, ?> upstream, long skip, long limit) {
if(skip<0) {
throw new IllegalArgumentException("Skip must be non-negative: " + skip);
}
return new LongPipeline.StatefulOp<Long>(upstream, StreamShape.LONG_VALUE, flags(limit)) {
// 构造并返回属于当前流阶段的sink,该sink通常与downSink形成一个链条,以决定如何处理上个流阶段发来的数据
@Override
Sink<Long> opWrapSink(int flags, Sink<Long> downSink) {
// 返回一个链式Sink,其中downstream的值就是downSink,即下个流阶段的sink
return new Sink.ChainedLong<Long>(downSink) {
// 需要跳过的元素数量
long n = skip;
// 发送给下游的元素数量上限
long m = limit >= 0 ? limit : Long.MAX_VALUE;
@Override
public void begin(long size) {
// 计算需要发给下游的元素数量
size = calcSize(size, skip, m);
downstream.begin(size);
}
@Override
public void accept(long t) {
// 如果该跳过的元素都跳过了
if(n == 0) {
// 如果待发送元素量大于0,则向下游发送一个元素
if(m>0) {
m--;
downstream.accept(t);
}
// 如果还有未跳过的元素,则计数递减
} else {
n--;
}
}
@Override
public boolean cancellationRequested() {
// 如果已经没有待发送元素了,或者下游反馈了取消择取的信号,则此处也要向上游反馈"取消"信号
return m == 0 || downstream.cancellationRequested();
}
};
}
/*
* 并行处理helper流阶段输出的元素,然后将处理结果封装到流迭代器中返回。
*
* 通常,如果helper流阶段的数据已经满足当前阶段的预期,则会直接包装helper流阶段的数据到流迭代器中。
* 否则,会视情形创建终端sink来处理helper流阶段的数据,并同样将其封装到流迭代器中返回。
* 还可能会对spliterator做进一步的包装,返回一个与当前操作匹配的流迭代器。
*
* helper : 某个流阶段,通常需要在当前终端操作中处理从helper阶段输出的数据
* spliterator: 待处理的数据的源头,该流迭代器属于helper之前的(depth==0)的流阶段(包含helper阶段)
*
* 不同的中间操作会重写该方法,以在该方法中使用不同的方式处理数据。
* 返回值代表了当前阶段的流处理器。
*
* 该方法仅在有状态的中间(操作)阶段上调用,如果某阶段的opIsStateful()返回true,则实现必须重写该方法。
*/
@Override
<P_IN> Spliterator<Long> opEvaluateParallelLazy(PipelineHelper<Long> helper, Spliterator<P_IN> spliterator) {
/*
* 返回一个"包装"流迭代器,使用该流迭代器可以获取helper流流阶段的输出元素。
*
* spliterator: 相对于helper流阶段的上个(depth==0)的流阶段的流迭代器
*/
Spliterator<Long> wrapSpliterator = helper.wrapSpliterator(spliterator);
/*
* 初始时,尝试返回spliterator中的元素总量。如果无法获取精确值,则返回-1。
* 当访问过spliterator中的元素后,此处的返回值可能是元素总量,也可能是剩余未访问的元素数量,依实现而定。
*
* 注:通常在流拥有SIZED参数(相当于spliterator有SIZED参数)时可以获取到一个精确值。
*/
long size = helper.exactOutputSizeIfKnown(spliterator);
// 1.如果流中元素的数量以及切割后的子流中的元素数量均是有限的,则可以直接切片
if(size>0 && spliterator.hasCharacteristics(Spliterator.SUBSIZED)) {
// 计算切片的终止索引
long sliceFence = calcSliceFence(skip, limit);
// 返回一个"分片"流迭代器
return new StreamSpliterators.SliceSpliterator.OfLong((Spliterator.OfLong) wrapSpliterator, skip, sliceFence);
}
// 获取helper流阶段的组合参数
int streamAndOpFlags = helper.getStreamAndOpFlags();
// 2.如果helper流阶段的元素没有固定的遭遇顺序,则使用"无序"流迭代器
if(!StreamOpFlag.ORDERED.isKnown(streamAndOpFlags)) {
return unorderedSkipLimitSpliterator((Spliterator.OfLong) wrapSpliterator, skip, limit, size);
}
/*
* 3.至此说明元素数量无限或未知,但是有固定的遭遇顺序。
* 此时需要使用特定的task来完成"分片"操作。
*/
// 返回用于创建T类型数组的函数表达式
SliceTask<P_IN, Long> sliceTask = new SliceTask<>(this, helper, spliterator, Long[]::new, skip, limit);
// 执行任务,返回执行结果
Node<Long> node = sliceTask.invoke();
// 返回可以代表node的流迭代器
return node.spliterator();
}
/*
* 并行处理helper流阶段输出的元素,返回处理后的结果。
*
* 通常,如果helper流阶段的数据已经满足当前阶段的预期,则会直接返回helper流阶段的数据。
* 否则,会视情形创建终端sink来处理helper流阶段的数据并返回。
* 还可能不经过sink,而是直接处理helper流阶段的数据,并将处理后的数据返回。
*
* helper : 某个流阶段,通常需要在当前终端操作中处理从helper阶段输出的数据
* spliterator: 待处理的数据的源头,该流迭代器属于helper之前的(depth==0)的流阶段(包含helper阶段)
* generator : 必要的时候,创建存储处理结果的定长数组
*
* 不同的中间操作会重写该方法,以在该方法中使用不同的方式处理数据。
* 返回值代表了当前(操作)阶段处理后的数据。
*
* 该方法仅在有状态的中间(操作)阶段上调用,如果某阶段的opIsStateful()返回true,则实现必须重写该方法。
*/
@Override
<P_IN> Node<Long> opEvaluateParallel(PipelineHelper<Long> helper, Spliterator<P_IN> spliterator, IntFunction<Long[]> generator) {
/*
* 初始时,尝试返回spliterator中的元素总量。如果无法获取精确值,则返回-1。
* 当访问过spliterator中的元素后,此处的返回值可能是元素总量,也可能是剩余未访问的元素数量,依实现而定。
*
* 注:通常在流拥有SIZED参数(相当于spliterator有SIZED参数)时可以获取到一个精确值。
*/
long size = helper.exactOutputSizeIfKnown(spliterator);
// 1.如果流中元素的数量以及切割后的子流中的元素数量均是有限的,则可以直接切片
if(size>0 && spliterator.hasCharacteristics(Spliterator.SUBSIZED)) {
/*
* Because the pipeline is SIZED the slice spliterator
* can be created from the source, this requires matching
* to shape of the source, and is potentially more efficient
* than creating the slice spliterator from the pipeline wrapping spliterator
*/
// 返回一个"分片"流迭代器
Spliterator<P_IN> sliceSpliterator = sliceSpliterator(helper.getSourceShape(), spliterator, skip, limit);
/*
* 并行搜集元素,中间依然会经过sink的择取操作(引用类型版本)。
* 将sliceSpliterator中的元素并行地收集到generator生成的数组中,然后将该数组封装到Node中返回。
*/
return Nodes.collectLong(helper, sliceSpliterator, true);
}
// 获取helper流阶段的组合参数
int streamAndOpFlags = helper.getStreamAndOpFlags();
// 2.如果helper流阶段的元素没有固定的遭遇顺序,则使用"无序"流迭代器
if(!StreamOpFlag.ORDERED.isKnown(streamAndOpFlags)) {
/*
* 返回一个"包装"流迭代器,使用该流迭代器可以获取helper流流阶段的输出元素。
*
* spliterator: 相对于helper流阶段的上个(depth==0)的流阶段的流迭代器
*/
Spliterator<Long> wrapSpliterator = helper.wrapSpliterator(spliterator);
// 返回一个"无序"流迭代器
Spliterator.OfLong s = unorderedSkipLimitSpliterator((Spliterator.OfLong) wrapSpliterator, skip, limit, size);
/*
* Collect using this pipeline, which is empty and therefore
* can be used with the pipeline wrapping spliterator
* Note that we cannot create a slice spliterator from
* the source spliterator if the pipeline is not SIZED
*/
/*
* 并行搜集元素,中间依然会经过sink的择取操作(long类型版本)。
* 将sliceSpliterator中的元素并行地收集到generator生成的数组中,然后将该数组封装到Node中返回。
*/
return Nodes.collectLong(this, s, true);
}
// 构造"分片"任务,用来跳过某段元素,并保留指定数量的元素
SliceTask<P_IN, Long> sliceTask = new SliceTask<>(this, helper, spliterator, generator, skip, limit);
// 执行任务,返回执行结果
return sliceTask.invoke();
}
// 返回一个"无序"流迭代器
Spliterator.OfLong unorderedSkipLimitSpliterator(Spliterator.OfLong s, long skip, long limit, long sizeIfKnown) {
// 如果跳过的元素小于估计的元素数量,则需要调整skip和limit
if(skip<=sizeIfKnown) {
// Use just the limit if the number of elements
// to skip is <= the known pipeline size
limit = limit >= 0 ? Math.min(limit, sizeIfKnown - skip) : sizeIfKnown - skip;
skip = 0;
}
return new StreamSpliterators.UnorderedSliceSpliterator.OfLong(s, skip, limit);
}
};
}
/**
* Appends a "slice" operation to the provided DoubleStream. The slice
* operation may be may be skip-only, limit-only, or skip-and-limit.
*
* @param upstream A DoubleStream
* @param skip The number of elements to skip. Must be >= 0.
* @param limit The maximum size of the resulting stream, or -1 if no limit
* is to be imposed
*/
/*
* 构造有状态的中间阶段的流,适用于limit(long)方法和skip(long)方法(double类型版本)
*
* upstream: 上个阶段的流
* skip : 需要跳过的元素数量,必须>=0
* limit : 返回的流中可以包含的最大元素数量,-1表示没限制
*/
public static DoubleStream makeDouble(AbstractPipeline<?, Double, ?> upstream, long skip, long limit) {
if(skip<0) {
throw new IllegalArgumentException("Skip must be non-negative: " + skip);
}
return new DoublePipeline.StatefulOp<Double>(upstream, StreamShape.DOUBLE_VALUE, flags(limit)) {
// 构造并返回属于当前流阶段的sink,该sink通常与downSink形成一个链条,以决定如何处理上个流阶段发来的数据
@Override
Sink<Double> opWrapSink(int flags, Sink<Double> downSink) {
// 返回一个链式Sink,其中downstream的值就是downSink,即下个流阶段的sink
return new Sink.ChainedDouble<Double>(downSink) {
// 需要跳过的元素数量
long n = skip;
// 发送给下游的元素数量上限
long m = limit >= 0 ? limit : Long.MAX_VALUE;
@Override
public void begin(long size) {
// 计算需要发给下游的元素数量
size = calcSize(size, skip, m);
downstream.begin(size);
}
@Override
public void accept(double t) {
// 如果该跳过的元素都跳过了
if(n == 0) {
// 如果待发送元素量大于0,则向下游发送一个元素
if(m>0) {
m--;
downstream.accept(t);
}
// 如果还有未跳过的元素,则计数递减
} else {
n--;
}
}
@Override
public boolean cancellationRequested() {
// 如果已经没有待发送元素了,或者下游反馈了取消择取的信号,则此处也要向上游反馈"取消"信号
return m == 0 || downstream.cancellationRequested();
}
};
}
/*
* 并行处理helper流阶段输出的元素,然后将处理结果封装到流迭代器中返回。
*
* 通常,如果helper流阶段的数据已经满足当前阶段的预期,则会直接包装helper流阶段的数据到流迭代器中。
* 否则,会视情形创建终端sink来处理helper流阶段的数据,并同样将其封装到流迭代器中返回。
* 还可能会对spliterator做进一步的包装,返回一个与当前操作匹配的流迭代器。
*
* helper : 某个流阶段,通常需要在当前终端操作中处理从helper阶段输出的数据
* spliterator: 待处理的数据的源头,该流迭代器属于helper之前的(depth==0)的流阶段(包含helper阶段)
*
* 不同的中间操作会重写该方法,以在该方法中使用不同的方式处理数据。
* 返回值代表了当前阶段的流处理器。
*
* 该方法仅在有状态的中间(操作)阶段上调用,如果某阶段的opIsStateful()返回true,则实现必须重写该方法。
*/
@Override
<P_IN> Spliterator<Double> opEvaluateParallelLazy(PipelineHelper<Double> helper, Spliterator<P_IN> spliterator) {
/*
* 返回一个"包装"流迭代器,使用该流迭代器可以获取helper流流阶段的输出元素。
*
* spliterator: 相对于helper流阶段的上个(depth==0)的流阶段的流迭代器
*/
Spliterator<Double> wrapSpliterator = helper.wrapSpliterator(spliterator);
/*
* 初始时,尝试返回spliterator中的元素总量。如果无法获取精确值,则返回-1。
* 当访问过spliterator中的元素后,此处的返回值可能是元素总量,也可能是剩余未访问的元素数量,依实现而定。
*
* 注:通常在流拥有SIZED参数(相当于spliterator有SIZED参数)时可以获取到一个精确值。
*/
long size = helper.exactOutputSizeIfKnown(spliterator);
// 1.如果流中元素的数量以及切割后的子流中的元素数量均是有限的,则可以直接切片
if(size>0 && spliterator.hasCharacteristics(Spliterator.SUBSIZED)) {
// 计算切片的终止索引
long sliceFence = calcSliceFence(skip, limit);
// 返回一个"分片"流迭代器
return new StreamSpliterators.SliceSpliterator.OfDouble((Spliterator.OfDouble) wrapSpliterator, skip, sliceFence);
}
// 获取helper流阶段的组合参数
int streamAndOpFlags = helper.getStreamAndOpFlags();
// 2.如果helper流阶段的元素没有固定的遭遇顺序,则使用"无序"流迭代器
if(!StreamOpFlag.ORDERED.isKnown(streamAndOpFlags)) {
return unorderedSkipLimitSpliterator((Spliterator.OfDouble) wrapSpliterator, skip, limit, size);
}
/*
* 3.至此说明元素数量无限或未知,但是有固定的遭遇顺序。
* 此时需要使用特定的task来完成"分片"操作。
*/
// 构造"分片"任务,用来跳过某段元素,并保留指定数量的元素
SliceTask<P_IN, Double> sliceTask = new SliceTask<>(this, helper, spliterator, Double[]::new, skip, limit);
// 执行任务,返回执行结果
Node<Double> node = sliceTask.invoke();
// 返回可以代表node的流迭代器
return node.spliterator();
}
/*
* 并行处理helper流阶段输出的元素,返回处理后的结果。
*
* 通常,如果helper流阶段的数据已经满足当前阶段的预期,则会直接返回helper流阶段的数据。
* 否则,会视情形创建终端sink来处理helper流阶段的数据并返回。
* 还可能不经过sink,而是直接处理helper流阶段的数据,并将处理后的数据返回。
*
* helper : 某个流阶段,通常需要在当前终端操作中处理从helper阶段输出的数据
* spliterator: 待处理的数据的源头,该流迭代器属于helper之前的(depth==0)的流阶段(包含helper阶段)
* generator : 必要的时候,创建存储处理结果的定长数组
*
* 不同的中间操作会重写该方法,以在该方法中使用不同的方式处理数据。
* 返回值代表了当前(操作)阶段处理后的数据。
*
* 该方法仅在有状态的中间(操作)阶段上调用,如果某阶段的opIsStateful()返回true,则实现必须重写该方法。
*/
@Override
<P_IN> Node<Double> opEvaluateParallel(PipelineHelper<Double> helper, Spliterator<P_IN> spliterator, IntFunction<Double[]> generator) {
/*
* 初始时,尝试返回spliterator中的元素总量。如果无法获取精确值,则返回-1。
* 当访问过spliterator中的元素后,此处的返回值可能是元素总量,也可能是剩余未访问的元素数量,依实现而定。
*
* 注:通常在流拥有SIZED参数(相当于spliterator有SIZED参数)时可以获取到一个精确值。
*/
long size = helper.exactOutputSizeIfKnown(spliterator);
// 1.如果流中元素的数量以及切割后的子流中的元素数量均是有限的,则可以直接切片
if(size>0 && spliterator.hasCharacteristics(Spliterator.SUBSIZED)) {
/*
* Because the pipeline is SIZED the slice spliterator
* can be created from the source, this requires matching
* to shape of the source, and is potentially more efficient
* than creating the slice spliterator from the pipeline wrapping spliterator
*/
// 返回一个"分片"流迭代器
Spliterator<P_IN> sliceSpliterator = sliceSpliterator(helper.getSourceShape(), spliterator, skip, limit);
/*
* 并行搜集元素,中间依然会经过sink的择取操作(double类型版本)。
* 将sliceSpliterator中的元素并行地收集到generator生成的数组中,然后将该数组封装到Node中返回。
*/
return Nodes.collectDouble(helper, sliceSpliterator, true);
}
// 获取helper流阶段的组合参数
int streamAndOpFlags = helper.getStreamAndOpFlags();
// 2.如果helper流阶段的元素没有固定的遭遇顺序,则使用"无序"流迭代器
if(!StreamOpFlag.ORDERED.isKnown(streamAndOpFlags)) {
/*
* 返回一个"包装"流迭代器,使用该流迭代器可以获取helper流流阶段的输出元素。
*
* spliterator: 相对于helper流阶段的上个(depth==0)的流阶段的流迭代器
*/
Spliterator<Double> wrapSpliterator = helper.wrapSpliterator(spliterator);
// 返回一个"无序"流迭代器
Spliterator.OfDouble unorderedSpliterator = unorderedSkipLimitSpliterator((Spliterator.OfDouble) wrapSpliterator, skip, limit, size);
/*
* Collect using this pipeline, which is empty and therefore
* can be used with the pipeline wrapping spliterator
* Note that we cannot create a slice spliterator from
* the source spliterator if the pipeline is not SIZED
*/
/*
* 并行搜集元素,中间依然会经过sink的择取操作(double类型版本)。
* 将sliceSpliterator中的元素并行地收集到generator生成的数组中,然后将该数组封装到Node中返回。
*/
return Nodes.collectDouble(this, unorderedSpliterator, true);
}
/*
* 3.至此说明元素数量无限或未知,但是有固定的遭遇顺序。
* 此时需要使用特定的task来完成"分片"操作。
*/
// 构造"分片"任务,用来跳过某段元素,并保留指定数量的元素
SliceTask<P_IN, Double> task = new SliceTask<>(this, helper, spliterator, generator, skip, limit);
// 执行任务,返回执行结果
return task.invoke();
}
// 返回一个"无序"流迭代器
Spliterator.OfDouble unorderedSkipLimitSpliterator(Spliterator.OfDouble s, long skip, long limit, long sizeIfKnown) {
// 如果跳过的元素小于估计的元素数量,则需要调整skip和limit
if(skip<=sizeIfKnown) {
// Use just the limit if the number of elements to skip is <= the known pipeline size
limit = limit >= 0 ? Math.min(limit, sizeIfKnown - skip) : sizeIfKnown - skip;
skip = 0;
}
return new StreamSpliterators.UnorderedSliceSpliterator.OfDouble(s, skip, limit);
}
};
}
/**
* Creates a slice spliterator given a stream shape governing the
* spliterator type. Requires that the underlying Spliterator
* be SUBSIZED.
*/
// 为不同类型的元素构造"分片"流迭代器
@SuppressWarnings("unchecked")
private static <P_IN> Spliterator<P_IN> sliceSpliterator(StreamShape shape, Spliterator<P_IN> spliterator, long skip, long limit) {
assert spliterator.hasCharacteristics(Spliterator.SUBSIZED);