Core class holding, as a boost dynamic bitset, which theme attributes are part of a mask. More...

#include <FMTMask.h>

Public Member Functions
	FMTMask (FMTMask &&rhs) noexcept
	Move copy constructor.

FMTMask &	operator= (FMTMask &&rhs) noexcept
	Move assignment operator for FMTMask.

void	swap (FMTMask &rhs)
	Swap this mask with another.

	FMTMask ()
	Default constructor for FMTMask.

	FMTMask (const FMTMask &rhs)
	Copy constructor for FMTMask.

virtual	~FMTMask ()=default
	Default virtual destructor for FMTMask.

	FMTMask (const boost::dynamic_bitset< uint8_t > &bits)
	Construct a mask setting only the bitset data member.

	operator bool () const
	Return true if the mask is not empty by looking at the data bitset.

	FMTMask (const std::string &mask, const boost::dynamic_bitset< uint8_t > &bits)
	Construct a mask from an already set bitset and a string mask used as name.

	FMTMask (const std::string &mask, const std::vector< FMTTheme > &themes)
	Construct a complete mask from a string and sorted themes.

	FMTMask (const std::vector< std::string > &values, const std::vector< FMTTheme > &themes)
	Construct a mask from a vector of attribute strings and sorted themes.

	FMTMask (const std::vector< FMTTheme > &themes)
	Construct an empty mask sized for the given themes.

void	clear ()
	Clear the data and name members.

size_t	size () const
	Return the size of the bitset data member.

size_t	count () const
	Return the number of bits set.

std::string	get (const std::vector< FMTTheme > &themes) const
	Get the string mask name based on the bitset data and sorted themes.

std::string	get (const FMTTheme &theme) const
	Get the attribute of the mask for a given theme.

const std::string &	getAttribute (const FMTTheme &p_theme) const
	When you deal with FMTDevelopment you can directly call this to get a reference to the attribute string.

size_t	getSubsetCount (const FMTTheme &theme) const
	Return the number of bits set for the given theme subset.

void	set (const std::vector< FMTTheme > &themes, const std::string &value)
	Set the bitset data for some themes from a mask string.

void	setExclusiveBits (const FMTMask &p_mask, const FMTTheme &p_theme)
	Flip only the theme subset and clear the mask of the intersection with another mask.

std::vector< size_t >	getNonFullBlocks () const
	Return the indexes of the blocks that contain a 0.

bool	isSubsetOf (const FMTMask &p_mask, const std::vector< size_t > &p_subset) const
	Check if this mask is a subset of another mask by looking at a block subset.

void	set (const FMTTheme &theme, const std::string &value)
	Set the bitset data for a given theme from an attribute.

std::vector< const Core::FMTTheme * >	getStaticThemes (const std::vector< const Core::FMTTheme * > &themes) const
	Return the themes that only use aggregates or a question mark for the mask.

std::vector< const Core::FMTTheme * >	getSelectedThemes (const std::vector< Core::FMTTheme > &themes) const
	Return the themes that have any bit set in the mask.

bool	isNotThemesSubset (const FMTMask &rhs, const std::vector< const Core::FMTTheme * > &themes) const
	Return true if this mask is not part of rhs based on the sorted themes.

bool	isNotThemesSubset (const FMTMask &rhs, const std::vector< Core::FMTTheme > &themes) const
	Return true if this mask is not part of rhs based on the sorted themes.

FMTMask	removeAggregates (const std::vector< FMTTheme > &themes, bool questionmarkonly=false) const
	Return a new mask with the bits of aggregates or question marks unset for the given themes.

bool	empty () const
	Return true if the data member is empty.

void	update (const std::vector< FMTTheme > &themes)
	Update the name member from the bitset data using a sorted list of themes.

std::vector< FMTMask >	decompose (const FMTTheme &theme) const
	Disaggregate the attribute of a theme from the mask into a vector of masks, one per possible attribute.

void	append (const boost::dynamic_bitset< uint8_t > &bits)
	Append a bitset to the bitset data member of the mask.

