libsnark::integer_permutation Class Reference

#include <integer_permutation.hpp>

Public Member Functions
	integer_permutation (const size_t size=0)
	integer_permutation (const size_t min_element, const size_t max_element)
	integer_permutation (const integer_permutation &other)=default
integer_permutation &	operator= (const integer_permutation &other)=default
size_t	size () const
bool	operator== (const integer_permutation &other) const
void	set (const size_t position, const size_t value)
size_t	get (const size_t position) const
bool	is_valid () const
integer_permutation	inverse () const
integer_permutation	slice (const size_t slice_min_element, const size_t slice_max_element) const
bool	next_permutation ()
void	random_shuffle ()

Public Attributes
size_t	min_element
size_t	max_element

Detailed Description

Definition at line 22 of file integer_permutation.hpp.

Constructor & Destructor Documentation

integer_permutation() [1/3]

libsnark::integer_permutation::integer_permutation

(

const size_t

size = 0

)

Definition at line 24 of file integer_permutation.cpp.

    : min_element(0), max_element(size - 1)
{
    contents.resize(size);
    std::iota(contents.begin(), contents.end(), 0);
}

Here is the call graph for this function:

integer_permutation() [2/3]

libsnark::integer_permutation::integer_permutation	(	const size_t	min_element,
		const size_t	max_element
	)

Definition at line 31 of file integer_permutation.cpp.

    : min_element(min_element), max_element(max_element)
{
    assert(min_element <= max_element);
    const size_t size = max_element - min_element + 1;
    contents.resize(size);
    std::iota(contents.begin(), contents.end(), min_element);
}

Here is the call graph for this function:

integer_permutation() [3/3]

libsnark::integer_permutation::integer_permutation ( const integer_permutation &  other )

default

Member Function Documentation

get()

size_t libsnark::integer_permutation::get

(

const size_t

position

)

const

Definition at line 60 of file integer_permutation.cpp.

{
    assert(min_element <= position && position <= max_element);
    return contents[position - min_element];
}

Here is the caller graph for this function:

inverse()

integer_permutation libsnark::integer_permutation::inverse

(

)

const

Definition at line 82 of file integer_permutation.cpp.

{
    integer_permutation result(min_element, max_element);
 
    for (size_t position = min_element; position <= max_element; ++position) {
        result.contents[this->contents[position - min_element] - min_element] =
            position;
    }
 
#ifdef DEBUG
    assert(result.is_valid());
#endif
 
    return result;
}

Here is the call graph for this function:

Here is the caller graph for this function:

is_valid()

bool libsnark::integer_permutation::is_valid

(

)

const

Definition at line 66 of file integer_permutation.cpp.

{
    std::unordered_set<size_t> elems;
 
    for (auto &el : contents) {
        if (el < min_element || el > max_element ||
            elems.find(el) != elems.end()) {
            return false;
        }
 
        elems.insert(el);
    }
 
    return true;
}

Here is the caller graph for this function:

next_permutation()

bool libsnark::integer_permutation::next_permutation

(

)

Definition at line 117 of file integer_permutation.cpp.

{
    return std::next_permutation(contents.begin(), contents.end());
}

operator=()

integer_permutation& libsnark::integer_permutation::operator= ( const integer_permutation &  other )

default

operator==()

bool libsnark::integer_permutation::operator==

(

const integer_permutation &

other

)

const

Definition at line 46 of file integer_permutation.cpp.

{
    return (
        this->min_element == other.min_element &&
        this->max_element == other.max_element &&
        this->contents == other.contents);
}

random_shuffle()

void libsnark::integer_permutation::random_shuffle

(

)

Definition at line 122 of file integer_permutation.cpp.

{
    return std::random_shuffle(contents.begin(), contents.end());
}

Here is the caller graph for this function:

set()

void libsnark::integer_permutation::set	(	const size_t	position,
		const size_t	value
	)

Definition at line 54 of file integer_permutation.cpp.

{
    assert(min_element <= position && position <= max_element);
    contents[position - min_element] = value;
}

Here is the caller graph for this function:

size()

size_t libsnark::integer_permutation::size

(

)

const

Definition at line 41 of file integer_permutation.cpp.

{
    return max_element - min_element + 1;
}

Here is the caller graph for this function:

slice()

integer_permutation libsnark::integer_permutation::slice	(	const size_t	slice_min_element,
		const size_t	slice_max_element
	)		const

Definition at line 98 of file integer_permutation.cpp.

{
    assert(
        min_element <= slice_min_element &&
        slice_min_element <= slice_max_element &&
        slice_max_element <= max_element);
    integer_permutation result(slice_min_element, slice_max_element);
    std::copy(
        this->contents.begin() + (slice_min_element - min_element),
        this->contents.begin() + (slice_max_element - min_element) + 1,
        result.contents.begin());
#ifdef DEBUG
    assert(result.is_valid());
#endif
 
    return result;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

max_element

size_t libsnark::integer_permutation::max_element

Definition at line 29 of file integer_permutation.hpp.

min_element

size_t libsnark::integer_permutation::min_element

Definition at line 28 of file integer_permutation.hpp.

---

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

• /home/runner/work/libsnark/libsnark/libsnark/common/data_structures/integer_permutation.hpp
• /home/runner/work/libsnark/libsnark/libsnark/common/data_structures/integer_permutation.cpp