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