Binary query modifier which performs a xor between at least two queryables. More...

#include <Xor.hpp>

Inheritance diagram for ecstasy::query::modifier::XorImpl< AutoLock, Q1, Q2, Qs >:

[legend]

Collaboration diagram for ecstasy::query::modifier::XorImpl< AutoLock, Q1, Q2, Qs >:

[legend]

Public Member Functions
	XorImpl (Q1 &firstOperand, Q2 &secondOperand, Qs &...otherOperands)
	Construct a new Xor Queryable modifier.

template<size_t operandId>
ModifierClass::template OperandData< operandId >	getOperandData (size_t index)
	Get a std::optional filled with the data of the specified operand at index `index` if existing.

void	reloadMask ()
	Update the mask to be up to date with the operands bitmasks.

Public Member Functions inherited from ecstasy::query::modifier::BinaryModifier< XorImpl< AutoLock, Q1, Q2, Qs... >, AutoLock, util::meta::add_optional, Q1, Q2, Qs... >
	BinaryModifier (Q1 &firstOperand, Q2 &secondOperand, Qs &...otherOperands)
	Construct a new binary query modifier.

constexpr const util::BitSet &	getMask () const noexcept
	Get the Mask of the internal queryables.

QueryData	getQueryData (size_t index)
	Get the operands data at the given index.

Public Member Functions inherited from ecstasy::query::modifier::Modifier< AutoLock >
virtual	~Modifier ()=default
	Destroy the modifier base object.

Public Member Functions inherited from ecstasy::query::modifier::ModifierBase
virtual	~ModifierBase ()=default
	Destroy the modifier base object.

Private Types
using	ModifierClass = BinaryModifier< XorImpl< AutoLock, Q1, Q2, Qs... >, AutoLock, util::meta::add_optional, Q1, Q2, Qs... >
	Helper type for the base class.

Private Member Functions
void	combineMask (const util::BitSet &mask)
	Combine the current bitmask with the given one.

template<size_t... ints>
void	combineOperandMasks (std::integer_sequence< size_t, ints... > int_seq)
	Combine all the operands' bitmasks.

Additional Inherited Members
Public Types inherited from ecstasy::query::modifier::BinaryModifier< XorImpl< AutoLock, Q1, Q2, Qs... >, AutoLock, util::meta::add_optional, Q1, Q2, Qs... >
using	Operands = util::meta::Traits< Q1, Q2, Qs... >
	Modifier constraint.

using	Internal = std::tuple< queryable_qualifiers_t< Q1, AutoLock >, queryable_qualifiers_t< Q2, AutoLock >, queryable_qualifiers_t< Qs, AutoLock >... >

using	QueryData = std::tuple< typename util::meta::add_optional< typename Q1::QueryData >::type, typename util::meta::add_optional< typename Q2::QueryData >::type, typename util::meta::add_optional< typename Qs::QueryData >::type... >
	Queryable constaint.

using	OperandData = std::tuple_element_t< operandId, QueryData >
	QueryData for the given operand.

Protected Member Functions inherited from ecstasy::query::modifier::BinaryModifier< XorImpl< AutoLock, Q1, Q2, Qs... >, AutoLock, util::meta::add_optional, Q1, Q2, Qs... >
QueryData	getQueryData (size_t index, std::integer_sequence< size_t, ints... > int_seq)
	Get the query data.

OperandData< operandId >	getDerivedOperandData (size_t index)

Protected Attributes inherited from ecstasy::query::modifier::BinaryModifier< XorImpl< AutoLock, Q1, Q2, Qs... >, AutoLock, util::meta::add_optional, Q1, Q2, Qs... >
Internal	_operands
	Tuple containing the queryables.

util::BitSet	_mask
	Mask of the queryables.

Detailed Description

template<bool AutoLock, Queryable Q1, Queryable Q2, Queryable... Qs>
class ecstasy::query::modifier::XorImpl< AutoLock, Q1, Q2, Qs >

Binary query modifier which performs a xor between at least two queryables.

Note: The mask is the result of the operation: Q1 ^ Q2 ^ Qs...

Warning: Since the mask of multiple operands is (Q1 ^ Q2) ^ Qs..., it is true when an odd number of operands match a given id.

Template Parameters

AutoLock	Lock the Lockable queryables if true.
Q1	Left operand queryable type.
Q2	Right operand queryable type.
Qs	Additional operand queryable types.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2022-10-27)

Definition at line 37 of file Xor.hpp.

Member Typedef Documentation

◆ ModifierClass

template<bool AutoLock, Queryable Q1, Queryable Q2, Queryable... Qs>

using ecstasy::query::modifier::XorImpl< AutoLock, Q1, Q2, Qs >::ModifierClass = BinaryModifier<XorImpl<AutoLock, Q1, Q2, Qs...>, AutoLock, util::meta::add_optional, Q1, Q2, Qs...>

