mmcfilters
Public API documentation
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
mmcfilters::attributes::registry::AttributeCapabilityRequirements Struct Reference

Runtime capabilities required to compute one scalar attribute. More...

#include <AttributeRegistry.hpp>

Public Member Functions

constexpr bool operator== (const AttributeCapabilityRequirements &) const noexcept=default
 Compares every capability requirement.
 

Public Attributes

bool altitude = false
 Whether node altitudes must be available.
 
bool gridDomain2D = false
 Whether proper parts must have a regular 2D domain.
 
AttributeAdjacencyRequirement adjacency = AttributeAdjacencyRequirement::None
 Required form of adjacency context.
 
bool monotoneAltitudeOrder = false
 Whether the global altitude order must be monotone.
 
bool altitudeForDirectionalAdjacency = false
 Whether directional adjacency selection requires node altitudes.
 
bool canonical4Or8Adjacency = false
 Whether only canonical 4- or 8-neighbourhoods are accepted.
 

Detailed Description

Runtime capabilities required to compute one scalar attribute.

Altitude availability is distinct from altitude monotonicity. BitQuad projection, for example, is topology-only for uniform adjacency but needs altitude to select between unequal directional adjacencies.

Definition at line 26 of file AttributeRegistry.hpp.

Member Function Documentation

◆ operator==()

constexpr bool mmcfilters::attributes::registry::AttributeCapabilityRequirements::operator== ( const AttributeCapabilityRequirements ) const
constexprdefaultnoexcept

Compares every capability requirement.

Returns
True when the documented condition holds; otherwise false.

Member Data Documentation

◆ adjacency

AttributeAdjacencyRequirement mmcfilters::attributes::registry::AttributeCapabilityRequirements::adjacency = AttributeAdjacencyRequirement::None

Required form of adjacency context.

Definition at line 32 of file AttributeRegistry.hpp.

◆ altitude

bool mmcfilters::attributes::registry::AttributeCapabilityRequirements::altitude = false

Whether node altitudes must be available.

Definition at line 28 of file AttributeRegistry.hpp.

◆ altitudeForDirectionalAdjacency

bool mmcfilters::attributes::registry::AttributeCapabilityRequirements::altitudeForDirectionalAdjacency = false

Whether directional adjacency selection requires node altitudes.

Definition at line 36 of file AttributeRegistry.hpp.

◆ canonical4Or8Adjacency

bool mmcfilters::attributes::registry::AttributeCapabilityRequirements::canonical4Or8Adjacency = false

Whether only canonical 4- or 8-neighbourhoods are accepted.

Definition at line 38 of file AttributeRegistry.hpp.

◆ gridDomain2D

bool mmcfilters::attributes::registry::AttributeCapabilityRequirements::gridDomain2D = false

Whether proper parts must have a regular 2D domain.

Definition at line 30 of file AttributeRegistry.hpp.

◆ monotoneAltitudeOrder

bool mmcfilters::attributes::registry::AttributeCapabilityRequirements::monotoneAltitudeOrder = false

Whether the global altitude order must be monotone.

Definition at line 34 of file AttributeRegistry.hpp.


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