MorphologicalAttributeFilters
Public API documentation
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
mmcfilters::ComputedAttributeDataWithDelta< Real > Struct Template Reference

Owning result for one delta-augmented attribute layout and buffer. More...

#include <AttributeResultTypes.hpp>

Collaboration diagram for mmcfilters::ComputedAttributeDataWithDelta< Real >:
Collaboration graph
[legend]

Public Member Functions

 ComputedAttributeDataWithDelta (AttributeNamesWithDelta attrNames, std::vector< Real > buffer, NodeIdSpace outputSpace=NodeIdSpace::MORPHOLOGICAL_TREE)
 Takes ownership of a delta-augmented layout and its flat buffer.
 
 ComputedAttributeDataWithDelta (const ComputedAttributeDataWithDelta &)=delete
 
ComputedAttributeDataWithDeltaoperator= (const ComputedAttributeDataWithDelta &)=delete
 
 ComputedAttributeDataWithDelta (ComputedAttributeDataWithDelta &&) noexcept=default
 Transfers ownership of the layout, buffer, and node-id-space marker.
 
ComputedAttributeDataWithDeltaoperator= (ComputedAttributeDataWithDelta &&)=delete
 
AttributeNamesWithDeltaattributeNames () noexcept
 Returns the mutable delta-aware attribute layout.
 
const AttributeNamesWithDeltaattributeNames () const noexcept
 Returns the immutable delta-aware attribute layout.
 
std::vector< Real > & values () noexcept
 Returns the mutable flat attribute buffer.
 
const std::vector< Real > & values () const noexcept
 Returns the immutable flat attribute buffer.
 

Public Attributes

AttributeNamesWithDelta first
 Delta-aware layout used to interpret second.
 
std::vector< Realsecond
 Flat per-node, per-delta attribute buffer indexed through first.
 
NodeIdSpace nodeIdSpace = NodeIdSpace::MORPHOLOGICAL_TREE
 Node-id domain used by the rows of second.
 

Detailed Description

template<std::floating_point Real = float>
struct mmcfilters::ComputedAttributeDataWithDelta< Real >

Owning result for one delta-augmented attribute layout and buffer.

This is the delta-aware counterpart of ComputedAttributeData<Real>. It is used when one logical attribute is sampled at several ancestor/descendant offsets around each node.

Definition at line 84 of file AttributeResultTypes.hpp.

Constructor & Destructor Documentation

◆ ComputedAttributeDataWithDelta()

template<std::floating_point Real = float>
mmcfilters::ComputedAttributeDataWithDelta< Real >::ComputedAttributeDataWithDelta ( AttributeNamesWithDelta  attrNames,
std::vector< Real buffer,
NodeIdSpace  outputSpace = NodeIdSpace::MORPHOLOGICAL_TREE 
)
inline

Takes ownership of a delta-augmented layout and its flat buffer.

Parameters
attrNamesLayout that maps (attribute, delta) keys to offsets.
bufferAttribute values stored in node-major order.
outputSpaceNode-id domain used by the buffer rows.

Definition at line 101 of file AttributeResultTypes.hpp.

Member Function Documentation

◆ attributeNames() [1/2]

template<std::floating_point Real = float>
const AttributeNamesWithDelta & mmcfilters::ComputedAttributeDataWithDelta< Real >::attributeNames ( ) const
inlinenoexcept

Returns the immutable delta-aware attribute layout.

Definition at line 116 of file AttributeResultTypes.hpp.

◆ attributeNames() [2/2]

template<std::floating_point Real = float>
AttributeNamesWithDelta & mmcfilters::ComputedAttributeDataWithDelta< Real >::attributeNames ( )
inlinenoexcept

Returns the mutable delta-aware attribute layout.

Definition at line 113 of file AttributeResultTypes.hpp.

◆ values() [1/2]

template<std::floating_point Real = float>
const std::vector< Real > & mmcfilters::ComputedAttributeDataWithDelta< Real >::values ( ) const
inlinenoexcept

Returns the immutable flat attribute buffer.

Definition at line 122 of file AttributeResultTypes.hpp.

◆ values() [2/2]

template<std::floating_point Real = float>
std::vector< Real > & mmcfilters::ComputedAttributeDataWithDelta< Real >::values ( )
inlinenoexcept

Returns the mutable flat attribute buffer.

Definition at line 119 of file AttributeResultTypes.hpp.

Member Data Documentation

◆ first

template<std::floating_point Real = float>
AttributeNamesWithDelta mmcfilters::ComputedAttributeDataWithDelta< Real >::first

Delta-aware layout used to interpret second.

Definition at line 86 of file AttributeResultTypes.hpp.

◆ nodeIdSpace

template<std::floating_point Real = float>
NodeIdSpace mmcfilters::ComputedAttributeDataWithDelta< Real >::nodeIdSpace = NodeIdSpace::MORPHOLOGICAL_TREE

Node-id domain used by the rows of second.

Definition at line 92 of file AttributeResultTypes.hpp.

◆ second

template<std::floating_point Real = float>
std::vector<Real> mmcfilters::ComputedAttributeDataWithDelta< Real >::second

Flat per-node, per-delta attribute buffer indexed through first.

Definition at line 89 of file AttributeResultTypes.hpp.


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