private

Helper type for the base class.

Definition at line 40 of file Xor.hpp.

Constructor & Destructor Documentation

◆ XorImpl()

template<bool AutoLock, Queryable Q1, Queryable Q2, Queryable... Qs>

ecstasy::query::modifier::XorImpl< AutoLock, Q1, Q2, Qs >::XorImpl	(	Q1 &	firstOperand,
		Q2 &	secondOperand,
		Qs &...	otherOperands
	)

inline

Construct a new Xor Queryable modifier.

Parameters

[in]	firstOperand	left queryable operand.
[in]	secondOperand	right queryable operand.
[in]	otherOperands	additional operands (optional).

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2022-10-27)

Definition at line 54 of file Xor.hpp.

            : ModifierClass(firstOperand, secondOperand, otherOperands...)
        {
        }

Member Function Documentation

◆ combineMask()

template<bool AutoLock, Queryable Q1, Queryable Q2, Queryable... Qs>

void ecstasy::query::modifier::XorImpl< AutoLock, Q1, Q2, Qs >::combineMask ( const util::BitSet & mask )

inlineprivate

Combine the current bitmask with the given one.

Parameters

[in] mask Evaluated bitmask.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2022-11-21)

Definition at line 116 of file Xor.hpp.

        {
            if (this->_mask.size() < mask.size())
                this->_mask = util::BitSet(mask).inplaceXor(this->_mask);
            else
                this->_mask.inplaceXor(mask);
        }

◆ combineOperandMasks()

template<bool AutoLock, Queryable Q1, Queryable Q2, Queryable... Qs>

template<size_t... ints>

void ecstasy::query::modifier::XorImpl< AutoLock, Q1, Q2, Qs >::combineOperandMasks ( std::integer_sequence< size_t, ints... > int_seq )

inlineprivate

Combine all the operands' bitmasks.

Template Parameters

ints	Sequence values.

Parameters

[in] int_seq Sequence containing the queryable ids.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2022-11-21)

Definition at line 135 of file Xor.hpp.

        {
            (void)int_seq;
            this->_mask = getQueryableMask(std::get<0>(this->_operands));
            combineMask(getQueryableMask(std::get<1>(this->_operands)));
            std::ignore = std::make_tuple((combineMask(getQueryableMask(std::get<ints + 2>(this->_operands))), 0)...);
        }

◆ getOperandData()

template<bool AutoLock, Queryable Q1, Queryable Q2, Queryable... Qs>

template<size_t operandId>

ModifierClass::template OperandData< operandId > ecstasy::query::modifier::XorImpl< AutoLock, Q1, Q2, Qs >::getOperandData ( size_t index )

inline

Get a std::optional filled with the data of the specified operand at index index if existing.

Warning: May throw exceptions, look at the specified operand type equivalent method documentation.

Template Parameters

operandId Id of the operand (where 0 is Q1, 1 is Q2...).

Parameters

[in] index Index of the entity.

Returns: auto A std::optional filled with the resulting operand data at index index if existing.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2022-10-27)

Definition at line 74 of file Xor.hpp.

        {
            auto &operand = std::get<operandId>(this->_operands);
 
            if (index < getQueryableMask(operand).size() && getQueryableMask(operand)[index])
                return getQueryableData(operand, index);
            return std::nullopt;
        }

◆ reloadMask()

template<bool AutoLock, Queryable Q1, Queryable Q2, Queryable... Qs>

void ecstasy::query::modifier::XorImpl< AutoLock, Q1, Q2, Qs >::reloadMask ( )

inline

Update the mask to be up to date with the operands bitmasks.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2022-10-27)

Definition at line 89 of file Xor.hpp.

        {
            if constexpr (sizeof...(Qs) > 0)
                combineOperandMasks(std::make_index_sequence<(sizeof...(Qs))>());
            else {
                auto &leftOperand = std::get<0>(this->_operands);
                auto &rightOperand = std::get<1>(this->_operands);
 
                if (getQueryableMask(leftOperand).size() > getQueryableMask(rightOperand).size()) {
                    this->_mask = getQueryableMask(leftOperand);
                    this->_mask.inplaceXor(getQueryableMask(rightOperand));
                } else {
                    this->_mask = getQueryableMask(rightOperand);
                    this->_mask.inplaceXor(getQueryableMask(leftOperand));
                }
            }
        }

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

src/ecstasy/query/modifiers/Xor.hpp

Public Member Functions

Private Types

Private Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ModifierClass

Constructor & Destructor Documentation

◆ XorImpl()

Member Function Documentation

◆ combineMask()

◆ combineOperandMasks()

◆ getOperandData()

◆ reloadMask()