Detailed Description

Provides a cap on the total-order allowed.

This limter only allows terms that satisfy \(\|\mathbf{j}\|_1\leq p_U\), where \(\mathbf{j}\) is the multiindex, and \(p_U\) is a nonnegative integer passed to the constructor of this class.

Definition at line 32 of file MultiIndexLimiter.h.

Public Member Functions
	TotalOrderLimiter (unsigned int totalOrderIn)

virtual	~TotalOrderLimiter ()=default

virtual bool	IsFeasible (std::shared_ptr< MultiIndex > multi) const override

Public Member Functions inherited from muq::Utilities::MultiIndexLimiter
virtual	~MultiIndexLimiter ()=default

Constructor & Destructor Documentation

◆ TotalOrderLimiter() [1/2]

muq::Utilities::TotalOrderLimiter::TotalOrderLimiter ( unsigned int totalOrderIn )

inline

Definition at line 36 of file MultiIndexLimiter.h.

◆ ~TotalOrderLimiter()

virtual muq::Utilities::TotalOrderLimiter::~TotalOrderLimiter ( )

virtualdefault

◆ TotalOrderLimiter() [2/2]

muq::Utilities::TotalOrderLimiter::TotalOrderLimiter ( )

inlineprivate

Definition at line 42 of file MultiIndexLimiter.h.

Member Function Documentation

◆ IsFeasible()

virtual bool muq::Utilities::TotalOrderLimiter::IsFeasible ( std::shared_ptr< MultiIndex > multi ) const

inlineoverridevirtual

This function is overloaded by children to define what terms are included.

Implements muq::Utilities::MultiIndexLimiter.

Definition at line 39 of file MultiIndexLimiter.h.

References totalOrder.

Member Data Documentation

◆ totalOrder

unsigned int muq::Utilities::TotalOrderLimiter::totalOrder

private

Definition at line 44 of file MultiIndexLimiter.h.

Referenced by IsFeasible().

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

doxygen_prep/MUQ/Utilities/MultiIndices/MultiIndexLimiter.h