Enum S2Predicates.Excluded

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<S2Predicates.Excluded>
    Enclosing class:
    S2Predicates

    public static enum S2Predicates.Excluded
    extends java.lang.Enum<S2Predicates.Excluded>
    Given two sites A and B that form the center of caps of radius 'r', this indicates which sites are irrelevant to the Voronoi diagram relative to an edge PQ.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      FIRST
      The first site is excluded, i.e.
      NEITHER
      Neither site is excluded, i.e.
      SECOND
      The second site is excluded, i.e.
      UNCERTAIN
      The algorithm could not robustly determine the exclusion, or A is exactly equal to B.
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private Excluded()  
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static S2Predicates.Excluded valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static S2Predicates.Excluded[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • FIRST

        public static final S2Predicates.Excluded FIRST
        The first site is excluded, i.e. always further from the edge than the second site.
      • SECOND

        public static final S2Predicates.Excluded SECOND
        The second site is excluded, i.e. always further from the edge than the first site.
      • NEITHER

        public static final S2Predicates.Excluded NEITHER
        Neither site is excluded, i.e. both sites are closer to part of the edge than the other.
      • UNCERTAIN

        public static final S2Predicates.Excluded UNCERTAIN
        The algorithm could not robustly determine the exclusion, or A is exactly equal to B.
    • Constructor Detail

      • Excluded

        private Excluded()
    • Method Detail

      • values

        public static S2Predicates.Excluded[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (S2Predicates.Excluded c : S2Predicates.Excluded.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static S2Predicates.Excluded valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null