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