org.jamplate.model

Enum Dominance

java.lang.Object

java.lang.Enum<Dominance>

org.jamplate.model.Dominance

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Dominance>

public enum Dominance
extends java.lang.Enum<Dominance>

An enumeration of how dominant a relation is over another relation.
The names is describing the other source.

                EXACT
                        i == s <= j == e
                        ...|---|...
                        ...|---|...
                PART | CONTAIN
                        i < s <= e < j
                        .<------->.
                        ...|---|...
                        

                        i == s <= e < j
                        .|------->.
                        .|--->.....
                        

                        i < s <= e == j
                        .<-------|.
                        .....<---|.
                SHARE
                        i < s < j < e
                        .<----|....
                        ....|---->.
                        

                        s < i < e < j
                        ....|---->.
                        .<----|....
                NONE
                        i < j == s < e
                        .<---|.....
                        .....|--->.
                        

                        s < e == i < j
                        .....|--->.
                        .<---|.....
                        

                        i <= j < s <= e
                        .<--|......
                        ......|-->.
                        

                        s <= e < i <= j
                        ......|-->.
                        .<--|......
 

Since:

0.2.0 ~2021.01.10

Version:

0.2.0

Author:

LSafer

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONTAIN Container (opposite) Defines that a source that have the relation contains the other source in it (but not exact).
EXACT Mirror (opposite) Defines that a source that have the relation has the same relation as the other source.
NONE Stranger (opposite) Defines that a source that have the relation shares none of the other source.
PART Slice (opposite) Defines that a source that have the relation shares some (but not all) of the other source.
SHARE Clash (opposite) Defines that a source that have the relation shares some (but not all) of the other source and vice versa.

Method Summary

Modifier and Type	Method and Description
static @NotNull Dominance	compute(int i, int j, int s, int e) Calculate how much dominant the area [s, e) over the area [i, j).
static @NotNull Dominance	compute(@NotNull Reference reference, int s, int e) Calculate how much dominant the area [s, e) is over the given reference.
static @NotNull Dominance	compute(@NotNull Reference reference, @NotNull Reference other) Calculate how much dominant the other reference over the given reference.
static @NotNull Dominance	compute(@NotNull Tree tree, int s, int e) Calculate how much dominant the area [s, e) is over the given sketch.
static @NotNull Dominance	compute(@NotNull Tree tree, @NotNull Reference other) Calculate how much dominant the other reference over the given sketch.
static @NotNull Dominance	compute(@NotNull Tree tree, @NotNull Tree other) Calculate how much dominant the other sketch over the given sketch.
abstract @NotNull Dominance	opposite() Get the opposite dominance type of this dominance type.
@NotNull java.lang.String	toString()
static Dominance	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Dominance[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CONTAIN

public static final Dominance CONTAIN

Container (opposite)
Defines that a source that have the relation contains the other source in it (but not exact).

     ...|---|...
     .<------->.
     

     .|--->.....
     .|------->.
     

     .....<---|.
     .<-------|.
 

     (s < i <= j < e)
     (s == i <= j < e)
     (s < i <= j == e)
 

      {s < i} & {j < e}
      {i == s} & {j < e}
      {s < i} & {j == e}
 

Since:

0.2.0 ~2021.01.10

See Also:

Relation.PARENT, Intersection.CONTAINER, Intersection.AHEAD, Intersection.BEHIND

EXACT

public static final Dominance EXACT

Mirror (opposite)
Defines that a source that have the relation has the same relation as the other source.

     ...|---|...
     ...|---|...
 

     (i == s <= j == e)
 

     {i == s} & {j == e}
 

Since:

0.2.0 ~2021.01.10

See Also:

Intersection.SAME

SHARE

public static final Dominance SHARE

Clash (opposite)
Defines that a source that have the relation shares some (but not all) of the other source and vice versa.

     .<----|....
     ....|---->.
     

     ....|---->.
     .<----|....
 

     (i < s < j < e)
     (s < i < e < j)
 

     {i < s} & {s < j} & {j < e}
     {s < i} & {i < e} & {e < j}
 

Since:

0.2.0 ~2021.01.10

See Also:

Intersection.OVERFLOW, Intersection.UNDERFLOW

PART

public static final Dominance PART

Slice (opposite)
Defines that a source that have the relation shares some (but not all) of the other source. (one but not both)

     .<------->.
     ...|---|...
     

     .|------->.
     .|--->.....
     

     .<-------|.
     .....<---|.
 

     (i < s <= e < j)
     (i == s <= e < j)
     (i < s <= e == j)
 

     {i < s} & {e < j}
     {i == s} & {e < j}
     {i < s} & {j == e}
 

Since:

0.2.0 ~2021.01.10

See Also:

Relation.CHILD, Intersection.FRAGMENT, Intersection.START, Intersection.END

NONE

public static final Dominance NONE

Stranger (opposite)
Defines that a source that have the relation shares none of the other source.

     .<---|.....
     .....|--->.
     

     .....|--->.
     .<---|.....
     

     .<--|......
     ......|-->.
     

     ......|-->.
     .<--|......
 

     (i < j == s < e)
     (s < e == i < j)
     (i <= j < s <= e)
     (s <= e < i <= j)
 

     {i < j} & {j == s} & {s < e}
     {s < e} & {e == i} & {i < j}
     {j < s}
     {e < i}
 

Since:

0.2.0 ~2021.01.10

See Also:

Relation.NEXT, Relation.PREVIOUS, Intersection.NEXT, Intersection.PREVIOUS, Intersection.AFTER, Intersection.BEFORE

Method Detail

values

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

Returns:

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

valueOf

public static Dominance 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

compute

@NotNull
 @Contract(pure=true)
public static @NotNull Dominance compute(int i,
                                                                          int j,
                                                                          int s,
                                                                          int e)

Calculate how much dominant the area [s, e) over the area [i, j).

Parameters:

i - the first index of the first area.

j - one past the last index of the first area.

s - the first index of the second area.

e - one past the last index of the second area.

Returns:

how much dominant the second area over the first area.

Throws:

java.lang.IllegalArgumentException - if i is not in the range [0, j] or if s is not in the range [0, e].

Since:

0.2.0 ~2021.01.10

compute

@NotNull
 @Contract(pure=true)
public static @NotNull Dominance compute(@NotNull
                                                                          @NotNull Reference reference,
                                                                          int s,
                                                                          int e)

Calculate how much dominant the area [s, e) is over the given reference.

Parameters:

reference - the reference (first area).

s - the first index of the second area.

e - one past the last index of the second area.

Returns:

how much dominant the second area over the given reference.

Throws:

java.lang.NullPointerException - if the given reference is null.

java.lang.IllegalArgumentException - if s is not in the range [0, e].

Since:

0.2.0 ~2021.01.11

See Also:

compute(int, int, int, int)

compute

@NotNull
 @Contract(pure=true)
public static @NotNull Dominance compute(@NotNull
                                                                          @NotNull Reference reference,
                                                                          @NotNull
                                                                          @NotNull Reference other)

Calculate how much dominant the other reference over the given reference.

Parameters:

reference - the first reference.

other - the second reference.

Returns:

how much dominant the second reference over the first reference.

Throws:

java.lang.NullPointerException - if the given reference or other is null.

Since:

0.2.0 ~2021.01.10

See Also:

compute(int, int, int, int)

compute

@NotNull
 @Contract(pure=true)
public static @NotNull Dominance compute(@NotNull
                                                                          @NotNull Tree tree,
                                                                          int s,
                                                                          int e)

Calculate how much dominant the area [s, e) is over the given sketch.

Parameters:

tree - the sketch (first area).

s - the first index of the second area.

e - one past the last index of the second area.

Returns:

how much dominant the second area over the given sketch.

Throws:

java.lang.NullPointerException - if the given sketch is null.

java.lang.IllegalArgumentException - if s is not in the range [0, e].

Since:

0.2.0 ~2021.01.25

See Also:

compute(int, int, int, int)

compute

@NotNull
 @Contract(pure=true)
public static @NotNull Dominance compute(@NotNull
                                                                          @NotNull Tree tree,
                                                                          @NotNull
                                                                          @NotNull Reference other)

Calculate how much dominant the other reference over the given sketch.

Parameters:

tree - the first sketch.

other - the second reference.

Returns:

how much dominant the second reference over the first sketch.

Throws:

java.lang.NullPointerException - if the given sketch or other is null.

Since:

0.2.0 ~2021.01.25

See Also:

compute(int, int, int, int)

compute

@NotNull
 @Contract(pure=true)
public static @NotNull Dominance compute(@NotNull
                                                                          @NotNull Tree tree,
                                                                          @NotNull
                                                                          @NotNull Tree other)

Calculate how much dominant the other sketch over the given sketch.

Parameters:

tree - the first sketch.

other - the second sketch.

Returns:

how much dominant the second sketch over the first sketch.

Throws:

java.lang.NullPointerException - if the given sketch or other is null.

Since:

0.2.0 ~2021.01.25

See Also:

compute(int, int, int, int)

toString

@NotNull
 @Contract(pure=true)
public @NotNull java.lang.String toString()

Overrides:

toString in class java.lang.Enum<Dominance>

opposite

@NotNull
 @Contract(pure=true)
public abstract @NotNull Dominance opposite()

Get the opposite dominance type of this dominance type.

Returns:

the opposite dominance type.

Since:

0.2.0 ~2021.01.10