Min.java

  1. /*
  2.  * Licensed to the Apache Software Foundation (ASF) 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 ASF 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. /*
  18.  * This is not the original file distributed by the Apache Software Foundation
  19.  * It has been modified by the Hipparchus project
  20.  */

  21. package org.hipparchus.analysis.function;

  22. import org.hipparchus.analysis.BivariateFunction;
  23. import org.hipparchus.util.FastMath;

  24. /**
  25.  * Minimum function.
  26.  *
  27.  */
  28. public class Min implements BivariateFunction {

  29.     /** Empty constructor.
  30.      * <p>
  31.      * This constructor is not strictly necessary, but it prevents spurious
  32.      * javadoc warnings with JDK 18 and later.
  33.      * </p>
  34.      * @since 3.0
  35.      */
  36.     public Min() { // NOPMD - unnecessary constructor added intentionally to make javadoc happy
  37.         // nothing to do
  38.     }

  39.     /** {@inheritDoc} */
  40.     @Override
  41.     public double value(double x, double y) {
  42.         return FastMath.min(x, y);
  43.     }

  44. }