FieldCopolarN.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.CalculusFieldElement;

/** Copolar trio with pole at point n in Glaisher’s Notation.
 * <p>
 * This is a container for the three principal Jacobi elliptic functions
 * {@code sn(u|m)}, {@code cn(u|m)}, and {@code dn(u|m)}.
 * </p>
 * @param <T> the type of the field elements
 * @since 2.0
 */
public class FieldCopolarN<T extends CalculusFieldElement<T>> {

    /** Value of the sn function. */
    private final T sn;

    /** Value of the cn function. */
    private final T cn;

    /** Value of the dn function. */
    private final T dn;

    /** Simple constructor.
     * @param sn value of the sn function
     * @param cn value of the cn function
     * @param dn value of the dn function
     */
    FieldCopolarN(final T sn, final T cn, final T dn) {
        this.sn = sn;
        this.cn = cn;
        this.dn = dn;
    }

    /** Get the value of the sn function.
     * @return sn(u|m)
     */
    public T sn() {
        return sn;
    }

    /** Get the value of the cn function.
     * @return cn(u|m)
     */
    public T cn() {
        return cn;
    }

    /** Get the value of the dn function.
     * @return dn(u|m)
     */
    public T dn() {
        return dn;
    }

}