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  package org.hipparchus.special.elliptic.jacobi;
18  
19  /** Copolar trio with pole at point d in Glaisher’s Notation.
20   * <p>
21   * This is a container for the three subsidiary Jacobi elliptic functions
22   * {@code nd(u|m)}, {@code sd(u|m)}, and {@code cd(u|m)}.
23   * </p>
24   * @since 2.0
25   */
26  public class CopolarD {
27  
28      /** Value of the nd function. */
29      private final double nd;
30  
31      /** Value of the sd function. */
32      private final double sd;
33  
34      /** Value of the cd function. */
35      private final double cd;
36  
37      /** Simple constructor.
38       * @param trioN copolar trio with pole at point n in Glaisher’s Notation
39       */
40      CopolarD(final CopolarN trioN) {
41          this.nd = 1.0 / trioN.dn();
42          this.sd = nd  * trioN.sn();
43          this.cd = nd  * trioN.cn();
44      }
45  
46      /** Get the value of the nd function.
47       * @return nd(u|m)
48       */
49      public double nd() {
50          return nd;
51      }
52  
53      /** Get the value of the sd function.
54       * @return sd(u|m)
55       */
56      public double sd() {
57          return sd;
58      }
59  
60      /** Get the value of the cd function.
61       * @return cd(u|m)
62       */
63      public double cd() {
64          return cd;
65      }
66  
67  }