Theta.java

/*
 * Licensed to the Hipparchus project under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The Hipparchus project licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.hipparchus.special.elliptic.jacobi;

import org.hipparchus.complex.Complex;

/** Values of {@link JacobiTheta Jacobi theta} functions.
 * <p>
 * This is a container for the four Jacobi theta functions
 * θ₁(z|τ), θ₂(z|τ), θ₃(z|τ), and θ₄(z|τ).
 * </p>
 * @see JacobiTheta
 * @since 2.0
 */
public class Theta {

    /** Value of the θ₁(z|τ) function. */
    private final Complex theta1;

    /** Value of the θ₂(z|τ) function. */
    private final Complex theta2;

    /** Value of the θ₃(z|τ) function. */
    private final Complex theta3;

    /** Value of the θ₄(z|τ) function. */
    private final Complex theta4;

    /** Simple constructor.
     * @param theta1 value of the θ₁(z|τ) function
     * @param theta2 value of the θ₂(z|τ) function
     * @param theta3 value of the θ₃(z|τ) function
     * @param theta4 value of the θ₄(z|τ) function
     */
    Theta(final Complex theta1, final Complex theta2,
          final Complex theta3, final Complex theta4) {
        this.theta1 = theta1;
        this.theta2 = theta2;
        this.theta3 = theta3;
        this.theta4 = theta4;
    }

    /** Get the value of the θ₁(z|τ) function.
     * @return θ₁(z|τ)
     */
    public Complex theta1() {
        return theta1;
    }

    /** Get the value of the θ₂(z|τ) function.
     * @return θ₂(z|τ)
     */
    public Complex theta2() {
        return theta2;
    }

    /** Get the value of the θ₃(z|τ) function.
     * @return θ₃(z|τ)
     */
    public Complex theta3() {
        return theta3;
    }

    /** Get the value of the θ₄(z|τ) function.
     * @return θ₄(z|τ)
     */
    public Complex theta4() {
        return theta4;
    }

}