org.apache.commons.text.similarity.IntersectionResult Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of commons-text Show documentation
Show all versions of commons-text Show documentation
Apache Commons Text is a library focused on algorithms working on strings.
The newest version!
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.commons.text.similarity;
import java.util.Objects;
/**
* Represents the intersection result between two sets.
*
* Stores the size of set A, set B and the intersection of A and B
* ({@code |A ∩ B|}).
*
* This class is immutable.
*
* @since 1.7
* @see Intersection
*/
public class IntersectionResult {
/**
* The size of set A.
*/
private final int sizeA;
/**
* The size of set B.
*/
private final int sizeB;
/**
* The size of the intersection between set A and B.
*/
private final int intersection;
/**
* Constructs the results for an intersection between two sets.
*
* @param sizeA the size of set A ({@code |A|})
* @param sizeB the size of set B ({@code |B|})
* @param intersection the size of the intersection of A and B ({@code |A ∩ B|})
* @throws IllegalArgumentException if the sizes are negative or the intersection is greater
* than the minimum of the two set sizes
*/
public IntersectionResult(final int sizeA, final int sizeB, final int intersection) {
if (sizeA < 0) {
throw new IllegalArgumentException("Set size |A| is not positive: " + sizeA);
}
if (sizeB < 0) {
throw new IllegalArgumentException("Set size |B| is not positive: " + sizeB);
}
if (intersection < 0 || intersection > Math.min(sizeA, sizeB)) {
throw new IllegalArgumentException("Invalid intersection of A and B: " + intersection);
}
this.sizeA = sizeA;
this.sizeB = sizeB;
this.intersection = intersection;
}
@Override
public boolean equals(final Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
final IntersectionResult result = (IntersectionResult) o;
return sizeA == result.sizeA && sizeB == result.sizeB && intersection == result.intersection;
}
/**
* Gets the size of the intersection between set A and B.
*
* @return {@code |A ∩ B|}
*/
public int getIntersection() {
return intersection;
}
/**
* Gets the size of set A.
*
* @return |A|
*/
public int getSizeA() {
return sizeA;
}
/**
* Gets the size of set B.
*
* @return |B|
*/
public int getSizeB() {
return sizeB;
}
@Override
public int hashCode() {
return Objects.hash(sizeA, sizeB, intersection);
}
@Override
public String toString() {
return "Size A: " + sizeA + ", Size B: " + sizeB + ", Intersection: " + intersection;
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy