com.github.lontime.shaded.org.redisson.api.RHyperLogLog Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of extredisson-library Show documentation
The newest version!
/**
 * Copyright (c) 2013-2021 Nikita Koksharov
 *
 * Licensed 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 com.github.lontime.shaded.org.redisson.api;

import java.util.Collection;

/**
 * Probabilistic data structure that lets you maintain counts of millions of items with extreme space efficiency.
 * 
 * @author Nikita Koksharov
 *
 * @param  type of stored values 
 */
public interface RHyperLogLog extends RExpirable, RHyperLogLogAsync {

    /**
     * Adds element into this structure.
     * 
     * @param obj - element to add
     * @return true if object has been added 
     *          or false if it was already added
     */
    boolean add(V obj);

    /**
     * Adds all elements contained in objects collection into this structure
     * 
     * @param objects - elements to add
     * @return true if at least one object has been added 
     *          or false if all were already added
     */
    boolean addAll(Collection objects);

    /**
     * Returns approximated number of unique elements added into this structure.
     * 
     * @return approximated number of unique elements added into this structure
     */
    long count();

    /**
     * Returns approximated number of unique elements 
     * added into this instances and other instances defined through otherLogNames.
     * 
     * @param otherLogNames - name of instances
     * @return number
     */
    long countWith(String... otherLogNames);

    /**
     * Merges multiple instances into this instance.
     * 
     * @param otherLogNames - name of instances
     */
    void mergeWith(String... otherLogNames);

}