mmcfilters
Public API documentation
Loading...
Searching...
No Matches
Public Member Functions | List of all members
mmcfilters::local_attributes::AnchoredEntryMap Class Reference

Window-coordinate map whose missing entries represent out-of-domain samples. More...

#include <LocalEventModel.hpp>

Public Member Functions

 AnchoredEntryMap (PixelId anchorPixel, std::vector< std::optional< NodeId > > entries)
 Builds a coordinate-preserving map.
 
PixelId anchorPixel () const noexcept
 Returns the anchor pixel.
 
std::size_t size () const noexcept
 Returns the coordinate count.
 
const std::optional< NodeId > & operator[] (std::size_t coordinate) const noexcept
 Returns one coordinate entry.
 
std::span< const std::optional< NodeId > > entries () const noexcept
 Returns every coordinate entry.
 

Detailed Description

Window-coordinate map whose missing entries represent out-of-domain samples.

Definition at line 161 of file LocalEventModel.hpp.

Constructor & Destructor Documentation

◆ AnchoredEntryMap()

mmcfilters::local_attributes::AnchoredEntryMap::AnchoredEntryMap ( PixelId  anchorPixel,
std::vector< std::optional< NodeId > >  entries 
)
inline

Builds a coordinate-preserving map.

Parameters
anchorPixelAnchor pixel.
entriesOptional anchored entry per coordinate.

Definition at line 164 of file LocalEventModel.hpp.

Member Function Documentation

◆ anchorPixel()

PixelId mmcfilters::local_attributes::AnchoredEntryMap::anchorPixel ( ) const
inlinenoexcept

Returns the anchor pixel.

Returns
Row-major anchor identifier.

Definition at line 167 of file LocalEventModel.hpp.

◆ entries()

std::span< const std::optional< NodeId > > mmcfilters::local_attributes::AnchoredEntryMap::entries ( ) const
inlinenoexcept

Returns every coordinate entry.

Returns
Borrowed optional-node span.

Definition at line 173 of file LocalEventModel.hpp.

◆ operator[]()

const std::optional< NodeId > & mmcfilters::local_attributes::AnchoredEntryMap::operator[] ( std::size_t  coordinate) const
inlinenoexcept

Returns one coordinate entry.

Parameters
coordinateCoordinate index.
Returns
Optional anchored-entry node.

Definition at line 171 of file LocalEventModel.hpp.

◆ size()

std::size_t mmcfilters::local_attributes::AnchoredEntryMap::size ( ) const
inlinenoexcept

Returns the coordinate count.

Returns
Number of mapped coordinates.

Definition at line 169 of file LocalEventModel.hpp.


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