template<class typetobinarize >
void	binarizedAppend (const typetobinarize &element)
	Binarize an element and append it to the mask.

void	unionWith (const FMTMask &rhs)
	Performs an in-place union with another mask.

FMTMask	getUnion (const FMTMask &rhs) const
	Return the union of this mask and another mask.

FMTMask	getIntersect (const FMTMask &rhs) const
	Return the intersection of this mask and another mask.

void	setIntersect (const FMTMask &rhs)
	set the intersect with this mask using rhs mask.

boost::dynamic_bitset< uint8_t >	getBitsetIntersect (const FMTMask &rhs) const
	Return the bitset of the intersection of this mask and another mask.

FMTMask &	operator= (const FMTMask &rhs)
	Copy assignment operator for FMTMask.

bool	operator!= (const FMTMask &rhs) const
	Inequality comparison operator of FMTMask.

bool	operator== (const FMTMask &rhs) const
	Equality comparison operator of FMTMask.

bool	operator< (const FMTMask &rhs) const
	Less than comparison operator of FMTMask.

FMTMask	resume (const boost::dynamic_bitset< uint8_t > &rhs) const
	Return a mask with the selected name and data using a bitset.

FMTMask	resume (const std::vector< size_t > &indexes) const
	Return a mask with the selected name and data using mask indexes.

size_t	hash () const
	Return the hash of the mask.

std::string	getBitsString () const
	Return the binary representation of the bitset as a string.

	operator std::string () const
	Return the name of the mask.

bool	isSubsetOf (const FMTMask &p_rhs) const
	Check if this mask is a subset of another mask.

const boost::dynamic_bitset< uint8_t > &	getBitsetReference () const
	Return a const reference to the bitset data member.

const std::string &	getStringReference () const
	Return a const reference to the name string member.

void	reserve (size_t p_size)
	reserve memory for the boost dynamicbitset.

FMTMask	refine (const FMTMask &mask, const std::vector< FMTTheme > &themes) const
	Return a new mask where the question marks are completed with the attributes of another mask.

FMTMask	getPostSolveMask (const FMTMask &mask, const std::vector< FMTTheme > &themes) const
	Turn off the bits of themes that are still active on a base postsolve mask.

FMTMask	preSolve (const FMTMaskFilter &filter, const std::vector< FMTTheme > &presolvedthemes) const
	Return a presolved mask with potentially less data using a filter and a subset of the original themes.

void	preSolveRef (const FMTMaskFilter &p_filter, const std::vector< FMTTheme > &p_presolvedThemes, bool p_allowReallocation=true)
	Presolve this mask in place with potentially less data using a filter and a subset of the original themes.

bool	canPreSolve (const FMTMaskFilter &p_filter, const std::vector< FMTTheme > &p_presolvedThemes) const
	Return true if the mask can be presolved with the given filter and themes.

FMTMask	postSolve (const FMTMaskFilter &filter, const std::vector< FMTTheme > &basethemes) const
	Return a postsolved mask using a filter and the original themes.

template<>
void	binarizedAppend (const double &element)

Friends
class	FMTTheme

class	boost::serialization::access
	Serialize the FMTMask for multiprocessing across multiple cpus (pickle in Python).

Detailed Description

Core class holding, as a boost dynamic bitset, which theme attributes are part of a mask.

A set bit means the attribute of a given theme is part of the mask; the data size equals the sum of the theme sizes. The name member holds the attribute values as a string. Multiple bits set for a theme mean the mask contains an aggregate or a question mark.

Constructor & Destructor Documentation

◆ FMTMask() [1/8]

Core::FMTMask::FMTMask ( FMTMask && rhs )

noexcept

Move copy constructor.

Parameters

[in] rhs development to swap

◆ FMTMask() [2/8]

Core::FMTMask::FMTMask ( )

Default constructor for FMTMask.

◆ FMTMask() [3/8]

Core::FMTMask::FMTMask ( const FMTMask & rhs )

Copy constructor for FMTMask.

Parameters

[in] rhs the FMTMask to copy.

◆ ~FMTMask()

virtual Core::FMTMask::~FMTMask ( )

