Hold thinning decisions for one container. More...

#include <ThinningDecisionBase.h>

Inheritance diagram for SG::ThinningDecisionBase:

Collaboration diagram for SG::ThinningDecisionBase:

Public Types
enum	Op { Op::Set = 0, Op::And = 1, Op::Or = 2 }

Public Member Functions
	ThinningDecisionBase (size_t sz=0)
	Constructor. More...

void	resize (const size_t size)
	Change the number of elements. More...

bool	thinned (size_t ndx) const
	Return true if element `ndx` should be thinned. More...

size_t	size () const
	Return the total size of the container being thinned. More...

size_t	thinnedSize () const
	Return the size of the container being thinned after thinning. More...

void	thinAll ()
	Mark that all elements should be thinned away. More...

void	keepAll ()
	Mark that all elements should be kept (not thinned). More...

void	thin (size_t ndx)
	Mark that index `ndx` in the container should be thinned away. More...

void	keep (size_t ndx)
	Mark that index `ndx` in the container should be kept (not thinned away). More...

void	thin (size_t ndx, bool flag, Op op=Op::Set)
	Set thinning state for one element. More...

void	keep (size_t ndx, bool flag, Op op=Op::Set)
	Set thinning state for one element. More...

void	thin (const std::vector< bool > &v, Op op=Op::Set)
	Set the thinning state for the container from a bitmask. More...

void	keep (const std::vector< bool > &v, Op op=Op::Set)
	Set the thinning state for the container from a bitmask. More...

void	thin (const ThinningDecisionBase &other, Op op=Op::Set)
	Set the thinning state for the container from a bitmask. More...

void	keep (const ThinningDecisionBase &other, Op op=Op::Set)
	Set the thinning state for the container from a bitmask. More...

void	buildIndexMap ()
	Build the index map. More...

size_t	index (size_t ndxOrig) const
	Return the index corresponding to `ndxOrig` after thinning. More...

Static Public Attributes
static const std::size_t	RemovedIdx = static_cast<std::size_t>(-1)
	Flag used to show that an index has been thinned away. More...

Private Attributes
boost::dynamic_bitset	m_mask
	Thinning map. Set to 1 for thinned elements. More...

std::vector< size_t >	m_indexMap
	Mapping from original indices to thinned indices. More...

Detailed Description

Hold thinning decisions for one container.

This class is a wrapper around a bitmap that holds a set of thinning decisions for one container. If bit i is set in the map, then element i of the container has been thinned.

This class also holds a mapping of container indices before and after thinning. However, this is not available until @ buildIndexMap() has been called (which usually happens implicitly when the derived ThinningDecision object is recorded in StoreGate).

Definition at line 38 of file ThinningDecisionBase.h.

Member Enumeration Documentation

◆ Op

enum SG::ThinningDecisionBase::Op

strong

Enumerator
Set
And
Or

Definition at line 44 of file ThinningDecisionBase.h.

                 {
     Set = 0,
     And = 1,
     Or = 2
   };

Constructor & Destructor Documentation

◆ ThinningDecisionBase()

SG::ThinningDecisionBase::ThinningDecisionBase ( size_t sz = 0 )

Constructor.

Parameters

sz	Number of elements in the container.

Initialized with all elements kept.

Parameters

sz	Number of elements in the container.

Definition at line 23 of file ThinningDecisionBase.cxx.

   : m_mask (sz)
 {
 }

Member Function Documentation

◆ buildIndexMap()

void SG::ThinningDecisionBase::buildIndexMap ( )

Build the index map.

Definition at line 240 of file ThinningDecisionBase.cxx.

 {
   assert (m_indexMap.empty());
   size_t sz = m_mask.size();
   m_indexMap.resize (sz);
   size_t pos = 0;
   for (size_t i = 0; i < sz; i++) {
     m_indexMap[i] = thinned(i) ? RemovedIdx : pos++ ;
   }
 }

◆ index()

size_t SG::ThinningDecisionBase::index ( size_t ndxOrig ) const

Return the index corresponding to ndxOrig after thinning.

Parameters

ndxOrig Original container index.

Returns the index at which element ndxOrig ends up after thinning. If the element was thinned away, returns RemovedIdx.

This information is available only after buildIndexMap has been called.

◆ keep() [1/4]

void SG::ThinningDecisionBase::keep	(	const std::vector< bool > &	v,
		Op	op = `Op::Set`
	)

Set the thinning state for the container from a bitmask.

Parameters

