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