mmcfilters::sdrt::SelfDualResidualSchedule Class Reference

Selects the next residual candidate from the canonical self-dual order. More...

#include <ResidualEvolution.hpp>

Public Member Functions
	SelfDualResidualSchedule (SpatialOrder spatialOrder=RowMajorSpatialOrder{})
	Creates the unique canonical residual schedule.
std::size_t	selectResidualCandidate (std::span< const SelfDualResidualKey > residualKeys) const
	Returns the index of the first key in canonical residual order.
const SelfDualResidualOrder &	residualOrder () const noexcept
	Returns the canonical key order used by this schedule.

Detailed Description

Selects the next residual candidate from the canonical self-dual order.

Definition at line 190 of file ResidualEvolution.hpp.

Constructor & Destructor Documentation

SelfDualResidualSchedule()

mmcfilters::sdrt::SelfDualResidualSchedule::SelfDualResidualSchedule ( SpatialOrder  spatialOrder = RowMajorSpatialOrder{} )

inlineexplicit

Creates the unique canonical residual schedule.

Parameters

spatialOrder

Total order used by equal-cardinality candidates.

Definition at line 196 of file ResidualEvolution.hpp.

Member Function Documentation

residualOrder()

const SelfDualResidualOrder & mmcfilters::sdrt::SelfDualResidualSchedule::residualOrder ( ) const

inlinenoexcept

Returns the canonical key order used by this schedule.

Returns

Residual-key order owned by the schedule.

Definition at line 225 of file ResidualEvolution.hpp.

selectResidualCandidate()

std::size_t mmcfilters::sdrt::SelfDualResidualSchedule::selectResidualCandidate ( std::span< const SelfDualResidualKey >  residualKeys ) const

inline

Returns the index of the first key in canonical residual order.

Parameters

residualKeys

Non-empty candidate-key sequence.

Returns

Index of the least candidate key.

Definition at line 204 of file ResidualEvolution.hpp.

---

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

• mmcfilters/trees/sdrt/ResidualEvolution.hpp