quetzal::coalescence::merger_policy::BinaryMerger Struct Reference

#include <quetzal/coalescence/merger_policy.hpp>

Detailed Description

Discrete generation binary merger.

Defines a policy class to coalesce two nodes selected uniformely at random in a range, with a probability \(1/N\). Its interface makes it exchangeable with the SimultaneousMultipleMerger policy.

Static Public Member Functions
template<class BidirectionalIterator , class T , class BinaryOperation , class Generator >
static auto	merge (BidirectionalIterator first, BidirectionalIterator last, unsigned int N, T init, BinaryOperation const &op, Generator &g)
	merges 2 randomly selected elements in a range.
template<class BidirectionalIterator , class Generator >
static auto	merge (BidirectionalIterator first, BidirectionalIterator last, unsigned int N, Generator &g)
	merges 2 randomly selected elements in a range.

Member Function Documentation

merge() [1/2]

template<class BidirectionalIterator , class Generator >

static auto quetzal::coalescence::merger_policy::BinaryMerger::merge ( BidirectionalIterator  first, BidirectionalIterator  last, unsigned int  N, Generator &  g  )

inlinestatic

merges 2 randomly selected elements in a range.

With a probability \(1/N\), merges 2 elements selected uniformely at random in a range.

Parameters

first	iterator at the begin of the range
last	iterator to the past-the-end element.
N	the number of individuals in the population
g	a random generator that must meet the requirements of UniformRandomBitGenerator concept.

Returns

An iterator to the element that follows the last element of the nodes remaining after coalescence.

Remarks

The function cannot alter the properties of the object containing the range of elements (i.e., it cannot alter the size of an array or a container): signaling the new size of the shortened range is done by returning an iterator to the element that should be considered its new past-the-end element. The range between first and this iterator includes all the remaining nodes in the sequence.

the type T BidirectionalIterator::value_type must be defined.

the T default constructor is used to set the value at which the parent is initialized.

With a and b two objects of type T, the expression a + B must be defined.

BidirectionalIterator must meet the requirements of ValueSwappable and RandomAccessIterator.

merge() [2/2]

template<class BidirectionalIterator , class T , class BinaryOperation , class Generator >

static auto quetzal::coalescence::merger_policy::BinaryMerger::merge ( BidirectionalIterator  first, BidirectionalIterator  last, unsigned int  N, T  init, BinaryOperation const &  op, Generator &  g  )

inlinestatic

merges 2 randomly selected elements in a range.

With a probability \(1/N\), merges 2 elements selected uniformely at random in a range.

Parameters

first	iterator at the begin of the range
last	iterator to the past-the-end element.
N	the number of individuals in the population
init	the value at which parent is initialized
op	binary operation function object that will be applied for branching a child to its parent. The binary operator takes the parent value (initialized to init) and the value of the child as parameters. The signature of the function should be equivalent to the following: Ret fun(const Type1 &parent, const Type2 &child);
g	a random generator that must meet the requirements of UniformRandomBitGenerator concept.

Returns

An iterator to the element that follows the last element of the nodes remaining after coalescence.

Remarks

The function cannot alter the properties of the object containing the range of elements (i.e., it cannot alter the size of an array or a container): signaling the new size of the shortened range is done by returning an iterator to the element that should be considered its new past-the-end element. The range between first and this iterator includes all the remaining nodes in the sequence.

BidirectionalIterator must meet the requirements of ValueSwappable and RandomAccessIterator.

---

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

• /home/runner/work/quetzal-CoaTL/quetzal-CoaTL/src/include/quetzal/coalescence/merger_policy.hpp