muq::Utilities::MultiIndexLimiter Class Reference

An abstract base class for multi index limiters. More...

#include <MultiIndexLimiter.h>

Inheritance diagram for muq::Utilities::MultiIndexLimiter:

Detailed Description

An abstract base class for multi index limiters.

When constructing or adapting MultiIndex sets, some applications may need to impose additional requirements on what terms should be included. This class provides a mechanism for adding that information to the MultiIndexSet. The pure virtual function IsFeasible is overloaded by children to test individual multiindices. If IsFeasible returns false for a given MultiIndex, the multiindex will not be included as an active member of the MultiIndexSet.

See also

muq::Utilities::MultiIndexSet muq::Utilities::MultiIndex

Definition at line 17 of file MultiIndexLimiter.h.

Public Member Functions
virtual	~MultiIndexLimiter ()=default
virtual bool	IsFeasible (std::shared_ptr< MultiIndex > multi) const =0

Constructor & Destructor Documentation

~MultiIndexLimiter()

virtual muq::Utilities::MultiIndexLimiter::~MultiIndexLimiter ( )

virtualdefault

Member Function Documentation

IsFeasible()

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

pure virtual

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

Implemented in muq::Utilities::XorLimiter, muq::Utilities::OrLimiter, muq::Utilities::AndLimiter, muq::Utilities::NoLimiter, muq::Utilities::MaxOrderLimiter, muq::Utilities::AnisotropicLimiter, muq::Utilities::DimensionLimiter, and muq::Utilities::TotalOrderLimiter.

---

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

• doxygen_prep/MUQ/Utilities/MultiIndices/MultiIndexLimiter.h