Apache Commons Text 1.15.0 · org.apache.commons.text.similarity.IntersectionResult

Modifier and Type	Field and Description
private final int	intersection The size of the intersection between set A and B.
private final int	sizeA The size of set A.
private final int	sizeB The size of set B.

Access	Constructor and Description
public	IntersectionResult(final int the size of set A (`\|A\|`). sizeA, final int the size of set B (`\|B\|`). sizeB, final int the size of the intersection of A and B (`\|A ∩ B\|`). intersection) Constructs the results for an intersection between two sets.

Method Summary

Modifier and Type	Method and Description
public boolean	equals(final Object o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public int	Returns: `\|A ∩ B\|` getIntersection() Gets the size of the intersection between set A and B.
public int	Returns: `\|A\|` getSizeA() Gets the size of set A.
public int	Returns: `\|B\|` getSizeB() Gets the size of set B.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

intersection	back to summary
private final int intersection The size of the intersection between set A and B.

sizeA	back to summary
private final int sizeA The size of set A.

sizeB	back to summary
private final int sizeB The size of set B.

IntersectionResult	back to summary
public IntersectionResult(final int sizeA, final int sizeB, final int intersection) Constructs the results for an intersection between two sets. Parameters sizeA:int the size of set A (`\|A\|`). sizeB:int the size of set B (`\|B\|`). intersection:int the size of the intersection of A and B (`\|A ∩ B\|`). Exceptions IllegalArgumentException: if the sizes are negative or the intersection is greater than the minimum of the two set sizes.

Method Detail

equals back to summary

equals	back to summary
public boolean equals(final Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Annotations @Override

public boolean equals(final Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations

@Override

getIntersection back to summary

getIntersection	back to summary
public int getIntersection() Gets the size of the intersection between set A and B. Returns:int `\|A ∩ B\|`

public int getIntersection()

Gets the size of the intersection between set A and B.

Returns:int: |A ∩ B|

getSizeA back to summary

getSizeA	back to summary
public int getSizeA() Gets the size of set A. Returns:int `\|A\|`

public int getSizeA()

Gets the size of set A.

Returns:int: |A|

getSizeB back to summary

getSizeB	back to summary
public int getSizeB() Gets the size of set B. Returns:int `\|B\|`

public int getSizeB()

Gets the size of set B.

Returns:int: |B|

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

public Class IntersectionResult

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail