Inequality.java

  1. /*
  2.  * Licensed to the Apache Software Foundation (ASF) 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 ASF 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.  *      http://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.apache.commons.statistics.inference;

  18. /**
  19.  * Represents a non-equal comparison between two numbers.
  20.  *
  21.  * @see <a href="https://en.wikipedia.org/wiki/Inequality_(mathematics)">Inequality (Wikipedia)</a>
  22.  * @since 1.1
  23.  */
  24. public enum Inequality {
  25.     /**
  26.      * Represents a strict inequality.
  27.      * <ul>
  28.      * <li>{@code a < b}
  29.      * <li>{@code a > b}
  30.      * </ul>
  31.      */
  32.     STRICT,

  33.     /**
  34.      * Represents a non-strict inequality (numbers may be equal).
  35.      * <ul>
  36.      * <li>{@code a <= b}
  37.      * <li>{@code a >= b}
  38.      * </ul>
  39.      */
  40.     NON_STRICT
  41. }