EvolutionSpliterator.java
01 /*
02  * Java Genetic Algorithm Library (jenetics-3.5.0).
03  * Copyright (c) 2007-2016 Franz Wilhelmstötter
04  *
05  * Licensed under the Apache License, Version 2.0 (the "License");
06  * you may not use this file except in compliance with the License.
07  * You may obtain a copy of the License at
08  *
09  *      http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  * Author:
18  *    Franz Wilhelmstötter (franz.wilhelmstoetter@gmx.at)
19  */
20 package org.jenetics.engine;
21 
22 import static java.util.Objects.requireNonNull;
23 
24 import java.util.Spliterator;
25 import java.util.function.Consumer;
26 import java.util.function.Function;
27 import java.util.function.Predicate;
28 import java.util.function.Supplier;
29 
30 import org.jenetics.Gene;
31 
32 /**
33  * @author <a href="mailto:franz.wilhelmstoetter@gmx.at">Franz Wilhelmstötter</a>
34  * @since 3.0
35  * @version 3.0
36  */
37 final class EvolutionSpliterator<
38     G extends Gene<?, G>,
39     C extends Comparable<? super C>
40 >
41     implements Spliterator<EvolutionResult<G, C>>
42 {
43 
44     private final Supplier<EvolutionStart<G, C>> _initial;
45     private final Function<? super EvolutionStart<G, C>, EvolutionResult<G, C>> _evolution;
46     private final Predicate<? super EvolutionResult<G, C>> _proceed;
47 
48     private EvolutionStart<G, C> _start;
49 
50     EvolutionSpliterator(
51         final Supplier<EvolutionStart<G, C>> initial,
52         final Function<? super EvolutionStart<G, C>, EvolutionResult<G, C>> evolution,
53         final Predicate<? super EvolutionResult<G, C>> proceed
54     ) {
55         _evolution = requireNonNull(evolution);
56         _initial = requireNonNull(initial);
57         _proceed = requireNonNull(proceed);
58     }
59 
60     @Override
61     public boolean tryAdvance(
62         final Consumer<? super EvolutionResult<G, C>> action
63     ) {
64         if (_start == null) {
65             _start = _initial.get();
66         }
67 
68         final EvolutionResult<G, C> result = _evolution.apply(_start);
69         action.accept(result);
70         _start = result.next();
71 
72         return _proceed.test(result);
73     }
74 
75     @Override
76     public Spliterator<EvolutionResult<G, C>> trySplit() {
77         return null;
78     }
79 
80     @Override
81     public long estimateSize() {
82         return Long.MAX_VALUE;
83     }
84 
85     @Override
86     public int characteristics() {
87         return NONNULL | IMMUTABLE;
88     }
89 }