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.complex.Complex;
20
21 /** Values of {@link JacobiTheta 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 * @see JacobiTheta
27 * @since 2.0
28 */
29 public class Theta {
30
31 /** Value of the θ₁(z|τ) function. */
32 private final Complex theta1;
33
34 /** Value of the θ₂(z|τ) function. */
35 private final Complex theta2;
36
37 /** Value of the θ₃(z|τ) function. */
38 private final Complex theta3;
39
40 /** Value of the θ₄(z|τ) function. */
41 private final Complex theta4;
42
43 /** Simple constructor.
44 * @param theta1 value of the θ₁(z|τ) function
45 * @param theta2 value of the θ₂(z|τ) function
46 * @param theta3 value of the θ₃(z|τ) function
47 * @param theta4 value of the θ₄(z|τ) function
48 */
49 Theta(final Complex theta1, final Complex theta2,
50 final Complex theta3, final Complex theta4) {
51 this.theta1 = theta1;
52 this.theta2 = theta2;
53 this.theta3 = theta3;
54 this.theta4 = theta4;
55 }
56
57 /** Get the value of the θ₁(z|τ) function.
58 * @return θ₁(z|τ)
59 */
60 public Complex theta1() {
61 return theta1;
62 }
63
64 /** Get the value of the θ₂(z|τ) function.
65 * @return θ₂(z|τ)
66 */
67 public Complex theta2() {
68 return theta2;
69 }
70
71 /** Get the value of the θ₃(z|τ) function.
72 * @return θ₃(z|τ)
73 */
74 public Complex theta3() {
75 return theta3;
76 }
77
78 /** Get the value of the θ₄(z|τ) function.
79 * @return θ₄(z|τ)
80 */
81 public Complex theta4() {
82 return theta4;
83 }
84
85 }