Generator Value Operations

Operations for tgen generator values. More...

Collaboration diagram for Generator Value Operations:

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

Detailed Description

Operations for tgen generator values.

Examples

// Shuffles and prints a value.
tgen::list<int>::value inst = {3, 1, 2};
std::cout << tgen::shuffled(inst) << std::endl;
 
// Prints a random element from inst.
std::cout << tgen::pick(inst) << std::endl;

Function Documentation

choose()

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

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

Chooses some values from the list value, as in a sublist of fixed length.

Template Parameters

Inst	List value type, deduced automatically. Must be a tgen::list::value.

Parameters

inst	The original value.
k	The size of the sublist.

Returns

A uniformly random subsequence of length k.

Complexity

O(|inst|).

Examples

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

Definition at line 772 of file tgen.h.

pick()

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

Inst::value_type tgen::pick

(

const Inst &

inst

)

Choses a random element from the list value.

Template Parameters

Inst	List value type, deduced automatically. Must be a tgen::list::value.

Parameters

inst	The original value.

Returns

A uniformly random element from the value.

Complexity

O(1).

Examples

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

Definition at line 691 of file tgen.h.

pick_by_distribution()

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

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

Choses a random element from the list value.

Template Parameters

Inst	List value type, deduced automatically. Must be a tgen::list::value.

Parameters

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

Returns

A uniformly random element from the value.

Complexity

O(1).

Examples

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

Definition at line 731 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 list value.

Template Parameters

Inst	List value type, deduced automatically. Must be a tgen::list::value.

Parameters

inst	The value to shuffle.

Complexity

O(|inst|).

Examples

// Shuffles a value.
tgen::list<int>::value inst = {3, 1, 2};
tgen::shuffle(inst);

Definition at line 635 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 list value.

Template Parameters

Inst	List value type, deduced automatically. Must be a tgen::list::value.

Parameters

inst	The original value.

Returns

The shuffled value.

Complexity

O(|inst|).

Examples

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

Definition at line 663 of file tgen.h.