hll.h

Go to the documentation of this file.

/* 
 * This file is part of biomcmc-lib, a low-level library for phylogenomic analysis.
 * Copyright (C) 2019-today  Leonardo de Oliveira Martins [ leomrtns at gmail.com;  http://www.leomartins.org ]
 *
 * biomcmc is free software; you can redistribute it and/or modify it under the terms of the GNU General Public
 * License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later
 * version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied 
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more 
 * details (file "COPYING" or http://www.gnu.org/copyleft/gpl.html).
 * The original hyperloglog functions are distributed under the ISC License (ISC) Copyright (c) 2016-2017, Ivan Vitjuk 
 * <virtus@eclipsedminds.org>.  The ISC License follows:
  Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, 
  provided that the above copyright notice and this permission notice appear in all copies.

  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH  REGARD TO THIS SOFTWARE INCLUDING ALL 
  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
  INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN 
  AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  PERFORMANCE OF THIS SOFTWARE.
 */

#ifndef _biomcmc_hll_h_
#define _biomcmc_hll_h_

#include "hashfunctions.h" 


struct hll_s;
typedef struct hll_s hll_t;

struct hll_estimate_s {
  double alpha;             
  uint16_t n_buckets;       
  uint16_t n_empty_buckets; 
  uint64_t estimate;        
  uint64_t hll_estimate;    
  uint64_t small_range_estimate; 
  uint64_t large_range_estimate; 
};

typedef struct hll_estimate_s hll_estimate_t;

typedef uint64_t(*hll_hash_function_t)(const char *, size_t);

hll_t *hll_create(size_t bucket_bits);

void hll_reset(hll_t *hll);

void hll_release(hll_t *hll);

void hll_add(const hll_t *hll, const char *data, size_t data_len);

int hll_merge(const hll_t *hll1, const hll_t *hll2);

/* Change the hash function to be used by the estimator
 *
 * @param hll - HLL data type
 * @param hash_function - A pointer to the hash function (@see hll_hash_function_t)
 * @return 1 on success, 0 on failure. Fails on NULL arguments
 */
int hll_set_hash_function(hll_t *hll, hll_hash_function_t hash_function);

int hll_get_estimate(const hll_t *hll, hll_estimate_t *estimate);

#endif