virtualdefault

Default virtual destructor for FMTMask.

◆ FMTMask() [4/8]

Core::FMTMask::FMTMask ( const boost::dynamic_bitset< uint8_t > & bits )

Construct a mask setting only the bitset data member.

Parameters

[in] bits the bitset data.

◆ FMTMask() [5/8]

Core::FMTMask::FMTMask	(	const std::string &	mask,
		const boost::dynamic_bitset< uint8_t > &	bits
	)

Construct a mask from an already set bitset and a string mask used as name.

Parameters

[in]	mask	the string mask used as name.
[in]	bits	the bitset data.

◆ FMTMask() [6/8]

Core::FMTMask::FMTMask	(	const std::string &	mask,
		const std::vector< FMTTheme > &	themes
	)

Construct a complete mask from a string and sorted themes.

Parameters

[in]	mask	the string mask.
[in]	themes	the sorted themes.

◆ FMTMask() [7/8]

Core::FMTMask::FMTMask	(	const std::vector< std::string > &	values,
		const std::vector< FMTTheme > &	themes
	)

Construct a mask from a vector of attribute strings and sorted themes.

Parameters

[in]	values	the attribute strings.
[in]	themes	the sorted themes.

◆ FMTMask() [8/8]

Core::FMTMask::FMTMask ( const std::vector< FMTTheme > & themes )

Construct an empty mask sized for the given themes.

Parameters

[in] themes the sorted themes.

Member Function Documentation

◆ append()

void Core::FMTMask::append ( const boost::dynamic_bitset< uint8_t > & bits )

Append a bitset to the bitset data member of the mask.

Parameters

[in] bits the bitset to append.

◆ binarizedAppend() [1/2]

template<>

void Core::FMTMask::binarizedAppend ( const double & element )

inline

◆ binarizedAppend() [2/2]

template<class typetobinarize >

void Core::FMTMask::binarizedAppend ( const typetobinarize & element )

inline

Binarize an element and append it to the mask.

Template Parameters

typetobinarize the type of the element.

Parameters

[in] element the element to binarize and append.

◆ canPreSolve()

bool Core::FMTMask::canPreSolve	(	const FMTMaskFilter &	p_filter,
		const std::vector< FMTTheme > &	p_presolvedThemes
	)		const

Return true if the mask can be presolved with the given filter and themes.

Parameters

[in]	p_filter	the mask filter.
[in]	p_presolvedThemes	the presolved themes.

Returns: true if the mask can be presolved else false.

◆ clear()

void Core::FMTMask::clear ( )

Clear the data and name members.

◆ count()

size_t Core::FMTMask::count ( ) const

Return the number of bits set.

Returns: the number of bits set.

◆ decompose()

std::vector< FMTMask > Core::FMTMask::decompose ( const FMTTheme & theme ) const

Disaggregate the attribute of a theme from the mask into a vector of masks, one per possible attribute.

Parameters

[in] theme the theme to decompose.

Returns: a vector of masks, one per possible attribute.

◆ empty()

bool Core::FMTMask::empty ( ) const

Return true if the data member is empty.

Returns: true if the mask is empty else false.

◆ get() [1/2]

std::string Core::FMTMask::get ( const FMTTheme & theme ) const

Get the attribute of the mask for a given theme.

Parameters

[in] theme the theme.

Returns: the attribute of the theme.

◆ get() [2/2]

std::string Core::FMTMask::get ( const std::vector< FMTTheme > & themes ) const

Get the string mask name based on the bitset data and sorted themes.

Parameters

[in] themes the sorted themes.

Returns: the string mask name.

◆ getAttribute()

const std::string & Core::FMTMask::getAttribute ( const FMTTheme & p_theme ) const

When you deal with FMTDevelopment you can directly call this to get a reference to the attribute string.

Parameters

[in] p_theme the theme we target

Returns: a const reference to the attribute.

◆ getBitsetIntersect()

boost::dynamic_bitset< uint8_t > Core::FMTMask::getBitsetIntersect ( const FMTMask & rhs ) const

