faker::number Namespace Reference

Functions
template<std::integral I> requires (sizeof(I) <= sizeof(long long))
I	integer (I min, I max)
	Generates a random integer number in the given range, bounds included.
template<std::integral I> requires (sizeof(I) <= sizeof(long long))
I	integer (I max)
	Generates a random integer between 0 and the given maximum value, bounds included.
FAKER_CXX_EXPORT std::string	hexadecimal (unsigned length=1, HexCasing casing=HexCasing::Lower, HexPrefix prefix=HexPrefix::ZeroX)
	Generates a random decimal number in the given range, bounds included.
FAKER_CXX_EXPORT std::string	hexadecimal (std::optional< int > min=std::nullopt, std::optional< int > max=std::nullopt)
	Returns a lowercase hexadecimal number.
FAKER_CXX_EXPORT std::string	octal (unsigned length=1)
	Generates an octal string.
FAKER_CXX_EXPORT std::string	binary (int length=1)
	Generates a binary string of a specified length.
FAKER_CXX_EXPORT std::string	binary (int min, int max)
	Generates a random binary string which has its decimal equivalent between min and max inclusive.
FAKER_CXX_EXPORT std::string	roman (std::optional< int > min=std::nullopt, std::optional< int > max=std::nullopt)
	Returns a roman numeral in String format.

Function Documentation

binary() [1/2]

FAKER_CXX_EXPORT std::string faker::number::binary

(

int

length = 1

)

Generates a binary string of a specified length.

Parameters

length

The number of digits to generate. Defaults to `1`.

Returns

Binary string.

Exceptions

std::invalid_argument,if

length is negative

faker::string::binary(8) // "0b01110101"

binary() [2/2]

FAKER_CXX_EXPORT std::string faker::number::binary	(	int	min,
		int	max )

Generates a random binary string which has its decimal equivalent between min and max inclusive.

Parameters

min	the minimum possible decimal equivalent of the output
max	the maximum possible decimal equivalent of the output

Returns

Binary string.

Exceptions

std::invalid_argument,if

min > max, std::invalid_argument if min or max are negative

faker::string::binary(0, 1024) // "0b10110"

hexadecimal() [1/2]

FAKER_CXX_EXPORT std::string faker::number::hexadecimal	(	std::optional< int >	min = std::nullopt,
		std::optional< int >	max = std::nullopt )

Returns a lowercase hexadecimal number.

Parameters

min	Optional parameter for lower bound of generated number.
max	Optional parameter for upper bound of generated number.

Returns

A lowercase hexadecimal number.

faker::string::hexadecimal() // "b"
faker::string::hexadecimal(0, 255) // "9d"

hexadecimal() [2/2]

FAKER_CXX_EXPORT std::string faker::number::hexadecimal	(	unsigned	length = 1,
		HexCasing	casing = HexCasing::Lower,
		HexPrefix	prefix = HexPrefix::ZeroX )

Generates a random decimal number in the given range, bounds included.

Template Parameters

F	the type of the generated number, must be a floating point type (float, double, long double).

Parameters

min	The minimum value of the range.
max	The maximum value of the range.

Exceptions

std::invalid_argument

if min is greater than max.

Returns

F a random decimal number.

   faker::number::decimal(10.2, 17.7) // 15.6
   @encode
  /
template <std::floating_point F>
F decimal(F min, F max)
{
    if (min > max)
    {
        throw std::invalid_argument("Minimum value must be smaller than maximum value.");
    }
 
    std::mt19937_64& pseudoRandomGenerator = getGenerator();
    std::uniform_real_distribution<F> distribution(min, max);
 
    return distribution(pseudoRandomGenerator);
}

template <std::floating_point F>
F decimal(F max)
{
    return decimal<F>(static_cast<F>(0.), max);
}

 
template <std::floating_point F>
F normalDistribution(F mean, F standardDeviation)
{
    if (standardDeviation < 0 || standardDeviation == INFINITY || mean == INFINITY)
    {
        throw std::invalid_argument("Standard Deviation cannot be negative");
    }
    else if (standardDeviation == 0)
    {
        return mean;
    }
 
    std::mt19937_64& pseudoRandomGenerator = getGenerator();
 
    std::normal_distribution<F> distribution(mean, standardDeviation);
    return distribution(pseudoRandomGenerator);
}

 
template <std::floating_point F>
F normalDistribution(F mean, F standardDeviation, F min, F max)
{
    if (min > max)
    {
        throw std::invalid_argument("min cannot be larger than max");
    }
 
    F sample = normalDistribution(mean, standardDeviation);
 
    if (sample > max)
    {
        sample = max;
    }
    else if (sample < min)
    {
        sample = min;
    }
 
    return sample;
}

integer() [1/2]

template<std::integral I>
requires (sizeof(I) <= sizeof(long long))

I faker::number::integer

(

I

max

)

Generates a random integer between 0 and the given maximum value, bounds included.

Template Parameters

I	the type of the generated number, must be an integral type whose size is not larger than sizeof(long long).

Parameters

max	the maximum value of the range.

Exceptions

std::invalid_argument

if min is greater than max.

See also

integer<I>(I)

Returns

T a random integer number

integer() [2/2]

template<std::integral I>
requires (sizeof(I) <= sizeof(long long))

I faker::number::integer	(	I	min,
		I	max )

Generates a random integer number in the given range, bounds included.

Parameters

min	The minimum value of the range.
max	The maximum value of the range.

Template Parameters

I	the type of the generated number, must be an integral type whose size is not larger than sizeof(long long).

Exceptions

std::invalid_argument

if min is greater than max.

Returns

T a random integer number

octal()

FAKER_CXX_EXPORT std::string faker::number::octal

(

unsigned

length = 1

)

Generates an octal string.

Parameters

length

The number of digits to generate. Defaults to `1`.

Returns

Octal string.

roman()

FAKER_CXX_EXPORT std::string faker::number::roman	(	std::optional< int >	min = std::nullopt,
		std::optional< int >	max = std::nullopt )

Returns a roman numeral in String format.

Parameters

min	Optional parameter for lower bound of generated number.
max	Optional parameter for upper bound of generated number.

Returns

roman number

Exceptions

std::invalid_argument,if	min > max, std::invalid_argument if min or max are negative
std::invalid_argument,if	min<1, value less than 1 cannot be represented
std::invalid_argument,if	max>3999, value greater than 3999 cannot be represented