mmcfilters::local_attributes::BinaryVisibilityState Class Reference

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

#include <LocalEventModel.hpp>

Public Member Functions
	BinaryVisibilityState (std::uint32_t bits, std::size_t coordinateCount)
	Builds a validated binary state.
std::uint32_t	bits () const noexcept
	Returns the visibility mask.
std::size_t	coordinateCount () const noexcept
	Returns the coordinate domain size.
bool	isVisible (std::size_t coordinate) const
	Tests one visibility coordinate.
BinaryVisibilityState	withEnteringOffsets (std::uint32_t enteringOffsetMask) const
	Returns a state with additional coordinates visible.

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

Detailed Description

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

Definition at line 87 of file LocalEventModel.hpp.

Constructor & Destructor Documentation

BinaryVisibilityState()

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

inline

Builds a validated binary state.

Parameters

bits	Visible-coordinate bit mask.
coordinateCount	Number of valid low-order coordinates.

Definition at line 94 of file LocalEventModel.hpp.

Member Function Documentation

bits()

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

inlinenoexcept

Returns the visibility mask.

Returns

Low-order coordinate bits.

Definition at line 109 of file LocalEventModel.hpp.

coordinateCount()

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

inlinenoexcept

Returns the coordinate domain size.

Returns

Number of valid bits.

Definition at line 111 of file LocalEventModel.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 sample is visible.

Definition at line 114 of file LocalEventModel.hpp.

withEnteringOffsets()

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

inline

Returns a state with additional coordinates visible.

Parameters

enteringOffsetMask

Coordinates entering at one anchored entry.

Returns

Updated immutable state value.

Definition at line 126 of file LocalEventModel.hpp.

Friends And Related Symbol Documentation

detail::BinaryVisibilityStateAccess

friend struct detail::BinaryVisibilityStateAccess

friend

Definition at line 148 of file LocalEventModel.hpp.

operator==

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

friend

Compares visibility masks and coordinate domains.

Parameters

lhs	Left state.
rhs	Right state.

Returns

True when equal.

---

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

• mmcfilters/localAttributes/LocalEventModel.hpp