org.apache.datasketches.tuple.aninteger.IntegerSketch Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of datasketches-java Show documentation

Core sketch algorithms used alone and by other Java repositories in the DataSketches library.

There is a newer version: 7.0.0

/*
 * 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.tuple.aninteger;

import org.apache.datasketches.ResizeFactor;
import org.apache.datasketches.memory.Memory;
import org.apache.datasketches.tuple.UpdatableSketch;

/**
 * @author Lee Rhodes
 */
public class IntegerSketch extends UpdatableSketch {

  /**
   * Constructs this sketch with given lgK.
   * @param lgK Log_base2 of Nominal Entries.
   * See Nominal Entries
   * @param mode The IntegerSummary mode to be used
   */
  public IntegerSketch(final int lgK, final IntegerSummary.Mode mode) {
    super(1 << lgK, ResizeFactor.X8.ordinal(), 1.0F, new IntegerSummaryFactory(mode));
  }

  /**
   * Constructs this sketch from a Memory image, which must be from an IntegerSketch, and
   * usually with data.
   * @param mem the given Memory
   * @param mode The IntegerSummary mode to be used
   */
  public IntegerSketch(final Memory mem, final IntegerSummary.Mode mode) {
    super(mem, new IntegerSummaryDeserializer(), new IntegerSummaryFactory(mode));
  }

  @Override
  public void update(final String key, final Integer value) {
    super.update(key, value);
  }

  @Override
  public void update(final long key, final Integer value) {
    super.update(key, value);
  }

}