View Javadoc
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  /*
19   * This is not the original file distributed by the Apache Software Foundation
20   * It has been modified by the Hipparchus project
21   */
22  package org.hipparchus.clustering.distance;
23  
24  import org.hipparchus.exception.MathIllegalArgumentException;
25  import org.hipparchus.util.MathArrays;
26  
27  /**
28   * Calculates the L<sub>&infin;</sub> (max of abs) distance between two points.
29   *
30   */
31  public class ChebyshevDistance implements DistanceMeasure {
32  
33      /** Serializable version identifier. */
34      private static final long serialVersionUID = -4694868171115238296L;
35  
36      /** Empty constructor.
37       * <p>
38       * This constructor is not strictly necessary, but it prevents spurious
39       * javadoc warnings with JDK 18 and later.
40       * </p>
41       * @since 3.0
42       */
43      public ChebyshevDistance() { // NOPMD - unnecessary constructor added intentionally to make javadoc happy
44          // nothing to do
45      }
46  
47      /** {@inheritDoc} */
48      @Override
49      public double compute(double[] a, double[] b)
50      throws MathIllegalArgumentException {
51          return MathArrays.distanceInf(a, b);
52      }
53  
54  }