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 /** Values of {@link FieldJacobiTheta Jacobi theta} functions.
22 * <p>
23 * This is a container for the four Jacobi theta functions
24 * θ₁(z|τ), θ₂(z|τ), θ₃(z|τ), and θ₄(z|τ).
25 * </p>
26 * @param <T> the type of the field elements
27 * @see FieldJacobiTheta
28 * @since 2.0
29 */
30 public class FieldTheta<T extends CalculusFieldElement<T>> {
31
32 /** Value of the θ₁(z|τ) function. */
33 private final T theta1;
34
35 /** Value of the θ₂(z|τ) function. */
36 private final T theta2;
37
38 /** Value of the θ₃(z|τ) function. */
39 private final T theta3;
40
41 /** Value of the θ₄(z|τ) function. */
42 private final T theta4;
43
44 /** Simple constructor.
45 * @param theta1 value of the θ₁(z|τ) function
46 * @param theta2 value of the θ₂(z|τ) function
47 * @param theta3 value of the θ₃(z|τ) function
48 * @param theta4 value of the θ₄(z|τ) function
49 */
50 FieldTheta(final T theta1, final T theta2,
51 final T theta3, final T theta4) {
52 this.theta1 = theta1;
53 this.theta2 = theta2;
54 this.theta3 = theta3;
55 this.theta4 = theta4;
56 }
57
58 /** Get the value of the θ₁(z|τ) function.
59 * @return θ₁(z|τ)
60 */
61 public T theta1() {
62 return theta1;
63 }
64
65 /** Get the value of the θ₂(z|τ) function.
66 * @return θ₂(z|τ)
67 */
68 public T theta2() {
69 return theta2;
70 }
71
72 /** Get the value of the θ₃(z|τ) function.
73 * @return θ₃(z|τ)
74 */
75 public T theta3() {
76 return theta3;
77 }
78
79 /** Get the value of the θ₄(z|τ) function.
80 * @return θ₄(z|τ)
81 */
82 public T theta4() {
83 return theta4;
84 }
85
86 }