1   /* Copyright 2002-2025 CS GROUP
2    * Licensed to CS GROUP (CS) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * CS 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    *   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  package org.orekit.estimation.leastsquares;
18  
19  import org.hipparchus.optim.nonlinear.vector.leastsquares.LeastSquaresProblem;
20  import org.orekit.estimation.measurements.EstimationsProvider;
21  import org.orekit.orbits.Orbit;
22  import org.orekit.utils.ParameterDriversList;
23  
24  /** Observer for {@link BatchLSEstimator batch least squares estimator} iterations.
25   * <p>
26   * This interface is intended to be implemented by users to monitor
27   * the progress of the estimator during estimation.
28   * </p>
29   * @author Luc Maisonobe
30   * @since 8.0
31   */
32  @FunctionalInterface
33  public interface BatchLSObserver {
34  
35      /** Notification callback for the end of each evaluation.
36       * @param iterationsCount iterations count
37       * @param evaluationsCount evaluations count
38       * @param orbits current estimated orbits
39       * @param estimatedOrbitalParameters estimated orbital parameters
40       * @param estimatedPropagatorParameters estimated propagator parameters
41       * @param estimatedMeasurementsParameters estimated measurements parameters
42       * @param evaluationsProvider provider for measurements evaluations resulting
43       * from the current estimated orbit (this is an unmodifiable view of the
44       * current evaluations, its content is changed at each iteration)
45       * @param lspEvaluation current evaluation of the underlying {@link LeastSquaresProblem
46       * least squares problem}
47       */
48      void evaluationPerformed(int iterationsCount, int evaluationsCount, Orbit[] orbits,
49                               ParameterDriversList estimatedOrbitalParameters,
50                               ParameterDriversList estimatedPropagatorParameters,
51                               ParameterDriversList estimatedMeasurementsParameters,
52                               EstimationsProvider  evaluationsProvider,
53                               LeastSquaresProblem.Evaluation lspEvaluation);
54  
55  }