Detailed Description

A muq::Modeling::WorkPiece with no inputs and known, constant outputs.

Definition at line 9 of file ConstantPiece.h.

Public Member Functions
	ConstantPiece (std::vector< boost::any > const &outs)
	Create a muq::Modeling::ConstantPiece with the outputs given in a vector. More...

	ConstantPiece ()
	Create a muq::Modeling::ConstantPiece with no given outputs. More...

template<typename ith , typename... Args>
void	SetOutputs (ith const &in, Args... args)
	Create a muq::Modeling::ConstantPiece with the outputs given indivually. More...

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...

Additional Inherited Members
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)

Public Attributes inherited from muq::Modeling::WorkPiece
int	numInputs
	The number of inputs. More...

int	numOutputs
	The number of outputs. More...

Constructor & Destructor Documentation

◆ ConstantPiece() [1/2]

ConstantPiece::ConstantPiece ( std::vector< boost::any > const & outs )

Create a muq::Modeling::ConstantPiece with the outputs given in a vector.

Parameters

[in] outs The outputs

Definition at line 5 of file ConstantPiece.cpp.

References muq::Modeling::WorkPiece::clearOutputs, muq::Modeling::WorkPiece::numOutputs, and muq::Modeling::WorkPiece::outputs.

◆ ConstantPiece() [2/2]

ConstantPiece::ConstantPiece ( )

Create a muq::Modeling::ConstantPiece with no given outputs.

This creates a WorkPiece that takes no inputs and returns no outputs. The user can set the outputs to any thing after construction. The number of outputs is set to be variable.

Definition at line 14 of file ConstantPiece.cpp.

References muq::Modeling::WorkPiece::clearOutputs.

Member Function Documentation

◆ SetOutputs()

template<typename ith , typename... Args>

void ConstantPiece::SetOutputs	(	ith const &	in,
		Args...	args
	)

inline

Create a muq::Modeling::ConstantPiece with the outputs given indivually.

The number of outputs is -1 (variable) even though we know the outputs.

Parameters

[in]	in	The $i^{th}]f$ input @param[in] args The $[i+1, N \(] outputs / template<typename ith, typename... Args> ConstantPiece(ith const& in, Args... args) : ConstantPiece(args...) { // add this output to the begining of the output vector outputs.insert(outputs.begin(), in); // set the number of outputs numOutputs = outputs.size(); // set the output types outputTypes = Types(Types(outputs)); } Create a muq::Modeling::ConstantPiece with the outputs given indivually /* The number of outputs is -1 (variable) even though we know the outputs. @param[in] last the last output / template<typename last> ConstantPiece(last const& in) : WorkPiece(0, WorkPiece::Fix::Inputs) { // the outputs will never change so we should not clear them clearOutputs = false; // add this output to the begining of the output vector outputs.insert(outputs.begin(), in); // set the number of outputs numOutputs = outputs.size(); // set the output types outputTypes = Types(Types(outputs)); } Set the outputs to be empty void SetOutputs(); Set the outputs /* @param[in] outs The new outputs / void SetOutputs(std::vector<boost::any> const& outs); set the outputs with the outputs given indivually /* @param[in] in The \)@_fakenli^{th}]f$ input
[in]	args	The $[i+1, N$] outputs

Definition at line 77 of file ConstantPiece.h.

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

doxygen_prep/MUQ/Modeling/ConstantPiece.h
doxygen_prep/modules/Modeling/src/ConstantPiece.cpp

[in]	in	The \(i^{th}]f$ input @param[in] args The \)[i+1, N \(] outputs / template<typename ith, typename... Args> ConstantPiece(ith const& in, Args... args) : ConstantPiece(args...) { // add this output to the begining of the output vector outputs.insert(outputs.begin(), in); // set the number of outputs numOutputs = outputs.size(); // set the output types outputTypes = Types(Types(outputs)); } Create a muq::Modeling::ConstantPiece with the outputs given indivually /* The number of outputs is -1 (variable) even though we know the outputs. @param[in] last the last output / template<typename last> ConstantPiece(last const& in) : WorkPiece(0, WorkPiece::Fix::Inputs) { // the outputs will never change so we should not clear them clearOutputs = false; // add this output to the begining of the output vector outputs.insert(outputs.begin(), in); // set the number of outputs numOutputs = outputs.size(); // set the output types outputTypes = Types(Types(outputs)); } Set the outputs to be empty void SetOutputs(); Set the outputs /* @param[in] outs The new outputs / void SetOutputs(std::vector<boost::any> const& outs); set the outputs with the outputs given indivually /* @param[in] in The \)@_fakenli^{th}]f$ input
[in]	args	The \([i+1, N\)] outputs