MUQ  0.4.3
muq::Utilities::DimensionLimiter Class Reference

Provides bounds on what dimensions are allowed to have nonzero values. More...

#include <MultiIndexLimiter.h>

Inheritance diagram for muq::Utilities::DimensionLimiter:

Detailed Description

Provides bounds on what dimensions are allowed to have nonzero values.

This limiter only allows terms that satisfy \(\mathbf{j}_d = 0 \) for \(d<D_L\) or \(d>=D_L+M\) for a lower bound \(D_L\) and length \(M\).

Definition at line 54 of file MultiIndexLimiter.h.

Public Member Functions

 DimensionLimiter (unsigned int lowerDimIn, unsigned int lengthIn)
 
virtual ~DimensionLimiter ()=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

◆ DimensionLimiter() [1/2]

muq::Utilities::DimensionLimiter::DimensionLimiter ( unsigned int  lowerDimIn,
unsigned int  lengthIn 
)
inline

Definition at line 58 of file MultiIndexLimiter.h.

◆ ~DimensionLimiter()

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

◆ DimensionLimiter() [2/2]

muq::Utilities::DimensionLimiter::DimensionLimiter ( )
inlineprivate

Definition at line 64 of file MultiIndexLimiter.h.

Member Function Documentation

◆ IsFeasible()

bool muq::Utilities::DimensionLimiter::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 4 of file MultiIndexLimiter.cpp.

References length, and lowerDim.

Member Data Documentation

◆ length

unsigned int muq::Utilities::DimensionLimiter::length
private

Definition at line 67 of file MultiIndexLimiter.h.

Referenced by IsFeasible().

◆ lowerDim

unsigned int muq::Utilities::DimensionLimiter::lowerDim
private

Definition at line 66 of file MultiIndexLimiter.h.

Referenced by IsFeasible().


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