Return the bitset of the intersection of this mask and another mask.

Parameters

[in] rhs the other mask.

Returns: the intersection bitset.

◆ getBitsetReference()

const boost::dynamic_bitset< uint8_t > & Core::FMTMask::getBitsetReference ( ) const

inline

Return a const reference to the bitset data member.

Returns: a const reference to the bitset.

◆ getBitsString()

std::string Core::FMTMask::getBitsString ( ) const

Return the binary representation of the bitset as a string.

Returns: the binary representation of the bitset.

◆ getIntersect()

FMTMask Core::FMTMask::getIntersect ( const FMTMask & rhs ) const

Return the intersection of this mask and another mask.

Parameters

[in] rhs the other mask.

Returns: the intersection mask.

◆ getNonFullBlocks()

std::vector< size_t > Core::FMTMask::getNonFullBlocks ( ) const

Return the indexes of the blocks that contain a 0.

Returns: a vector of indexes of the blocks that contain a 0.

◆ getPostSolveMask()

FMTMask Core::FMTMask::getPostSolveMask	(	const FMTMask &	mask,
		const std::vector< FMTTheme > &	themes
	)		const

Turn off the bits of themes that are still active on a base postsolve mask.

Parameters

[in]	mask	the mask used to turn off bits.
[in]	themes	the themes.

Returns: the postsolve mask.

◆ getSelectedThemes()

std::vector< const Core::FMTTheme * > Core::FMTMask::getSelectedThemes ( const std::vector< Core::FMTTheme > & themes ) const

Return the themes that have any bit set in the mask.

Parameters

[in] themes the themes to filter.

Returns: the selected themes.

◆ getStaticThemes()

std::vector< const Core::FMTTheme * > Core::FMTMask::getStaticThemes ( const std::vector< const Core::FMTTheme * > & themes ) const

Return the themes that only use aggregates or a question mark for the mask.

Parameters

[in] themes the themes to filter.

Returns: the static themes.

◆ getStringReference()

const std::string & Core::FMTMask::getStringReference ( ) const

inline

Return a const reference to the name string member.

Returns: a const reference to the name string.

◆ getSubsetCount()

size_t Core::FMTMask::getSubsetCount ( const FMTTheme & theme ) const

Return the number of bits set for the given theme subset.

Parameters

[in] theme the theme.

Returns: the number of bits set for the theme subset.

◆ getUnion()

FMTMask Core::FMTMask::getUnion ( const FMTMask & rhs ) const

Return the union of this mask and another mask.

Parameters

[in] rhs the other mask.

Returns: the union mask.

◆ hash()

size_t Core::FMTMask::hash ( ) const

inline

Return the hash of the mask.

Returns: the hash value.

◆ isNotThemesSubset() [1/2]

bool Core::FMTMask::isNotThemesSubset	(	const FMTMask &	rhs,
		const std::vector< const Core::FMTTheme * > &	themes
	)		const

Return true if this mask is not part of rhs based on the sorted themes.

Parameters

[in]	rhs	the other mask.
[in]	themes	the sorted themes.

Returns: true if this mask is not a subset of rhs else false.

◆ isNotThemesSubset() [2/2]

bool Core::FMTMask::isNotThemesSubset	(	const FMTMask &	rhs,
		const std::vector< Core::FMTTheme > &	themes
	)		const

Return true if this mask is not part of rhs based on the sorted themes.

Parameters

[in]	rhs	the other mask.
[in]	themes	the sorted themes.

Returns: true if this mask is not a subset of rhs else false.

◆ isSubsetOf() [1/2]

bool Core::FMTMask::isSubsetOf	(	const FMTMask &	p_mask,
		const std::vector< size_t > &	p_subset
	)		const

Check if this mask is a subset of another mask by looking at a block subset.

Parameters

[in]	p_mask	the other mask.
[in]	p_subset	the block subset.

Returns: true if all blocks are subset of this else false.

◆ isSubsetOf() [2/2]

bool Core::FMTMask::isSubsetOf ( const FMTMask & p_rhs ) const

Check if this mask is a subset of another mask.

