Random generation of arrangements of any graph. More...

#include <rand_arrangements.hpp>

Public Member Functions
	rand_arrangements (const lal::graphs::graph &g, uint64_t seed=0) noexcept
	Constructor with graph. More...

	rand_arrangements (uint64_t n, uint64_t seed=0) noexcept
	Constructor with number of vertices. More...

const linear_arrangement &	get_arrangement () noexcept
	Returns a linear arrangement constructed uniformly at random.

const linear_arrangement &	yield_arrangement () noexcept
	Returns a linear arrangement constructed uniformly at random.

Private Attributes
const uint64_t	m_n
	Number of vertices.

std::mt19937	m_gen
	Random number generator.

linear_arrangement	m_arr
	The arrangement generated by this class. More...

Detailed Description

Random generation of arrangements of any graph.

This class generates linear arrangements uniformly at random. Unlike other random generators (e.g., lal::generate::rand_projective_arrangements) The arrangements are not generatee

This class is a wrapper over the C++'s std::shuffle algorithm.

A possible usage of this class is the following:

// given a tree T (or any other graph)
lal::generate::rand_arrangements Gen(T);
for (int i = 0; i < 100; ++i) {
    const linear_arrangement arr = Gen.get_arrangement();
    // ...
}

Equivalently,

// given a tree T (or any other graph)
lal::generate::rand_arrangements Gen(T);
for (int i = 0; i < 100; ++i) {
    const linear_arrangement arr = Gen.yield_arrangement();
    // ...
}

Constructor & Destructor Documentation

◆ rand_arrangements() [1/2]

lal::generate::rand_arrangements::rand_arrangements	(	const lal::graphs::graph &	g,
		uint64_t	seed = `0`
	)

inlinenoexcept

Constructor with graph.

Parameters

g	Input graph. Only its number of vertices is used.
seed	Seed of the random number generator. When 0, a random seed is used.

◆ rand_arrangements() [2/2]

lal::generate::rand_arrangements::rand_arrangements	(	uint64_t	n,
		uint64_t	seed = `0`
	)

inlinenoexcept

Constructor with number of vertices.

Parameters

n	Number of vertices of the arrangements.
seed	Seed of the random number generator. When 0, a random seed is used.

Member Data Documentation

◆ m_arr

linear_arrangement lal::generate::rand_arrangements::m_arr

private

The arrangement generated by this class.

Actually, generated by the std::next_permutation algorithm.

The documentation for this class was generated from the following file:

lal/generate/rand_arrangements.hpp