org.jamplate.model

Enum Intersection

java.lang.Object

java.lang.Enum<Intersection>

org.jamplate.model.Intersection

All Implemented Interfaces:

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

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

An enumeration of possible intersections between sources.
The names is describing the other source.

                SAME
                        i == s <= j == e
                        ...|~~~|...
                        ...|~~~|...
                FRAGMENT | CONTAINER
                        i < s <= e < j
                        .<--~~~-->.
                        ...|~~~|...
                START | AHEAD
                        i == s <= e < j
                        .|----~~~>.
                        .|--->.....
                END | BEHIND
                        i < s <= e == j
                        .<~~~----|.
                        .....<---|.
                OVERFLOW | UNDERFLOW
                        i < s < j < e
                        .<~~--|....
                        ....|--~~>.
                NEXT | PREVIOUS
                        i < j == s < e
                        .<---|.....
                        .....|--->.
                AFTER | BEFORE
                        i <= j < s <= e
                        .<~~|......
                        ......|~~>.
 

Since:

0.2.0 ~2021.01.09

Version:

0.2.0

Author:

LSafer

Enum Constant Summary

Enum Constants

Enum Constant and Description
AFTER After The Source opposite When the other source is after the source but not immediately.
AHEAD This And Ahead (opposite) When the source is contained at the very start of the other source.
BEFORE Before The Source opposite When the other source is before the source but not immediately.
BEHIND This And Behind (opposite) When the source is contained at the very end of the other source.
CONTAINER Containing Source (opposite) When the bounds of the source are contained in the bounds of the other source but do not touch.
END At The End (opposite) When the source contains the other source at its end.
FRAGMENT Fragment Source (opposite) When the source has its bounds containing the bounds of the other source but do not touch.
NEXT Next Source (opposite) When the source is followed immediately by the other source.
OVERFLOW Overflowed Slice (opposite) When the first fragment of the source is before the other source but the second fragment is in it.
PREVIOUS Previous Source (opposite) When the source has the other source immediately before it.
SAME Same Source (opposite) When the source has the exact bounds as the other source.
START At The Start (opposite) When the source contains the other source at its start.
UNDERFLOW Underflowed Slice (opposite) When the first fragment of the source is in the other source but the second fragment is after it.

Method Summary

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

CONTAINER

public static final Intersection CONTAINER

Containing Source (opposite)
When the bounds of the source are contained in the bounds of the other source but do not touch.

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

     (s < i <= j < e)
 

     {s < i} & {j < e}
 

Since:

0.2.0 ~2021.01.09

See Also:

Dominance.CONTAIN, Relation.PARENT

AHEAD

public static final Intersection AHEAD

This And Ahead (opposite)
When the source is contained at the very start of the other source.

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

     (s == i <= j < e)
 

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

Since:

0.2.0 ~2021.01.09

See Also:

Dominance.CONTAIN, Relation.PARENT

BEHIND

public static final Intersection BEHIND

This And Behind (opposite)
When the source is contained at the very end of the other source.

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

     (s < i <= j == e)
 

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

Since:

0.2.0 ~2021.01.09

See Also:

Dominance.CONTAIN, Relation.PARENT

SAME

public static final Intersection SAME

Same Source (opposite)
When the source has the exact bounds as the other source.

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

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

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

Since:

0.2.0 ~2021.01.09

See Also:

Dominance.EXACT

OVERFLOW

public static final Intersection OVERFLOW

Overflowed Slice (opposite)
When the first fragment of the source is before the other source but the second fragment is in it. (without any bound been exactly at another bound)

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

     (i < s < j < e)
 

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

Since:

0.2.0 ~2021.01.09

See Also:

Dominance.SHARE

UNDERFLOW

public static final Intersection UNDERFLOW

Underflowed Slice (opposite)
When the first fragment of the source is in the other source but the second fragment is after it. (without any bound been exactly at another bound)

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

     (s < i < e < j)
 

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

Since:

0.2.0 ~2021.01.09

See Also:

Dominance.SHARE

FRAGMENT

public static final Intersection FRAGMENT

Fragment Source (opposite)
When the source has its bounds containing the bounds of the other source but do not touch.

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

     (i < s <= e < j)
 

     {i < s} & {e < j}
 