Parameters

[in] p_rhs the mask to check against.

Returns: true if this mask is a subset of p_rhs else false.

◆ operator bool()

Core::FMTMask::operator bool ( ) const

explicit

Return true if the mask is not empty by looking at the data bitset.

Returns: true if the mask is not empty else false.

◆ operator std::string()

Core::FMTMask::operator std::string ( ) const

inline

Return the name of the mask.

Returns: the name of the mask.

◆ operator!=()

bool Core::FMTMask::operator!= ( const FMTMask & rhs ) const

Inequality comparison operator of FMTMask.

Parameters

[in] rhs the mask to compare with.

Returns: true if both masks are different else false.

◆ operator<()

bool Core::FMTMask::operator< ( const FMTMask & rhs ) const

Less than comparison operator of FMTMask.

Parameters

[in] rhs the mask to compare with.

Returns: true if this mask is less than rhs else false.

◆ operator=() [1/2]

FMTMask & Core::FMTMask::operator= ( const FMTMask & rhs )

Copy assignment operator for FMTMask.

Parameters

[in] rhs the mask to copy.

Returns: a reference to this FMTMask.

◆ operator=() [2/2]

FMTMask & Core::FMTMask::operator= ( FMTMask && rhs )

noexcept

Move assignment operator for FMTMask.

Parameters

[in] rhs the mask to move from.

Returns: a reference to this FMTMask.

◆ operator==()

bool Core::FMTMask::operator== ( const FMTMask & rhs ) const

Equality comparison operator of FMTMask.

Parameters

[in] rhs the mask to compare with.

Returns: true if both masks are equal else false.

◆ postSolve()

FMTMask Core::FMTMask::postSolve	(	const FMTMaskFilter &	filter,
		const std::vector< FMTTheme > &	basethemes
	)		const

Return a postsolved mask using a filter and the original themes.

Parameters

[in]	filter	the mask filter.
[in]	basethemes	the original themes.

Returns: the postsolved mask.

◆ preSolve()

FMTMask Core::FMTMask::preSolve	(	const FMTMaskFilter &	filter,
		const std::vector< FMTTheme > &	presolvedthemes
	)		const

Return a presolved mask with potentially less data using a filter and a subset of the original themes.

Parameters

[in]	filter	the mask filter.
[in]	presolvedthemes	the presolved themes.

Returns: the presolved mask.

◆ preSolveRef()

void Core::FMTMask::preSolveRef	(	const FMTMaskFilter &	p_filter,
		const std::vector< FMTTheme > &	p_presolvedThemes,
		bool	p_allowReallocation = `true`
	)

Presolve this mask in place with potentially less data using a filter and a subset of the original themes.

Parameters

[in]	p_filter	the mask filter.
[in]	p_presolvedThemes	the presolved themes.
[in]	p_allowReallocation	if true allows reallocation of the data.

◆ refine()

FMTMask Core::FMTMask::refine	(	const FMTMask &	mask,
		const std::vector< FMTTheme > &	themes
	)		const

Return a new mask where the question marks are completed with the attributes of another mask.

Parameters

[in]	mask	the mask to refine from.
[in]	themes	the themes.

Returns: the refined mask.

◆ removeAggregates()

FMTMask Core::FMTMask::removeAggregates	(	const std::vector< FMTTheme > &	themes,
		bool	questionmarkonly = `false`
	)		const

Return a new mask with the bits of aggregates or question marks unset for the given themes.

Parameters

[in]	themes	the themes.
[in]	questionmarkonly	if true only removes question marks.

Returns: the mask without aggregates.

◆ reserve()

void Core::FMTMask::reserve ( size_t p_size )

reserve memory for the boost dynamicbitset.

Parameters

[in] p_size number of bits to reserve.

◆ resume() [1/2]

FMTMask Core::FMTMask::resume ( const boost::dynamic_bitset< uint8_t > & rhs ) const

Return a mask with the selected name and data using a bitset.

Parameters

[in] rhs the selection bitset.

Returns: the resumed mask.

◆ resume() [2/2]

