MUQ  0.4.3
Public Member Functions | List of all members
muq::Utilities::MaxOrderLimiter Class Reference

Provides a cap on the maximum value of each component the multiindex. More...

#include <MultiIndexLimiter.h>

Inheritance diagram for muq::Utilities::MaxOrderLimiter:
[legend]

Detailed Description

Provides a cap on the maximum value of each component the multiindex.

This limter only allows terms that satisfy \(\mathbf{j}_i\leq p_i\) for \(i\in \{1,2,\ldots,D\}\), where \(p\) is a vector of upper bounds.

Definition at line 129 of file MultiIndexLimiter.h.

Public Member Functions

 MaxOrderLimiter (unsigned int maxOrderIn)
 
 MaxOrderLimiter (Eigen::VectorXi const &maxOrdersIn)
 
virtual ~MaxOrderLimiter ()=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

◆ MaxOrderLimiter() [1/3]

muq::Utilities::MaxOrderLimiter::MaxOrderLimiter ( unsigned int  maxOrderIn)
inline

Definition at line 132 of file MultiIndexLimiter.h.

◆ MaxOrderLimiter() [2/3]

muq::Utilities::MaxOrderLimiter::MaxOrderLimiter ( Eigen::VectorXi const &  maxOrdersIn)
inline

Definition at line 133 of file MultiIndexLimiter.h.

◆ ~MaxOrderLimiter()

virtual muq::Utilities::MaxOrderLimiter::~MaxOrderLimiter ( )
virtualdefault

◆ MaxOrderLimiter() [3/3]

muq::Utilities::MaxOrderLimiter::MaxOrderLimiter ( )
inlineprivate

Definition at line 140 of file MultiIndexLimiter.h.

Member Function Documentation

◆ IsFeasible()

bool muq::Utilities::MaxOrderLimiter::IsFeasible ( std::shared_ptr< MultiIndex >  multi) const
overridevirtual

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

Implements muq::Utilities::MultiIndexLimiter.

Definition at line 36 of file MultiIndexLimiter.cpp.

Member Data Documentation

◆ maxOrder

int muq::Utilities::MaxOrderLimiter::maxOrder
private

Definition at line 142 of file MultiIndexLimiter.h.

◆ maxOrders

Eigen::VectorXi muq::Utilities::MaxOrderLimiter::maxOrders
private

Definition at line 143 of file MultiIndexLimiter.h.

◆ vectorMin

int muq::Utilities::MaxOrderLimiter::vectorMin
private

Definition at line 144 of file MultiIndexLimiter.h.

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