src/main/java/org/apache/datasketches/theta/HashIterator.java

/*
 * 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.datasketches.theta;

/**
 * This is used to iterate over the retained hash values of the Theta sketch.
 * @author Lee Rhodes
 */
public interface HashIterator {

  /**
   * Gets the hash value
   * @return the hash value
   */
  long get();

  /**
   * Returns true at the next hash value in sequence.
   * If false, the iteration is done.
   * @return true at the next hash value in sequence.
   */
  boolean next();
}