v	Thinning state mask; should have the same size as the container. Element `ndx` should be kept if bit `ndx` is set in the map.
op	Logical operation for combining with existing thinning state. Set — Keep if `flag` is true. And — Keep if `flag` is true and element was originally kept, else not. Or — Keep if `flag` is true or element was originally kept, else not.

Definition at line 172 of file ThinningDecisionBase.cxx.

 {
   size_t sz = m_mask.size();
   if (sz != v.size()) {
     throw std::out_of_range ("ThinningDecisionBase::keep(): inconsistent vector sizes.");
   }
   for (size_t i = 0; i < sz; i++) {
     bool flag = v[i];
     if (op == Op::And)
       flag &= !m_mask[i];
     else if (op == Op::Or)
       flag |= !m_mask[i];
     m_mask.set (i, !flag);
   }
 }

◆ keep() [2/4]

void SG::ThinningDecisionBase::keep	(	const ThinningDecisionBase &	other,
		Op	op = `Op::Set`
	)

Set the thinning state for the container from a bitmask.

Parameters

other	Thinning state mask; should have the same size as the container. Element `ndx` should be kept if bit `ndx` is set in the map.
op	Logical operation for combining with existing thinning state. Set — Keep if `flag` is true. And — Keep if `flag` is true and element was originally kept, else not. Or — Keep if `flag` is true or element was originally kept, else not.

Definition at line 222 of file ThinningDecisionBase.cxx.

 {
   size_t sz = m_mask.size();
   if (sz != other.size()) {
     throw std::out_of_range ("ThinningDecisionBase::keep(): inconsistent vector sizes.");
   }
   if (op == Op::And)
     m_mask |= ~other.m_mask;
   else if (op == Op::Or)
     m_mask &= ~other.m_mask;
   else
     m_mask = ~other.m_mask;
 }

◆ keep() [3/4]

void SG::ThinningDecisionBase::keep ( size_t ndx )

Mark that index ndx in the container should be kept (not thinned away).

Parameters

ndx	Index of element to keep.

Definition at line 84 of file ThinningDecisionBase.cxx.

 {
   if (ndx >= m_mask.size()) {
     throw std::out_of_range ("ThinningDecisionBase::thin");
   }
   m_mask.set (ndx, false);
 }

◆ keep() [4/4]

void SG::ThinningDecisionBase::keep	(	size_t	ndx,
		bool	flag,
		Op	op = `Op::Set`
	)

Set thinning state for one element.

Parameters

ndx	Index of element to alter.
flag	If true, keep this element; if false, thin it it.
op	Logical operation for combining with existing thinning state. Set — Keep if `flag` is true. And — Keep if `flag` is true and element was originally kept, else not. Or — Keep if `flag` is true or element was originally kept, else not.

Definition at line 124 of file ThinningDecisionBase.cxx.

 {
   if (ndx >= m_mask.size()) {
     throw std::out_of_range ("ThinningDecisionBase::thin");
   }
   if (op == Op::And)
     flag &= !m_mask[ndx];
   else if (op == Op::Or)
     flag |= !m_mask[ndx];
   m_mask.set (ndx, !flag);
 }

◆ keepAll()

void SG::ThinningDecisionBase::keepAll ( )

Mark that all elements should be kept (not thinned).

Definition at line 60 of file ThinningDecisionBase.cxx.

 {
   m_mask.reset();
 }

◆ resize()

void SG::ThinningDecisionBase::resize ( const size_t size )

Change the number of elements.

Parameters

size	The new number of elements.

Definition at line 33 of file ThinningDecisionBase.cxx.

 {
   m_mask.resize (size);
 }

◆ size()

size_t SG::ThinningDecisionBase::size ( ) const

Return the total size of the container being thinned.

◆ thin() [1/4]

void SG::ThinningDecisionBase::thin	(	const std::vector< bool > &	v,
		Op	op = `Op::Set`
	)

Set the thinning state for the container from a bitmask.

Parameters

v	Thinning state mask; should have the same size as the container. Element `ndx` should be thinned if bit `ndx` is set in the map.
op	Logical operation for combining with existing thinning state. Set — Thin if `flag` is true. And — Thin if `flag` is true and element was originally thinned, else not. Or — Thin if `flag` is true or element was originally thinned, else not.

Definition at line 146 of file ThinningDecisionBase.cxx.

 {
   size_t sz = m_mask.size();
   if (sz != v.size()) {
     throw std::out_of_range ("ThinningDecisionBase::thin(): inconsistent vector sizes.");
   }
   for (size_t i = 0; i < sz; i++) {
     bool flag = v[i];
     if (op == Op::And)
       flag &= m_mask[i];
     else if (op == Op::Or)
       flag |= m_mask[i];
     m_mask.set (i, flag);
   }
 }

