Generator Instance Operations

Operations for tgen generator instances. More...

Collaboration diagram for Generator Instance Operations:

Functions
template<typename Inst, std::enable_if_t< is_sequential< Inst >::value, int > = 0>
void	tgen::shuffle (Inst &inst)
	Shuffles a sequence instance.
template<typename Inst, std::enable_if_t< is_sequential< Inst >::value, int > = 0>
Inst	tgen::shuffled (const Inst &inst)
	Shuffles a sequence instance.
template<typename Inst, std::enable_if_t< is_sequential< Inst >::value, int > = 0>
Inst::value_type	tgen::any (const Inst &inst)
	Choses a random element from the sequence instance.
template<typename Inst, typename T, std::enable_if_t< is_sequential< Inst >::value, int > = 0>
Inst::value_type	tgen::any_by_distribution (const Inst &inst, const std::vector< T > &distribution)
	Choses a random element from the sequence instance.
template<typename Inst, std::enable_if_t< is_sequential< Inst >::value and has_subset_defined< Inst >::value, int > = 0>
Inst	tgen::choose (int k, const Inst &inst)
	Chooses some values from the sequence instance, as in a subsequence of fixed length.

Detailed Description

Operations for tgen generator instances.

Examples

Function Documentation

any()

template<typename Inst, std::enable_if_t< is_sequential< Inst >::value, int > = 0>

Inst::value_type tgen::any

(

const Inst &

inst

)

Choses a random element from the sequence instance.

Template Parameters

Inst	Sequence instance type, deduced automatically. Must be a tgen::sequence::instance.

Parameters

inst	The original instance.

Returns

A uniformly random element from the instance.

Complexity

O(1).

Examples

// Prints a random element from v.
tgen::sequence<int>::instance inst = {3, 1, 2};
std::cout << tgen::any(inst) << std::endl;

Definition at line 645 of file tgen.h.

any_by_distribution()

template<typename Inst, typename T, std::enable_if_t< is_sequential< Inst >::value, int > = 0>

Inst::value_type tgen::any_by_distribution	(	const Inst &	inst,
		const std::vector< T > &	distribution )

Choses a random element from the sequence instance.

Template Parameters

Inst	Sequence instance type, deduced automatically. Must be a tgen::sequence::instance.

Parameters

inst	The instance to choose from.
distribution	The probability distribution.

Returns

A uniformly random element from the instance.

Complexity

O(1).

Examples

// Prints a random element from instance with given odds.
tgen::sequence<int>::instance inst = {3, 1, 2};
std::cout << tgen::any_by_distribution(inst, {1, 2, 3}) << std::endl;

Definition at line 685 of file tgen.h.

choose()

template<typename Inst, std::enable_if_t< is_sequential< Inst >::value and has_subset_defined< Inst >::value, int > = 0>

Inst tgen::choose	(	int	k,
		const Inst &	inst )

Chooses some values from the sequence instance, as in a subsequence of fixed length.

Template Parameters

Inst	Sequence instance type, deduced automatically. Must be a tgen::sequence::instance.

Parameters

k	The size of the subsequence.
inst	The original instance.

Returns

A uniformly random subsequence of length k.

Complexity

O(|inst|).

Examples

// Prints a subsequenec of length 2 from v.
tgen::sequence<int>::instance inst = {3, 1, 2};
std::cout << tgen::choose(2, inst) << std::endl;

Definition at line 727 of file tgen.h.

shuffle()

template<typename Inst, std::enable_if_t< is_sequential< Inst >::value, int > = 0>

void tgen::shuffle

(

Inst &

inst

)

Shuffles a sequence instance.

Template Parameters

Inst	Sequence instance type, deduced automatically. Must be a tgen::sequence::instance.

Parameters

inst	The instance to shuffle.

Complexity

O(|inst|).

Examples

// Shuffles and prints an instance.
tgen::sequence<int>::instance inst = {3, 1, 2};
tgen::shuffle(inst);

Definition at line 587 of file tgen.h.

shuffled()

template<typename Inst, std::enable_if_t< is_sequential< Inst >::value, int > = 0>

Inst tgen::shuffled ( const Inst & inst )

nodiscard

Shuffles a sequence instance.

Template Parameters

Inst	Sequence instance type, deduced automatically. Must be a tgen::sequence::instance.

Parameters

inst	The original instance.

Returns

The shuffled instance.

Complexity

O(|inst|).

Examples

// Shuffles and prints an instance.
tgen::sequence<int>::instance inst = {3, 1, 2};
std::cout << tgen::shuffled(inst) << std::endl;

Definition at line 616 of file tgen.h.