muq::Approximation::IndexedScalarBasis Class Reference

#include <IndexedScalarBasis.h>

Inheritance diagram for muq::Approximation::IndexedScalarBasis:

Detailed Description

Definition at line 22 of file IndexedScalarBasis.h.

Public Types
typedef std::function< std::shared_ptr< IndexedScalarBasis >)>	ScalarBasisConstructorType
typedef std::map< std::string, ScalarBasisConstructorType >	ScalarBasisMapType

Public Member Functions
	IndexedScalarBasis ()
	Create a basis function. More...
virtual	~IndexedScalarBasis ()=default
virtual double	BasisEvaluate (int const order, double const x) const =0
	Evaluate the specific basis type (must be implemented by the child) More...
virtual Eigen::VectorXd	EvaluateAllTerms (int const maxOrder, double const x) const
	Evaluates all basis functions with order <= maxOrder. More...
virtual double	DerivativeEvaluate (int const polyOrder, int const derivOrder, double const x) const =0
Public Member Functions inherited from muq::Modeling::WorkPiece
	WorkPiece ()
	Create a muq::Modeling::WorkPiece with no fixed number of inputs and outputs and variable input/output types. More...
	WorkPiece (int const num, WorkPiece::Fix const fix=WorkPiece::Fix::Inputs)
	Create a muq::Modeling::WorkPiece with either a fixed number of inputs or outputs and variable input/output types. More...
	WorkPiece (int const numIns, int const numOuts)
	Create a muq::Modeling::WorkPiece with a fixed number of inputs and outputs but variable input/output types. More...
	WorkPiece (std::vector< std::string > const &types, WorkPiece::Fix const fix=WorkPiece::Fix::Inputs)
	Create a muq::Modeling::WorkPiece with either a fixed number of inputs with specified types or a fixed number of outputs with specified types. More...
	WorkPiece (std::map< unsigned int, std::string > const &types, WorkPiece::Fix const fix=WorkPiece::Fix::Inputs)
	Create a muq::Modeling::WorkPiece where either some of the inputs have specified types or some of the outputs have specified types. More...
	WorkPiece (std::map< unsigned int, std::string > const &types, int const num, WorkPiece::Fix const fixTypes=WorkPiece::Fix::Inputs, WorkPiece::Fix const fixNum=WorkPiece::Fix::Inputs)
	Create a muq::Modeling::WorkPiece where either some of the inputs have specified types or some of the outputs have specified types and either the number of inputs or the number of outputs is fixed. More...
	WorkPiece (std::vector< std::string > const &types, int const num)
	Create a muq::Modeling::WorkPiece with a fixed number of inputs with specified types and a fixed number of outputs (of uknown type) More...
	WorkPiece (int const num, std::vector< std::string > const &types)
	Create a muq::Modeling::WorkPiece with a fixed number of outputs with specified types and a fixed number of inputs (of uknown type) More...
	WorkPiece (std::map< unsigned int, std::string > const &inTypes, int const numIns, int const numOuts)
	Create a muq::Modeling::WorkPiece where some of the inputs are known and we know the input and output numbers. More...
	WorkPiece (int const numIns, std::map< unsigned int, std::string > const &outTypes, int const numOuts)
	Create a muq::Modeling::WorkPiece where some of the outputs are known and we know the input and output numbers. More...
	WorkPiece (std::vector< std::string > const &inTypes, std::vector< std::string > const &outTypes)
	Create a muq::Modeling::WorkPiece with a fixed number of inputs and outputs with specified types. More...
	WorkPiece (std::map< unsigned int, std::string > const &inTypes, std::vector< std::string > const &outTypes)
	Create a muq::Modeling::WorkPiece where some of the inputs are known and all of the outputs have specified types. More...
	WorkPiece (std::map< unsigned int, std::string > const &inTypes, int const num, std::vector< std::string > const &outTypes)
	Create a muq::Modeling::WorkPiece where some of the inputs are known with a known number of inputs and all of the outputs have specified types. More...
	WorkPiece (std::vector< std::string > const &inTypes, std::map< unsigned int, std::string > const &outTypes)
	Create a muq::Modeling::WorkPiece where some of the outputs and all of the inputs have specified types. More...
	WorkPiece (std::vector< std::string > const &inTypes, std::map< unsigned int, std::string > const &outTypes, int const num)
	Create a muq::Modeling::WorkPiece where some of the outputs with a known number of outputs and all of the inputs have specified types. More...
	WorkPiece (std::map< unsigned int, std::string > const &inTypes, std::map< unsigned int, std::string > const &outTypes)
	Create a muq::Mdoeling::WorkPiece where some of the inputs and some of the outputs have specified types. More...
	WorkPiece (std::map< unsigned int, std::string > const &inTypes, int const numIn, std::map< unsigned int, std::string > const &outTypes)
	Create a muq::Mdoeling::WorkPiece where some of the inputs and some of the outputs have specified types with a fixed number of inputs. More...
	WorkPiece (std::map< unsigned int, std::string > const &inTypes, std::map< unsigned int, std::string > const &outTypes, int const numOut)
	Create a muq::Mdoeling::WorkPiece where some of the inputs and some of the outputs have specified types with a fixed number of outputs. More...
	WorkPiece (std::map< unsigned int, std::string > const &inTypes, int const numIn, std::map< unsigned int, std::string > const &outTypes, int const numOut)
	Create a muq::Mdoeling::WorkPiece where some of the inputs and some of the outputs have specified types with a fixed number of inputs and outputs. More...
