mmcfilters::local_attributes::BinaryVisibilityState Class Reference

Binary sample-visibility vector encoded in observation-window order. More...

#include <FiniteWindowLocalAttributeComputer.hpp>

Public Member Functions
	BinaryVisibilityState (std::uint32_t bits, std::size_t coordinateCount)
	Creates a state over a fixed coordinate domain.
std::uint32_t	bits () const noexcept
	Returns the packed visibility bits.
std::size_t	coordinateCount () const noexcept
	Returns the state-coordinate count.
bool	isVisible (std::size_t coordinate) const
	Tests one visibility coordinate.
BinaryVisibilityState	withEnteringOffsets (std::uint32_t enteringOffsetMask) const
	Adds all coordinates entering at one node.

Friends
struct	detail::BinaryVisibilityStateAccess
bool	operator== (const BinaryVisibilityState &lhs, const BinaryVisibilityState &rhs)=default
	Compares state bits and coordinate domains.

Detailed Description

Binary sample-visibility vector encoded in observation-window order.

Definition at line 104 of file FiniteWindowLocalAttributeComputer.hpp.

Constructor & Destructor Documentation

BinaryVisibilityState()

mmcfilters::local_attributes::BinaryVisibilityState::BinaryVisibilityState ( std::uint32_t  bits, std::size_t  coordinateCount  )

inline

Creates a state over a fixed coordinate domain.

Parameters

bits	Visible coordinates.
coordinateCount	Domain size in [1, 32].

Definition at line 107 of file FiniteWindowLocalAttributeComputer.hpp.

Member Function Documentation

bits()

std::uint32_t mmcfilters::local_attributes::BinaryVisibilityState::bits ( ) const

inlinenoexcept

Returns the packed visibility bits.

Returns

Visibility mask.

Definition at line 122 of file FiniteWindowLocalAttributeComputer.hpp.

coordinateCount()

std::size_t mmcfilters::local_attributes::BinaryVisibilityState::coordinateCount ( ) const

inlinenoexcept

Returns the state-coordinate count.

Returns

Number of valid bits.

Definition at line 124 of file FiniteWindowLocalAttributeComputer.hpp.

isVisible()

bool mmcfilters::local_attributes::BinaryVisibilityState::isVisible ( std::size_t  coordinate ) const

inline

Tests one visibility coordinate.

Parameters

coordinate

Coordinate index.

Returns

True when the coordinate is visible.

Definition at line 127 of file FiniteWindowLocalAttributeComputer.hpp.

withEnteringOffsets()

BinaryVisibilityState mmcfilters::local_attributes::BinaryVisibilityState::withEnteringOffsets ( std::uint32_t  enteringOffsetMask ) const

inline

Adds all coordinates entering at one node.

Parameters

enteringOffsetMask

Coordinates that become visible.

Returns

Updated state.

Definition at line 135 of file FiniteWindowLocalAttributeComputer.hpp.

Friends And Related Symbol Documentation

detail::BinaryVisibilityStateAccess

friend struct detail::BinaryVisibilityStateAccess

friend

Definition at line 156 of file FiniteWindowLocalAttributeComputer.hpp.

operator==

bool operator== ( const BinaryVisibilityState &  lhs, const BinaryVisibilityState &  rhs  )

friend

Compares state bits and coordinate domains.

Parameters

lhs	Left state.
rhs	Right state.

Returns

True when both states match.

---

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

• mmcfilters/localAttributes/FiniteWindowLocalAttributeComputer.hpp