Shared scalar conventions used by the C++ API. More...
Go to the source code of this file.
Typedefs | |
| using | mmcfilters::NodeId = int |
| Node identifier type used throughout the project. | |
Functions | |
| bool | mmcfilters::isValidNode (NodeId id) noexcept |
Returns true when id is not the invalid-node sentinel. | |
| bool | mmcfilters::isInvalid (NodeId id) noexcept |
Returns true when id is the invalid-node sentinel. | |
Variables | |
| constexpr NodeId | mmcfilters::InvalidNode = -1 |
| Sentinel value used to denote an invalid node identifier. | |
| constexpr bool | mmcfilters::PRINT_LOG = false |
| Compile-time switch for optional diagnostic logging. | |
Detailed Description
Shared scalar conventions used by the C++ API.
Definition in file Common.hpp.
Typedef Documentation
◆ NodeId
| using mmcfilters::NodeId = typedef int |
Node identifier type used throughout the project.
Node ids index this repository's dense internal node-slot domain. They are intentionally signed so InvalidNode can be represented without reserving a valid dense slot.
Definition at line 17 of file Common.hpp.
Function Documentation
◆ isInvalid()
|
inlinenoexcept |
Returns true when id is the invalid-node sentinel.
Definition at line 35 of file Common.hpp.
◆ isValidNode()
|
inlinenoexcept |
Returns true when id is not the invalid-node sentinel.
Definition at line 30 of file Common.hpp.
Variable Documentation
◆ InvalidNode
|
constexpr |
Sentinel value used to denote an invalid node identifier.
Public APIs return or accept this value when no node exists, for example for a missing parent, failed lookup, or invalid proper-part owner.
Definition at line 25 of file Common.hpp.
◆ PRINT_LOG
|
constexpr |
Compile-time switch for optional diagnostic logging.
The default public build keeps this disabled so library code remains quiet unless a local development build changes the constant.
Definition at line 43 of file Common.hpp.
