PerfectClockModel.java

/* Copyright 2022-2026 Thales Alenia Space
 * Licensed to CS GROUP (CS) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * CS licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.orekit.time.clocks;

import org.hipparchus.CalculusFieldElement;
import org.hipparchus.analysis.differentiation.Gradient;

import java.util.Map;
import java.util.function.DoubleFunction;

/** Clock model for perfect clock with constant zero offset.
 * @author Luc Maisonobe
 * @since 12.1
 */
public class PerfectClockModel extends ConstantClockModel {

    /** Simple constructor.
     */
    public PerfectClockModel() {
        super(0.0);
    }

    /** {@inheritDoc} */
    @Override
    public <T extends CalculusFieldElement<T>> PerfectFieldClockModel<T> toField(final DoubleFunction<T> converter) {
        return new PerfectFieldClockModel<>(converter.apply(0.0).getField());
    }

    /** {@inheritDoc} */
    @Override
    public PerfectFieldClockModel<Gradient> toGradient(final int freeParameters, final Map<String, Integer> indices) {
        return toField(v -> Gradient.constant(freeParameters, v));
    }

}