mmcfilters::NodePreservationMask Class Reference

Dense Boolean decisions where true means preserve the node. More...

#include <NodeDecisionMasks.hpp>

Public Member Functions
	NodePreservationMask ()=default
	Creates an empty preservation mask.
	NodePreservationMask (std::vector< bool > decisions)
	Creates a preservation mask from explicit decisions.
	NodePreservationMask (std::size_t size, bool preserveNode)
	Creates a preservation mask whose entries share one decision.
std::size_t	size () const noexcept
	Returns the number of dense node slots.
bool	empty () const noexcept
	Tests whether the mask contains no decisions.
bool	operator[] (std::size_t index) const
	Returns one preservation decision.
const std::vector< bool > &	decisions () const noexcept
	Returns all preservation decisions.

Detailed Description

Dense Boolean decisions where true means preserve the node.

The mask is indexed by the dense internal NodeId domain. It is deliberately not implicitly interchangeable with NodePruningMask.

Definition at line 15 of file NodeDecisionMasks.hpp.

Constructor & Destructor Documentation

NodePreservationMask() [1/2]

mmcfilters::NodePreservationMask::NodePreservationMask ( std::vector< bool >  decisions )

inlineexplicit

Creates a preservation mask from explicit decisions.

Parameters

decisions

Dense decisions where true preserves the corresponding node.

Definition at line 27 of file NodeDecisionMasks.hpp.

NodePreservationMask() [2/2]

mmcfilters::NodePreservationMask::NodePreservationMask ( std::size_t  size, bool  preserveNode  )

inline

Creates a preservation mask whose entries share one decision.

Parameters

size	Number of dense node slots represented by the mask.
preserveNode	Decision assigned to every slot.

Definition at line 34 of file NodeDecisionMasks.hpp.

Member Function Documentation

decisions()

const std::vector< bool > & mmcfilters::NodePreservationMask::decisions ( ) const

inlinenoexcept

Returns all preservation decisions.

Returns

Read-only dense decision buffer.

Definition at line 50 of file NodeDecisionMasks.hpp.

empty()

bool mmcfilters::NodePreservationMask::empty ( ) const

inlinenoexcept

Tests whether the mask contains no decisions.

Returns

True when the mask is empty.

Definition at line 40 of file NodeDecisionMasks.hpp.

operator[]()

bool mmcfilters::NodePreservationMask::operator[] ( std::size_t  index ) const

inline

Returns one preservation decision.

Parameters

index

Dense node-slot index.

Returns

True when the indexed node must be preserved.

Definition at line 47 of file NodeDecisionMasks.hpp.

size()

std::size_t mmcfilters::NodePreservationMask::size ( ) const

inlinenoexcept

Returns the number of dense node slots.

Returns

Number of decisions.

Definition at line 37 of file NodeDecisionMasks.hpp.

---

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

• mmcfilters/filters/NodeDecisionMasks.hpp