1 /*
2 * Licensed to the Hipparchus project under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The Hipparchus project licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * https://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 package org.hipparchus.optim;
18
19 import java.util.List;
20
21 /** Multiplexer for {@link ConvergenceChecker}, checking <em>one</em> of the checkers converged.
22 * <p>
23 * The checkers are checked in the order of the initial list and the check loop
24 * is interrupted as soon as one checker has converged (that is the remaining
25 * checkers may <em>not</em> be called in the final iteration.
26 * </p>
27 * @param <P> type of the evaluation
28 * @since 2.1
29 */
30 public class ConvergenceCheckerOrMultiplexer<P> implements ConvergenceChecker<P> {
31
32 /** Underlying checkers. */
33 private final List<ConvergenceChecker<P>> checkers;
34
35 /** Simple constructor.
36 * @param checkers checkers to use, convergence is reached when
37 * <em>any one</em> of checkers have converged
38 */
39 public ConvergenceCheckerOrMultiplexer(final List<ConvergenceChecker<P>> checkers) {
40 this.checkers = checkers;
41 }
42
43 /** {@inheritDoc} */
44 @Override
45 public boolean converged(final int iteration, final P previous, final P current) {
46 for (final ConvergenceChecker<P> checker : checkers) {
47 if (checker.converged(iteration, previous, current)) {
48 return true;
49 }
50 }
51 return false;
52 }
53
54 }