Update Javadoc since tags
This commit is contained in:
parent
48b04658ea
commit
7c32ff7daf
|
@ -47,7 +47,7 @@ import java.util.stream.IntStream;
|
|||
*
|
||||
* @see Shape
|
||||
* @see CellExtractor
|
||||
* @since 4.5
|
||||
* @since 4.5.0
|
||||
*/
|
||||
public final class ArrayCountingBloomFilter implements CountingBloomFilter {
|
||||
|
||||
|
|
|
@ -33,7 +33,7 @@ import java.util.function.LongPredicate;
|
|||
* The default implementations of the {@code makePredicate()} and {@code asBitMapArray} methods
|
||||
* are slow and should be reimplemented in the implementing classes where possible.</em></p>
|
||||
*
|
||||
* @since 4.5
|
||||
* @since 4.5.0
|
||||
*/
|
||||
@FunctionalInterface
|
||||
public interface BitMapExtractor {
|
||||
|
|
|
@ -22,7 +22,7 @@ package org.apache.commons.collections4.bloomfilter;
|
|||
* <p>The functions view an array of longs as a collection of bit maps each containing 64 bits. The bits are arranged
|
||||
* in memory as a little-endian long value. This matches the requirements of the BitMapExtractor interface.</p>
|
||||
*
|
||||
* @since 4.5
|
||||
* @since 4.5.0
|
||||
*/
|
||||
public class BitMaps {
|
||||
/** A bit shift to apply to an integer to divided by 64 (2^6). */
|
||||
|
|
|
@ -25,7 +25,7 @@ import java.util.Objects;
|
|||
* </p>
|
||||
* @see BitMapExtractor
|
||||
* @see IndexExtractor
|
||||
* @since 4.5
|
||||
* @since 4.5.0
|
||||
*/
|
||||
public interface BloomFilter extends IndexExtractor, BitMapExtractor {
|
||||
|
||||
|
|
|
@ -25,7 +25,7 @@ import java.util.function.Predicate;
|
|||
/**
|
||||
* Produces Bloom filters from a collection (e.g. LayeredBloomFilter).
|
||||
*
|
||||
* @since 4.5
|
||||
* @since 4.5.0
|
||||
*/
|
||||
@FunctionalInterface
|
||||
public interface BloomFilterExtractor {
|
||||
|
|
|
@ -38,7 +38,7 @@ import java.util.function.IntPredicate;
|
|||
* <li>The IndexExtractor will not generate indices that have a zero count for the cell.</li>
|
||||
* </ul>
|
||||
*
|
||||
* @since 4.5
|
||||
* @since 4.5.0
|
||||
*/
|
||||
@FunctionalInterface
|
||||
public interface CellExtractor extends IndexExtractor {
|
||||
|
|
|
@ -52,7 +52,7 @@ import java.util.Objects;
|
|||
* partially updated or updated entirely before the exception is raised.</p>
|
||||
*
|
||||
* @see CellExtractor
|
||||
* @since 4.5
|
||||
* @since 4.5.0
|
||||
*/
|
||||
public interface CountingBloomFilter extends BloomFilter, CellExtractor {
|
||||
|
||||
|
|
|
@ -23,7 +23,7 @@ import java.util.function.LongPredicate;
|
|||
* if the {@code ary} is exhausted, the subsequent calls to {@code test} are executed with a zero value.
|
||||
* If the calls to {@code test} do not exhaust the {@code ary} the {@code processRemaining} method can be called to
|
||||
* execute the @{code test} with a zero value for each remaining {@code idx} value.
|
||||
* @since 4.5
|
||||
* @since 4.5.0
|
||||
*/
|
||||
class CountingLongPredicate implements LongPredicate {
|
||||
private int idx;
|
||||
|
|
|
@ -28,7 +28,7 @@ import java.util.function.Predicate;
|
|||
* {@code null} value for each remaining {@code idx} value.
|
||||
*
|
||||
* @param <T> the type of object being compared.
|
||||
* @since 4.5
|
||||
* @since 4.5.0
|
||||
*/
|
||||
class CountingPredicate<T> implements Predicate<T> {
|
||||
private int idx;
|
||||
|
|
|
@ -42,7 +42,7 @@ import java.util.function.IntPredicate;
|
|||
* than the number of bits then the modulus will create a 'random' position and increment within the size.
|
||||
* </p>
|
||||
*
|
||||
* @since 4.5
|
||||
* @since 4.5.0
|
||||
*/
|
||||
public class EnhancedDoubleHasher implements Hasher {
|
||||
|
||||
|
|
|
@ -20,7 +20,7 @@ package org.apache.commons.collections4.bloomfilter;
|
|||
* A Hasher creates IndexExtractor based on the hash implementation and the
|
||||
* provided Shape.
|
||||
*
|
||||
* @since 4.5
|
||||
* @since 4.5.0
|
||||
*/
|
||||
public interface Hasher {
|
||||
|
||||
|
|
|
@ -28,7 +28,7 @@ import java.util.function.LongPredicate;
|
|||
* The default implementation of {@code asIndexArray} is slow. Implementers should reimplement the
|
||||
* method where possible.</em></p>
|
||||
*
|
||||
* @since 4.5
|
||||
* @since 4.5.0
|
||||
*/
|
||||
@FunctionalInterface
|
||||
public interface IndexExtractor {
|
||||
|
|
|
@ -24,13 +24,13 @@ import java.util.function.IntPredicate;
|
|||
* <p><em>If the index is negative the behavior is not defined.</em></p>
|
||||
*
|
||||
* <p>This is conceptually a unique filter implemented as an {@code IntPredicate}.</p>
|
||||
* @since 4.5
|
||||
* @since 4.5.0
|
||||
*/
|
||||
public final class IndexFilter {
|
||||
/**
|
||||
* An IndexTracker implementation that uses an array of integers to track whether or not a
|
||||
* number has been seen. Suitable for Shapes that have few hash functions.
|
||||
* @since 4.5
|
||||
* @since 4.5.0
|
||||
*/
|
||||
static class ArrayTracker implements IntPredicate {
|
||||
private final int[] seen;
|
||||
|
@ -61,7 +61,7 @@ public final class IndexFilter {
|
|||
/**
|
||||
* An IndexTracker implementation that uses an array of bit maps to track whether or not a
|
||||
* number has been seen.
|
||||
* @since 4.5
|
||||
* @since 4.5.0
|
||||
*/
|
||||
static class BitMapTracker implements IntPredicate {
|
||||
private final long[] bits;
|
||||
|
|
|
@ -49,7 +49,7 @@ import java.util.function.Supplier;
|
|||
* the {@code target} filter.</li>
|
||||
* </ol>
|
||||
*
|
||||
* @since 4.5
|
||||
* @since 4.5.0
|
||||
*/
|
||||
public class LayerManager<T extends BloomFilter> implements BloomFilterExtractor {
|
||||
|
||||
|
|
|
@ -60,7 +60,7 @@ import java.util.function.Predicate;
|
|||
* it and sets the {@code target} before the operation.</li>
|
||||
* </ul>
|
||||
* @param <T> The type of Bloom Filter that is used for the layers.
|
||||
* @since 4.5
|
||||
* @since 4.5.0
|
||||
*/
|
||||
public class LayeredBloomFilter<T extends BloomFilter> implements BloomFilter, BloomFilterExtractor {
|
||||
/**
|
||||
|
|
|
@ -22,7 +22,7 @@ package org.apache.commons.collections4.bloomfilter;
|
|||
*
|
||||
* This is a functional interface whose functional method is {@code test(long,long)}.
|
||||
*
|
||||
* @since 4.5
|
||||
* @since 4.5.0
|
||||
*/
|
||||
@FunctionalInterface
|
||||
public interface LongBiPredicate {
|
||||
|
|
|
@ -21,7 +21,7 @@ import java.util.function.LongBinaryOperator;
|
|||
/**
|
||||
* Implementations of set operations on BitMapExtractors.
|
||||
*
|
||||
* @since 4.5
|
||||
* @since 4.5.0
|
||||
*/
|
||||
public final class SetOperations {
|
||||
|
||||
|
|
|
@ -81,7 +81,7 @@ package org.apache.commons.collections4.bloomfilter;
|
|||
* @see <a href="https://hur.st/bloomfilter">Bloom Filter calculator</a>
|
||||
* @see <a href="https://en.wikipedia.org/wiki/Bloom_filter">Bloom filter
|
||||
* [Wikipedia]</a>
|
||||
* @since 4.5
|
||||
* @since 4.5.0
|
||||
*/
|
||||
public final class Shape {
|
||||
|
||||
|
|
|
@ -24,7 +24,7 @@ import java.util.function.LongPredicate;
|
|||
/**
|
||||
* A bloom filter using an array of bit maps to track enabled bits. This is a standard
|
||||
* implementation and should work well for most Bloom filters.
|
||||
* @since 4.5
|
||||
* @since 4.5.0
|
||||
*/
|
||||
public final class SimpleBloomFilter implements BloomFilter {
|
||||
|
||||
|
|
|
@ -24,7 +24,7 @@ import java.util.function.LongPredicate;
|
|||
/**
|
||||
* A bloom filter using a TreeSet of integers to track enabled bits. This is a standard
|
||||
* implementation and should work well for most low cardinality Bloom filters.
|
||||
* @since 4.5
|
||||
* @since 4.5.0
|
||||
*/
|
||||
public final class SparseBloomFilter implements BloomFilter {
|
||||
|
||||
|
|
|
@ -22,7 +22,7 @@ import java.util.function.LongPredicate;
|
|||
/**
|
||||
* An abstract class to assist in implementing Bloom filter decorators.
|
||||
*
|
||||
* @since 4.5
|
||||
* @since 4.5.0
|
||||
*/
|
||||
public abstract class WrappedBloomFilter implements BloomFilter {
|
||||
private final BloomFilter wrapped;
|
||||
|
|
Loading…
Reference in New Issue