Since:

0.2.0 ~2021.01.09

See Also:

Dominance.PART, Relation.CHILD

START

public static final Intersection START

At The Start (opposite)
When the source contains the other source at its start.

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

     (i == s <= e < j)
 

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

Since:

0.2.0 ~2021.01.09

See Also:

Dominance.PART, Relation.CHILD

END

public static final Intersection END

At The End (opposite)
When the source contains the other source at its end.

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

     (i < s <= e == j)
 

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

Since:

0.2.0 ~2021.01.09

See Also:

Dominance.PART, Relation.CHILD

NEXT

public static final Intersection NEXT

Next Source (opposite)
When the source is followed immediately by the other source.

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

     (i < j == s < e)
 

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

Since:

0.2.0 ~2021.01.09

See Also:

Dominance.NONE, Relation.NEXT

AFTER

public static final Intersection AFTER

After The Source opposite
When the other source is after the source but not immediately.

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

     (i <= j < s <= e)
 

     {j < s}
 

Since:

0.2.0 ~2021.01.09

See Also:

Dominance.NONE, Relation.NEXT

PREVIOUS

public static final Intersection PREVIOUS

Previous Source (opposite)
When the source has the other source immediately before it.

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

     (s < e == i < j)
 

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

Since:

0.2.0 ~2021.01.09

See Also:

Dominance.NONE, Relation.PREVIOUS

BEFORE

public static final Intersection BEFORE

Before The Source opposite
When the other source is before the source but not immediately.

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

     (s <= e < i <= j)
 

     {e < i}
 

Since:

0.2.0 ~2021.01.09

See Also:

Dominance.NONE, Relation.PREVIOUS

Method Detail

values

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

Returns:

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

valueOf

public static Intersection 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 Intersection compute(int i,
                                                                             int j,
                                                                             int s,
                                                                             int e)

Calculate what is the intersection between the areas [i, j) and [s, e).
The first area is the area to compare the second area with. The returned intersection will be the intersection describing the feelings of the first area about the second area.
For example: if the second area is contained in the middle of first area, then the retaliation fragmnet will be returned.

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:

the intersection constant describing the intersection of the second area to 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 Intersection compute(@NotNull
                                                                             @NotNull Reference reference,
                                                                             int s,
                                                                             int e)

Calculate what is the intersection between the given reference and the given area [s, e).

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:

the intersection constant describing the intersection of the second area to the 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.10

See Also:

compute(int, int, int, int)

compute

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

Calculate the intersection between the references reference and other.

Parameters:

reference - the first reference.

other - the second reference.

Returns:

the intersection constant describing the intersection of the second reference to 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 Intersection compute(@NotNull
                                                                             @NotNull Tree tree,
                                                                             int s,
                                                                             int e)

Calculate what is the intersection between the given sketch and the given area [s, e).

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:

the intersection constant describing the intersection of the second area to the 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 Intersection compute(@NotNull
                                                                             @NotNull Tree tree,
                                                                             @NotNull
                                                                             @NotNull Reference other)

Calculate the intersection between the sketches sketch and other.

Parameters:

tree - the first sketch.

other - the second sketch.

Returns:

the intersection constant describing the intersection of the second sketch to 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 Intersection compute(@NotNull
                                                                             @NotNull Tree tree,
                                                                             @NotNull
                                                                             @NotNull Tree other)

Calculate the intersection between the sketches sketch and other.

Parameters:

tree - the first sketch.

other - the second sketch.

Returns:

the intersection constant describing the intersection of the second sketch to 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<Intersection>

dominance

@NotNull
 @Contract(pure=true)
public @NotNull Dominance dominance()

Returns how dominance this intersection over its opposite intersection.

Returns:

how dominant this intersection.

Since:

0.2.0 ~2021.01.10

relation

@Nullable
 @Contract(pure=true)
public @Nullable Relation relation()

Returns the relation from this the opposite intersection to this intersection.

Returns:

the direction of this. Or null if there cannot be a direction between them.

Since:

0.2.0 ~2021.05.15

opposite

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

Get the opposite intersection of this intersection.

Returns:

the opposite intersection. Or null if none.

Since:

0.2.0 ~2021.01.09