◆ thin() [2/4]

void SG::ThinningDecisionBase::thin	(	const ThinningDecisionBase &	other,
		Op	op = `Op::Set`
	)

Set the thinning state for the container from a bitmask.

Parameters

other	Thinning state mask; should have the same size as the container. Element `ndx` should be thinned if bit `ndx` is set in the map.
op	Logical operation for combining with existing thinning state. Set — Thin if `flag` is true. And — Thin if `flag` is true and element was originally thinned, else not. Or — Thin if `flag` is true or element was originally thinned, else not.

Definition at line 198 of file ThinningDecisionBase.cxx.

 {
   size_t sz = m_mask.size();
   if (sz != other.size()) {
     throw std::out_of_range ("ThinningDecisionBase::thin(): inconsistent vector sizes.");
   }
   if (op == Op::And)
     m_mask &= other.m_mask;
   else if (op == Op::Or)
     m_mask |= other.m_mask;
   else
     m_mask = other.m_mask;
 }

◆ thin() [3/4]

void SG::ThinningDecisionBase::thin ( size_t ndx )

Mark that index ndx in the container should be thinned away.

Parameters

ndx	Index of element to thin.

Definition at line 70 of file ThinningDecisionBase.cxx.

 {
   if (ndx >= m_mask.size()) {
     throw std::out_of_range ("ThinningDecisionBase::thin");
   }
   m_mask.set (ndx, true);
 }

◆ thin() [4/4]

void SG::ThinningDecisionBase::thin	(	size_t	ndx,
		bool	flag,
		Op	op = `Op::Set`
	)

Set thinning state for one element.

Parameters

ndx	Index of element to alter.
flag	If true, thin this element; if false, keep it.
op	Logical operation for combining with existing thinning state. Set — Thin if `flag` is true. And — Thin if `flag` is true and element was originally thinned, else not. Or — Thin if `flag` is true or element was originally thinned, else not.

Definition at line 102 of file ThinningDecisionBase.cxx.

 {
   if (ndx >= m_mask.size()) {
     throw std::out_of_range ("ThinningDecisionBase::thin");
   }
   if (op == Op::And)
     flag &= m_mask[ndx];
   else if (op == Op::Or)
     flag |= m_mask[ndx];
   m_mask.set (ndx, flag);
 }

◆ thinAll()

void SG::ThinningDecisionBase::thinAll ( )

Mark that all elements should be thinned away.

Definition at line 51 of file ThinningDecisionBase.cxx.

 {
   m_mask.set();
 }

◆ thinned()

bool SG::ThinningDecisionBase::thinned ( size_t ndx ) const

Return true if element ndx should be thinned.

◆ thinnedSize()

size_t SG::ThinningDecisionBase::thinnedSize ( ) const

Return the size of the container being thinned after thinning.

Definition at line 42 of file ThinningDecisionBase.cxx.

 {
   return m_mask.size() - m_mask.count();
 }

Member Data Documentation

◆ m_indexMap

std::vector<size_t> SG::ThinningDecisionBase::m_indexMap

private

Mapping from original indices to thinned indices.

Definition at line 207 of file ThinningDecisionBase.h.

◆ m_mask

boost::dynamic_bitset SG::ThinningDecisionBase::m_mask

private

Thinning map. Set to 1 for thinned elements.

Definition at line 204 of file ThinningDecisionBase.h.

◆ RemovedIdx

const std::size_t SG::ThinningDecisionBase::RemovedIdx = static_cast<std::size_t>(-1)

static

Flag used to show that an index has been thinned away.

Definition at line 42 of file ThinningDecisionBase.h.

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

Public Types

Public Member Functions

Static Public Attributes

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ Op

Constructor & Destructor Documentation

◆ ThinningDecisionBase()

Member Function Documentation

◆ buildIndexMap()

◆ index()

◆ keep() [1/4]

◆ keep() [2/4]

◆ keep() [3/4]

◆ keep() [4/4]

◆ keepAll()

◆ resize()

◆ size()

◆ thin() [1/4]

◆ thin() [2/4]

◆ thin() [3/4]

◆ thin() [4/4]

◆ thinAll()

◆ thinned()

◆ thinnedSize()

Member Data Documentation

◆ m_indexMap

◆ m_mask

◆ RemovedIdx