View Javadoc
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  
18  package org.hipparchus.analysis.polynomials;
19  
20  
21  /** Class for handling Jacobi polynomials keys.
22   * @since 3.1
23   */
24  public class JacobiKey {
25  
26      /** First exponent. */
27      private final int v;
28  
29      /** Second exponent. */
30      private final int w;
31  
32      /** Simple constructor.
33       * @param v first exponent
34       * @param w second exponent
35       */
36      public JacobiKey(final int v, final int w) {
37          this.v = v;
38          this.w = w;
39      }
40  
41      /** Get hash code.
42       * @return hash code
43       */
44      @Override
45      public int hashCode() {
46          return (v << 16) ^ w;
47      }
48  
49      /** Check if the instance represent the same key as another instance.
50       * @param key other key
51       * @return true if the instance and the other key refer to the same polynomial
52       */
53      @Override
54      public boolean equals(final Object key) {
55  
56          if (!(key instanceof JacobiKey)) {
57              return false;
58          }
59  
60          final JacobiKey otherK = (JacobiKey) key;
61          return (v == otherK.v) && (w == otherK.w);
62      }
63  }