SuanShu, a Java numerical and statistical library

com.numericalmethod.suanshu.interval
Enum Algebra.Relation

java.lang.Object
  extended by java.lang.Enum<Algebra.Relation>
      extended by com.numericalmethod.suanshu.interval.Algebra.Relation
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Algebra.Relation>
Enclosing interface:
Algebra

public static enum Algebra.Relation
extends java.lang.Enum<Algebra.Relation>


Enum Constant Summary
AFTER
          X takes place after Y
BEFORE
          X takes place before Y
DURING
          X during Y
DURING_INVERSE
          Y during X
EQUAL
          X is equal to Y
FINISH
          X finishes Y
FINISH_INVERSE
          Y finishes X
MEET
          X meets Y
MEET_INVERSE
          Y meets X
OVERLAP
          X overlaps with Y
OVERLAP_INVERSE
          Y overlaps with X
START
          X starts Y
START_INVERSE
          Y starts X
 
Method Summary
abstract
<T extends java.lang.Comparable<T>>
boolean
isRelationBetween(Interval<T> x, Interval<T> y)
          Check if x and y satisfy a certain relation.
static Algebra.Relation valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static Algebra.Relation[] 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

BEFORE

public static final Algebra.Relation BEFORE
X takes place before Y


AFTER

public static final Algebra.Relation AFTER
X takes place after Y


MEET

public static final Algebra.Relation MEET
X meets Y


MEET_INVERSE

public static final Algebra.Relation MEET_INVERSE
Y meets X


OVERLAP

public static final Algebra.Relation OVERLAP
X overlaps with Y


OVERLAP_INVERSE

public static final Algebra.Relation OVERLAP_INVERSE
Y overlaps with X


START

public static final Algebra.Relation START
X starts Y


START_INVERSE

public static final Algebra.Relation START_INVERSE
Y starts X


DURING

public static final Algebra.Relation DURING
X during Y


DURING_INVERSE

public static final Algebra.Relation DURING_INVERSE
Y during X


FINISH

public static final Algebra.Relation FINISH
X finishes Y


FINISH_INVERSE

public static final Algebra.Relation FINISH_INVERSE
Y finishes X


EQUAL

public static final Algebra.Relation EQUAL
X is equal to Y

Method Detail

values

public static Algebra.Relation[] 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 (Algebra.Relation c : Algebra.Relation.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static Algebra.Relation 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

isRelationBetween

public abstract <T extends java.lang.Comparable<T>> boolean isRelationBetween(Interval<T> x,
                                                                              Interval<T> y)
Check if x and y satisfy a certain relation.

Type Parameters:
T - a Comparable type
Parameters:
x - an interval
y - another interval
Returns:
true is iff x and y satisfy the relation

SuanShu, a Java numerical and statistical library

Copyright © 2011 Numerical Method Inc. Ltd. All Rights Reserved.