tgen::permutation::value

Permutation value. More...

Inheritance diagram for tgen::permutation::value:

Public Member Functions
	value (const std::vector< int > &vec)
	Creates a permutation value from a std::vector.
int	size () const
	Returns the size of the permutation value.
const int &	operator[] (int idx) const
	Returns the image at some position of the permutation.
int	parity () const
	Parity of the permutation.
value &	sort ()
	Sorts the permutation in non-decreasing order.
value &	reverse ()
	Reverses the permutation.
value &	inverse ()
	Inverse of the permutation.
value &	separator (char sep)
	Sets separator for printing.
value &	add_1 ()
	Adds 1 for printing.
value &	shuffle ()
	Shuffles the permutation.
int	pick () const
	Returns a uniformly random element.
template<typename Dist>
int	pick_by_distribution (const std::vector< Dist > &distribution) const
	Returns a random element from the permutation with given probabilities.
std::vector< int >	to_std () const
	Converts the permutation to a std::vector.
Public Member Functions inherited from tgen::gen_value_base< value >
bool	operator< (const value &rhs) const

Friends
std::ostream &	operator<< (std::ostream &out, const value &val)
	Prints the permutation to an output stream.

Detailed Description

Permutation value.

It can be printed through std::cout.

Definition at line 2227 of file tgen.h.

Constructor & Destructor Documentation

value()

tgen::permutation::value::value ( const std::vector< int > & vec )

inline

Creates a permutation value from a std::vector.

Parameters

vec	The std::vector representing the permutation.

Examples

// Creates and prints a permutation from a std::vector.
std::vector<int> v = {0, 1, 2};
tgen::permutation::value val(v);
std::cout << val << std::endl; // Prints "0 1 2".
 
// Also works with conversions, and std::initializer_list<T>.
val = {1, 0};
std::cout << val.add_1() << std::endl; // Prints "2 1".

Definition at line 2235 of file tgen.h.

Member Function Documentation

add_1()

value & tgen::permutation::value::add_1 ( )

inline

Adds 1 for printing.

This makes it so, when given to std::cout, the permutation will be printed as 1-based.

Complexity

O(1).

Examples

// Prints a 1-based permutation.
tgen::permutation::value val = {2, 0, 1};
std::cout << val.add_1() << std::endl; // Prints "3 1 2".

Definition at line 2312 of file tgen.h.

inverse()

value & tgen::permutation::value::inverse ( )

inline

Inverse of the permutation.

The inverse of the permutation p is another pi such that pi[p[i]] = p[pi[i]] = i.

Complexity

O(n).

Examples

// Prints inverse of permutation.
tgen::permutation::value val = {2, 0, 1};
std::cout << val.inverse() << std::endl; // Prints "1 2 0".

Definition at line 2295 of file tgen.h.

operator[]()

const int & tgen::permutation::value::operator[] ( int idx ) const

inline

Returns the image at some position of the permutation.

Parameters

idx	Index to be accessed.

Returns

The element at index idx.

Examples

// Prints a position of a permutation.
tgen::permutation::value val = {2, 0, 1};
std::cout << val[1] << std::endl; // Prints "0".

Definition at line 2256 of file tgen.h.

parity()

int tgen::permutation::value::parity ( ) const

inline

Parity of the permutation.

Returns

+1 if the permutation is even, or -1 if the permutation is odd.

Examples

// Prints parity of permutation.
tgen::permutation::value val = {2, 0, 1};
std::cout << val.parity() << std::endl; // Prints "1".

Definition at line 2264 of file tgen.h.

pick()

int tgen::permutation::value::pick ( ) const

inline

Returns a uniformly random element.

Returns

A uniformly random element from the permutation.

Complexity

O(1).

Examples

tgen::permutation::value val = {2, 0, 1};
std::cout << val.pick() << std::endl;

Definition at line 2327 of file tgen.h.

pick_by_distribution()

template<typename Dist>

int tgen::permutation::value::pick_by_distribution ( const std::vector< Dist > & distribution ) const

inline

Returns a random element from the permutation with given probabilities.

Parameters

distribution

Probability distribution.

Returns

A random element from the permutation, chosen with probability proportional to distribution.

Warning

For integral Dist, assumes that the sum of distribution fits in type unsigned __int128.

Complexity

O(1).

Examples

tgen::permutation::value val = {2, 0, 1};
std::cout << val.pick_by_distribution({1, 2, 3}) << std::endl;

Definition at line 2332 of file tgen.h.

reverse()

value & tgen::permutation::value::reverse ( )

inline

Reverses the permutation.

Complexity

O(n).

Examples

// Reverses and prints a permutation.
tgen::permutation::value val = {2, 0, 1};
std::cout << val.reverse() << std::endl; // Prints "1 0 2".

Definition at line 2288 of file tgen.h.

separator()

value & tgen::permutation::value::separator ( char sep )

inline

Sets separator for printing.

Complexity

O(1).

Examples

// Prints a permutation, separated by commas.
tgen::permutation::value val = {2, 0, 1};
std::cout << val.separator(',') << std::endl; // Prints "2,0,1".

Definition at line 2305 of file tgen.h.

shuffle()

value & tgen::permutation::value::shuffle ( )

inline

Shuffles the permutation.

Complexity

O(n).

Examples

tgen::permutation::value val = {2, 0, 1};
std::cout << val.shuffle() << std::endl;

Definition at line 2319 of file tgen.h.

size()

int tgen::permutation::value::size ( ) const

inline

Returns the size of the permutation value.

Returns

The size (number of elements) of the permutation value.

Examples

// Prints the size of a permutation.
tgen::permutation::value val = {0, 1, 2};
std::cout << val.size() << std::endl; // Prints "3".

Definition at line 2253 of file tgen.h.

sort()

value & tgen::permutation::value::sort ( )

inline

Sorts the permutation in non-decreasing order.

Complexity

O(n).

Examples

// Sorts and prints a permutation.
tgen::permutation::value val = {2, 0, 1};
std::cout << val.sort() << std::endl; // Prints "0 1 2".

Definition at line 2280 of file tgen.h.

to_std()

std::vector< int > tgen::permutation::value::to_std ( ) const

inline

Converts the permutation to a std::vector.

Returns

A std::vector representing the permutation.

Examples

// Convoluted way to reverse a permutation.
std::vector<int> v = {2, 0, 1};
v = tgen::permutation::value(v).reverse().to_std();
// v = {2, 1, 3}.

Definition at line 2354 of file tgen.h.

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream & out, const value & val )

friend

Prints the permutation to an output stream.

The entries are printed with one space as a separator by default, and with no end of line.

Examples

// Prints a permutation.
std::cout << tgen::permutation::value({2, 0, 1}) << std::endl; // Prints "2 0 1".

Definition at line 2344 of file tgen.h.

---

The documentation for this struct was generated from the following files:

• /home/runner/work/tgen/tgen/single_include/tgen.h
• permutation.dox