01 /*
02 * Java Genetic Algorithm Library (jenetics-8.0.0).
03 * Copyright (c) 2007-2024 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@gmail.com)
19 */
20 package io.jenetics;
21
22 import static java.util.Objects.requireNonNull;
23
24 import java.io.Serial;
25 import java.io.Serializable;
26
27 import io.jenetics.internal.util.Requires;
28 import io.jenetics.util.ISeq;
29 import io.jenetics.util.Seq;
30
31 /**
32 * Represents the result pair of a {@link Alterer#alter(Seq, long)} call, which
33 * consists of the altered population and the number of altered individuals.
34 *
35 * @see Alterer
36 *
37 * @param population the altered population
38 * @param alterations the number of altered individuals
39 * @param <G> the gene type
40 * @param <C> the result type
41 *
42 * @author <a href="mailto:franz.wilhelmstoetter@gmail.com">Franz Wilhelmstötter</a>
43 * @since 4.0
44 * @version 7.0
45 */
46 public record AltererResult<
47 G extends Gene<?, G>,
48 C extends Comparable<? super C>
49 > (
50 ISeq<Phenotype<G, C>> population,
51 int alterations
52 )
53 implements Serializable
54 {
55 @Serial
56 private static final long serialVersionUID = 2L;
57
58 /**
59 * Create a new alter result for the given arguments.
60 *
61 * @param population the altered population
62 * @param alterations the number of altered individuals
63 * @throws NullPointerException if the given population is {@code null}
64 * @throws IllegalArgumentException if the given {@code alterations} is
65 * negative
66 */
67 public AltererResult {
68 Requires.nonNegative(alterations);
69 requireNonNull(population);
70 }
71
72 /**
73 * Create a new alter result for the given population with zero alterations.
74 *
75 * @param population the altered population
76 * @throws NullPointerException if the given population is {@code null}
77 */
78 public AltererResult(ISeq<Phenotype<G, C>> population) {
79 this(population, 0);
80 }
81
82 }
|