FMTMask Core::FMTMask::resume ( const std::vector< size_t > & indexes ) const

Return a mask with the selected name and data using mask indexes.

Parameters

[in] indexes the selection indexes.

Returns: the resumed mask.

◆ set() [1/2]

void Core::FMTMask::set	(	const FMTTheme &	theme,
		const std::string &	value
	)

Set the bitset data for a given theme from an attribute.

Parameters

[in]	theme	the theme.
[in]	value	the attribute.

◆ set() [2/2]

void Core::FMTMask::set	(	const std::vector< FMTTheme > &	themes,
		const std::string &	value
	)

Set the bitset data for some themes from a mask string.

Parameters

[in]	themes	the themes.
[in]	value	the mask string.

◆ setExclusiveBits()

void Core::FMTMask::setExclusiveBits	(	const FMTMask &	p_mask,
		const FMTTheme &	p_theme
	)

Flip only the theme subset and clear the mask of the intersection with another mask.

Parameters

[in]	p_mask	the mask to intersect with.
[in]	p_theme	the theme to subset on.

◆ setIntersect()

void Core::FMTMask::setIntersect ( const FMTMask & rhs )

set the intersect with this mask using rhs mask.

Parameters

[in] rhs the mask we intersect with.

◆ size()

size_t Core::FMTMask::size ( ) const

Return the size of the bitset data member.

Returns: the size of the bitset.

◆ swap()

void Core::FMTMask::swap ( FMTMask & rhs )

Swap this mask with another.

Parameters

[in,out] rhs the mask to swap with.

◆ unionWith()

void Core::FMTMask::unionWith ( const FMTMask & rhs )

Performs an in-place union with another mask.

Parameters

rhs	Mask whose bits will be added to the current mask.

◆ update()

void Core::FMTMask::update ( const std::vector< FMTTheme > & themes )

Update the name member from the bitset data using a sorted list of themes.

Parameters

[in] themes the sorted themes.

Friends And Related Function Documentation

◆ boost::serialization::access

friend class boost::serialization::access

friend

Serialize the FMTMask for multiprocessing across multiple cpus (pickle in Python).

Template Parameters

Archive the archive type.

Parameters

[in,out]	ar	the archive to serialize to or from.
[in]	version	the serialization version.

◆ FMTTheme

friend class FMTTheme

friend

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

D:/FMT/Include/FMTMask.h

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ FMTMask() [1/8]

◆ FMTMask() [2/8]

◆ FMTMask() [3/8]

◆ ~FMTMask()

◆ FMTMask() [4/8]

◆ FMTMask() [5/8]

◆ FMTMask() [6/8]

◆ FMTMask() [7/8]

◆ FMTMask() [8/8]

Member Function Documentation

◆ append()

◆ binarizedAppend() [1/2]

◆ binarizedAppend() [2/2]

◆ canPreSolve()

◆ clear()

◆ count()

◆ decompose()

◆ empty()

◆ get() [1/2]

◆ get() [2/2]

◆ getAttribute()

◆ getBitsetIntersect()

◆ getBitsetReference()

◆ getBitsString()

◆ getIntersect()

◆ getNonFullBlocks()

◆ getPostSolveMask()

◆ getSelectedThemes()

◆ getStaticThemes()

◆ getStringReference()

◆ getSubsetCount()

◆ getUnion()

◆ hash()

◆ isNotThemesSubset() [1/2]

◆ isNotThemesSubset() [2/2]

◆ isSubsetOf() [1/2]

◆ isSubsetOf() [2/2]

◆ operator bool()

◆ operator std::string()

◆ operator!=()

◆ operator<()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ postSolve()

◆ preSolve()

◆ preSolveRef()

◆ refine()

◆ removeAggregates()

◆ reserve()

◆ resume() [1/2]

◆ resume() [2/2]

◆ set() [1/2]

◆ set() [2/2]

◆ setExclusiveBits()

◆ setIntersect()

◆ size()

◆ swap()

◆ unionWith()

◆ update()

Friends And Related Function Documentation

◆ boost::serialization::access

◆ FMTTheme