Spdk/include/spdk/zipf.h
paul luse a6dbe3721e update Intel copyright notices
per Intel policy to include file commit date using git cmd
below.  The policy does not apply to non-Intel (C) notices.

git log --follow -C90% --format=%ad --date default <file> | tail -1

and then pull just the 4 digit year from the result.

Intel copyrights were not added to files where Intel either had
no contribution ot the contribution lacked substance (ie license
header updates, formatting changes, etc).  Contribution date used
"--follow -C95%" to get the most accurate date.

Note that several files in this patch didn't end the license/(c)
block with a blank comment line so these were added as the vast
majority of files do have this last blank line.  Simply there for
consistency.

Signed-off-by: paul luse <paul.e.luse@intel.com>
Change-Id: Id5b7ce4f658fe87132f14139ead58d6e285c04d4
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/15192
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
Community-CI: Mellanox Build Bot
2022-11-10 08:28:53 +00:00

56 lines
1.1 KiB
C

/* SPDX-License-Identifier: BSD-3-Clause
* Copyright (C) 2021 Intel Corporation.
* All rights reserved.
*/
/** \file
* Zipf random number distribution
*/
#ifndef SPDK_ZIPF_H
#define SPDK_ZIPF_H
#include "spdk/stdinc.h"
#ifdef __cplusplus
extern "C" {
#endif
struct spdk_zipf;
/**
* Create a zipf random number generator.
*
* Numbers from [0, range) will be returned by the generator when
* calling \ref spdk_zipf_generate.
*
* \param range Range of values for the zipf distribution.
* \param theta Theta distribution parameter.
* \param seed Seed value for the random number generator.
*
* \return a pointer to the new zipf generator.
*/
struct spdk_zipf *spdk_zipf_create(uint64_t range, double theta, uint32_t seed);
/**
* Free a zipf generator and set the pointer to NULL.
*
* \param zipfp Zipf generator to free.
*/
void spdk_zipf_free(struct spdk_zipf **zipfp);
/**
* Generate a value from the zipf generator.
*
* \param zipf Zipf generator to generate the value from.
*
* \return value in the range [0, range)
*/
uint64_t spdk_zipf_generate(struct spdk_zipf *zipf);
#ifdef __cplusplus
}
#endif
#endif