Spdk/include/spdk/zipf.h
Jim Harris 488570ebd4 Replace most BSD 3-clause license text with SPDX identifier.
Many open source projects have moved to using SPDX identifiers
to specify license information, reducing the amount of
boilerplate code in every source file.  This patch replaces
the bulk of SPDK .c, .cpp and Makefiles with the BSD-3-Clause
identifier.

Almost all of these files share the exact same license text,
and this patch only modifies the files that contain the
most common license text.  There can be slight variations
because the third clause contains company names - most say
"Intel Corporation", but there are instances for Nvidia,
Samsung, Eideticom and even "the copyright holder".

Used a bash script to automate replacement of the license text
with SPDX identifier which is checked into scripts/spdx.sh.

Signed-off-by: Jim Harris <james.r.harris@intel.com>
Change-Id: Iaa88ab5e92ea471691dc298cfe41ebfb5d169780
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/12904
Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com>
Community-CI: Mellanox Build Bot
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Aleksey Marchuk <alexeymar@nvidia.com>
Reviewed-by: Changpeng Liu <changpeng.liu@intel.com>
Reviewed-by: Dong Yi <dongx.yi@intel.com>
Reviewed-by: Konrad Sztyber <konrad.sztyber@intel.com>
Reviewed-by: Paul Luse <paul.e.luse@intel.com>
Reviewed-by: <qun.wan@intel.com>
2022-06-09 07:35:12 +00:00

56 lines
1.1 KiB
C

/* SPDX-License-Identifier: BSD-3-Clause
* Copyright (c) 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