virtual	~WorkPiece ()
	Default destructor. More...
std::vector< boost::any > const &	Evaluate (std::vector< boost::any > const &ins)
	Evaluate this muq::Modeling::WorkPiece. More...
std::vector< boost::any > const &	Evaluate (ref_vector< boost::any > const &ins)
	Evaluate this muq::Modeling::WorkPiece using references to the inputs. More...
std::vector< boost::any > const &	Evaluate ()
	Evaluate this muq::Modeling::WorkPiece in the case that there are no inputs. More...
template<typename... Args>
std::vector< boost::any > const &	Evaluate (Args... args)
	Evalaute this muq::Modeling::WorkPiece using multiple arguments. More...
std::string const &	Name ()
	Get the (unique) name of this work piece. More...
void	SetName (std::string const &newName)
	Set the name of this work piece. More...
std::string	InputType (unsigned int inputNum, bool const demangle=true) const
	Get the input type (if we know it) for a specific input. More...
int	InputSize (unsigned int inputNum) const
	Get the length of a vector valued input with fixed size. More...
void	SetInputSize (unsigned int inputNum, int newSize)
std::string	OutputType (unsigned int outputNum, bool const demangle=true) const
	Get the output type (if we know it) for a specific output. More...
std::map< unsigned int, std::string >	OutputTypes () const
	Get the output types. More...
std::map< unsigned int, std::string >	InputTypes () const
	Get the input types. More...
unsigned int	ID () const
	Get the unique ID number. More...
virtual double	GetRunTime (const std::string &method="Evaluate") const
	Get the average run time for one of the implemented methods. More...
virtual unsigned long int	GetNumCalls (const std::string &method="Evaluate") const
	get the number of times one of the implemented methods has been called. More...
virtual void	ResetCallTime ()
	Resets the number of call and times. More...

Static Public Member Functions
static std::shared_ptr< ScalarBasisMapType >	GetScalarBasisMap ()
static std::shared_ptr< IndexedScalarBasis >	Construct (std::string const &polyName)
Static Public Member Functions inherited from muq::Modeling::WorkPiece
static ref_vector< const boost::any >	ToRefVector (std::vector< boost::any > const &anyVec)
	Create vector of references from a vector of boost::any's. More...
static ref_vector< const Eigen::VectorXd >	ToRefVector (std::vector< Eigen::VectorXd > const &anyVec)

Additional Inherited Members
Public Attributes inherited from muq::Modeling::WorkPiece
int	numInputs
	The number of inputs. More...
int	numOutputs
	The number of outputs. More...

Member Typedef Documentation

