commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/stat/inference/AlternativeHypothesis.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF 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
 *
 *      http://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.apache.commons.math4.legacy.stat.inference;

/**
 * Represents an alternative hypothesis for a hypothesis test.
 *
 * @since 3.3
 */
public enum AlternativeHypothesis {

    /**
     * Represents a two-sided test. H0: p=p0, H1: p ≠ p0
     */
    TWO_SIDED,

    /**
     * Represents a right-sided test. H0: p ≤ p0, H1: p > p0.
     */
    GREATER_THAN,

    /**
     * Represents a left-sided test. H0: p ≥ p0, H1: p < p0.
     */
    LESS_THAN
}