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