ScalarBasisConstructorType

typedef std::function<std::shared_ptr<IndexedScalarBasis>)> muq::Approximation::IndexedScalarBasis::ScalarBasisConstructorType

Definition at line 26 of file IndexedScalarBasis.h.

ScalarBasisMapType

typedef std::map<std::string, ScalarBasisConstructorType> muq::Approximation::IndexedScalarBasis::ScalarBasisMapType

Definition at line 27 of file IndexedScalarBasis.h.

Constructor & Destructor Documentation

IndexedScalarBasis()

IndexedScalarBasis::IndexedScalarBasis

(

)

Create a basis function.

Definition at line 13 of file IndexedScalarBasis.cpp.

References muq::Modeling::WorkPiece::name.

~IndexedScalarBasis()

virtual muq::Approximation::IndexedScalarBasis::~IndexedScalarBasis ( )

virtualdefault

Member Function Documentation

BasisEvaluate()

virtual double muq::Approximation::IndexedScalarBasis::BasisEvaluate ( int const  order, double const  x  ) const

pure virtual

Evaluate the specific basis type (must be implemented by the child)

Parameters

[in]	order	The integer index of the polynomial (e.g., polynomial order)
[in]	x	The point where we are evaluating the polynomial

Returns

The polynomial value

Implemented in muq::Approximation::OrthogonalPolynomial, muq::Approximation::Monomial, and muq::Approximation::HermiteFunction.

Referenced by EvaluateAllTerms(), and EvaluateImpl().

Construct()

std::shared_ptr< IndexedScalarBasis > IndexedScalarBasis::Construct ( std::string const &  polyName )

static

Definition at line 30 of file IndexedScalarBasis.cpp.

References GetScalarBasisMap().

Referenced by muq::Approximation::BasisExpansion::FromHDF5(), and muq::Approximation::Regression::Regression().

DerivativeEvaluate()

virtual double muq::Approximation::IndexedScalarBasis::DerivativeEvaluate ( int const  polyOrder, int const  derivOrder, double const  x  ) const

pure virtual

Evaluate the \(n^{th}\) derivative of a \(p^{th}\) basis.

Parameters

[in]	polyOrder	The integer index \(p\) of the basis.
[in]	derivOrder	The order \(n\) of the derivative.
[in]	x	The location to evaluate the derivative.

Returns

The the \(n^{th}\) derivative of a \(p^{th}\) basis

Implemented in muq::Approximation::ProbabilistHermite, muq::Approximation::PhysicistHermite, muq::Approximation::Monomial, muq::Approximation::Legendre, muq::Approximation::Laguerre, muq::Approximation::Jacobi, and muq::Approximation::HermiteFunction.

EvaluateAllTerms()

virtual Eigen::VectorXd muq::Approximation::IndexedScalarBasis::EvaluateAllTerms ( int const  maxOrder, double const  x  ) const

inlinevirtual

Evaluates all basis functions with order <= maxOrder.

Reimplemented in muq::Approximation::OrthogonalPolynomial.

Definition at line 49 of file IndexedScalarBasis.h.

References BasisEvaluate().

EvaluateImpl()

void IndexedScalarBasis::EvaluateImpl ( muq::Modeling::ref_vector< boost::any > const &  inputs )

privatevirtual

Evaluate the polynomial at a given point and order.

Implements muq::Modeling::WorkPiece.

Definition at line 18 of file IndexedScalarBasis.cpp.

References BasisEvaluate(), and muq::Modeling::WorkPiece::outputs.

GetScalarBasisMap()

std::shared_ptr< IndexedScalarBasis::ScalarBasisMapType > IndexedScalarBasis::GetScalarBasisMap ( )

static

Definition at line 47 of file IndexedScalarBasis.cpp.

Referenced by Construct(), and muq::Approximation::BasisExpansion::ToHDF5().

---

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

• doxygen_prep/MUQ/Approximation/Polynomials/IndexedScalarBasis.h
• doxygen_prep/modules/Approximation/src/Polynomials/IndexedScalarBasis.cpp