Provides a mechanism for splitting a vector into multiple pieces. More...

#include <SplitVector.h>

Inheritance diagram for muq::Modeling::SplitVector:

Detailed Description

Provides a mechanism for splitting a vector into multiple pieces.

Imagine you have a vector $x$ of length $M+N$ that you want to into two vectors $y_1$ and $y_2$ with lengths $M$ and $N$, respectively. This class enables that type of operation.

Typical usage:

// Construct a vector x = [1,2,3,4,5]
Eigen::VectorXd x(5);
x << 1, 2, 3, 4, 5;
 
// Create a SplitVector instance that will extract y1=[1,2,3] and y2=[4,5]
Eigen::VectorXi startInds(2);
startInds << 0, 3; // The indices of x where y1 and y2 start
 
// Set the lengths of each segment.  Note that if this was 2,2 then y1=[1,2] and y2=[4,5]
Eigen::VectorXi sizes(2);
sizes << 3,2;
 
// Create the SplitVector instance
auto split = std::make_shared<SplitVector>(startInds, sizes, 5);
 
// Evaluate the SplitVector instance
std::vector<Eigen::VectorXd> ys = split->Evaluate(x);
 
std::cout << "y1 = [" << ys.at(0).transpose() << "]" << std::endl; // should print [1,2,3]
std::cout << "y2 = [" << ys.at(1).transpose() << "]" << std::endl; // should print [4,5]

Definition at line 42 of file SplitVector.h.

Public Member Functions
	SplitVector (std::vector< int > const &ind, std::vector< int > const &size, unsigned int const insize)

	SplitVector (Eigen::VectorXi const &ind, Eigen::VectorXi const &size, unsigned int const insize)

virtual	~SplitVector ()=default

Eigen::VectorXi	StartIndices () const

Public Member Functions inherited from muq::Modeling::ModPiece
	ModPiece (std::vector< int > const &inputSizes, std::vector< int > const &outputSizes)

	ModPiece (Eigen::VectorXi const &inputSizes, Eigen::VectorXi const &outputSizes)

virtual	~ModPiece ()=default

virtual double	GetRunTime (const std::string &method="Evaluate") const override
	Get the average run time for one of the implemented methods. More...

virtual void	ResetCallTime () override
	Resets the number of call and times. More...

virtual unsigned long int	GetNumCalls (const std::string &method="Evaluate") const override
	get the number of times one of the implemented methods has been called. More...

virtual std::vector< Eigen::VectorXd > const &	Evaluate (std::vector< Eigen::VectorXd > const &input)
	Evaluate the ModPiece. More...

virtual std::vector< Eigen::VectorXd > const &	Evaluate (ref_vector< Eigen::VectorXd > const &input)

	VARIADIC_TO_REFVECTOR (Evaluate, Eigen::VectorXd, std::vector< Eigen::VectorXd > const &)

virtual Eigen::VectorXd const &	Gradient (unsigned int const outputDimWrt, unsigned int const inputDimWrt, std::vector< Eigen::VectorXd > const &input, Eigen::VectorXd const &sensitivity)
	Compute the Gradient $J^Tv$. More...

virtual Eigen::VectorXd const &	Gradient (unsigned int const outputDimWrt, unsigned int const inputDimWrt, ref_vector< Eigen::VectorXd > const &input, Eigen::VectorXd const &sensitivity)

Eigen::VectorXd const &	Gradient (unsigned int outWrt, unsigned int inWrt, Eigen::VectorXd const &last, Eigen::VectorXd const &sens)

template<typename... Args>
Eigen::VectorXd const &	Gradient (unsigned int wrtOut, unsigned int wrtIn, Args const &... args)

Eigen::VectorXd const &	ApplyHessian (unsigned int outWrt, unsigned int inWrt1, unsigned int inWrt2, Eigen::VectorXd const &last, Eigen::VectorXd const &sens, Eigen::VectorXd const &vec)

template<typename... Args>
Eigen::VectorXd const &	ApplyHessian (unsigned int wrtOut, unsigned int wrtIn1, unsigned int wrtIn2, Args const &... args)

virtual Eigen::MatrixXd const &	Jacobian (unsigned int const outputDimWrt, unsigned int const inputDimWrt, std::vector< Eigen::VectorXd > const &input)
	Compute the Jacobian of this ModPiece. More...

virtual Eigen::MatrixXd const &	Jacobian (unsigned int const outputDimWrt, unsigned int const inputDimWrt, ref_vector< Eigen::VectorXd > const &input)

template<typename... Args>
Eigen::MatrixXd const &	Jacobian (unsigned int outWrt, unsigned int inWrt, Args const &... args)

template<typename... Args>
Eigen::MatrixXd	JacobianByFD (unsigned int outWrt, unsigned int inWrt, Args const &... args)

template<typename... Args>
Eigen::MatrixXd	ApplyJacobianByFD (unsigned int outWrt, unsigned int inWrt, Args const &... args)

virtual Eigen::VectorXd const &	ApplyJacobian (unsigned int const outputDimWrt, unsigned int const inputDimWrt, std::vector< Eigen::VectorXd > const &input, Eigen::VectorXd const &vec)
	Apply the Jacobian of this ModPiece to a vector. More...

virtual Eigen::VectorXd const &	ApplyJacobian (unsigned int const outputDimWrt, unsigned int const inputDimWrt, ref_vector< Eigen::VectorXd > const &input, Eigen::VectorXd const &vec)

Eigen::VectorXd const &	ApplyJacobian (unsigned int outWrt, unsigned int inWrt, Eigen::VectorXd const &last, Eigen::VectorXd const &sens)

template<typename... Args>
Eigen::VectorXd const &	ApplyJacobian (unsigned int wrtOut, unsigned int wrtIn, Args const &... args)

virtual Eigen::VectorXd	GradientByFD (unsigned int const outputDimWrt, unsigned int const inputDimWrt, std::vector< Eigen::VectorXd > const &input, Eigen::VectorXd const &sensitivity)

virtual Eigen::VectorXd	GradientByFD (unsigned int const outputDimWrt, unsigned int const inputDimWrt, ref_vector< Eigen::VectorXd > const &input, Eigen::VectorXd const &sensitivity)

virtual Eigen::MatrixXd	JacobianByFD (unsigned int const outputDimWrt, unsigned int const inputDimWrt, std::vector< Eigen::VectorXd > const &input)

virtual Eigen::MatrixXd	JacobianByFD (unsigned int const outputDimWrt, unsigned int const inputDimWrt, ref_vector< Eigen::VectorXd > const &input)

virtual Eigen::VectorXd	ApplyJacobianByFD (unsigned int const outputDimWrt, unsigned int const inputDimWrt, std::vector< Eigen::VectorXd > const &input, Eigen::VectorXd const &vec)

virtual Eigen::VectorXd	ApplyJacobianByFD (unsigned int const outputDimWrt, unsigned int const inputDimWrt, ref_vector< Eigen::VectorXd > const &input, Eigen::VectorXd const &vec)

virtual Eigen::VectorXd const &	ApplyHessian (unsigned int const outWrt, unsigned int const inWrt1, unsigned int const inWrt2, std::vector< Eigen::VectorXd > const &input, Eigen::VectorXd const &sens, Eigen::VectorXd const &vec)

virtual Eigen::VectorXd const &	ApplyHessian (unsigned int const outWrt, unsigned int const inWrt1, unsigned int const inWrt2, ref_vector< Eigen::VectorXd > const &input, Eigen::VectorXd const &sens, Eigen::VectorXd const &vec)

virtual Eigen::VectorXd	ApplyHessianByFD (unsigned int const outWrt, unsigned int const inWrt1, unsigned int const inWrt2, std::vector< Eigen::VectorXd > const &input, Eigen::VectorXd const &sens, Eigen::VectorXd const &vec)

virtual Eigen::VectorXd	ApplyHessianByFD (unsigned int const outWrt, unsigned int const inWrt1, unsigned int const inWrt2, ref_vector< Eigen::VectorXd > const &input, Eigen::VectorXd const &sens, Eigen::VectorXd const &vec)

void	EnableCache ()

void	DisableCache ()

bool	CacheStatus () const

virtual void	SetWarnLevel (unsigned int newLevel)

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

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::ModPiece
const Eigen::VectorXi	inputSizes

const Eigen::VectorXi	outputSizes

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

int	numOutputs
	The number of outputs. More...

Constructor & Destructor Documentation

◆ SplitVector() [1/2]

SplitVector::SplitVector	(	std::vector< int > const &	ind,
		std::vector< int > const &	size,
		unsigned int const	insize
	)

Parameters

[in]	ind	The first index of the segment for each output
[in]	size	The size of each segment
[in]	insize	The size of the input vector

Definition at line 5 of file SplitVector.cpp.

◆ SplitVector() [2/2]

SplitVector::SplitVector	(	Eigen::VectorXi const &	ind,
		Eigen::VectorXi const &	size,
		unsigned int const	insize
	)

Parameters

[in]	ind	The first index of the segment for each output
[in]	size	The size of each segment
[in]	insize	The size of the input vector

Definition at line 11 of file SplitVector.cpp.

References ind, and size.

◆ ~SplitVector()

virtual muq::Modeling::SplitVector::~SplitVector ( )

virtualdefault

Member Function Documentation

◆ ApplyHessianImpl()

void SplitVector::ApplyHessianImpl	(	unsigned int const	outwrt,
		unsigned int const	inwrt1,
		unsigned int const	inwrt2,
		ref_vector< Eigen::VectorXd > const &	inputs,
		Eigen::VectorXd const &	sens,
		Eigen::VectorXd const &	targ
	)

overrideprivatevirtual

Reimplemented from muq::Modeling::ModPiece.

Definition at line 49 of file SplitVector.cpp.

References muq::Modeling::ModPiece::hessAction, ind, muq::Modeling::ModPiece::inputSizes, and size.

◆ ApplyJacobianImpl()

void SplitVector::ApplyJacobianImpl	(	unsigned int const	outwrt,
		unsigned int const	inwrt,
		ref_vector< Eigen::VectorXd > const &	inputs,
		Eigen::VectorXd const &	targ
	)

overrideprivatevirtual

Reimplemented from muq::Modeling::ModPiece.

Definition at line 43 of file SplitVector.cpp.

References ind, muq::Modeling::ModPiece::inputSizes, muq::Modeling::ModPiece::jacobianAction, and size.

◆ EvaluateImpl()

void SplitVector::EvaluateImpl ( ref_vector< Eigen::VectorXd > const & inputs )

overrideprivatevirtual

Implements muq::Modeling::ModPiece.

Definition at line 21 of file SplitVector.cpp.

References ind, muq::Modeling::ModPiece::outputs, and size.

◆ GradientImpl()

void SplitVector::GradientImpl	(	unsigned int const	outwrt,
		unsigned int const	inwrt,
		ref_vector< Eigen::VectorXd > const &	inputs,
		Eigen::VectorXd const &	sens
	)

overrideprivatevirtual

Reimplemented from muq::Modeling::ModPiece.

Definition at line 36 of file SplitVector.cpp.

References muq::Modeling::ModPiece::gradient, ind, muq::Modeling::ModPiece::inputSizes, and size.

◆ JacobianImpl()

void SplitVector::JacobianImpl	(	unsigned int const	outwrt,
		unsigned int const	inwrt,
		ref_vector< Eigen::VectorXd > const &	inputs
	)

overrideprivatevirtual

Reimplemented from muq::Modeling::ModPiece.

Definition at line 30 of file SplitVector.cpp.

References ind, muq::Modeling::ModPiece::inputSizes, muq::Modeling::ModPiece::jacobian, and size.

◆ StartIndices()

Eigen::VectorXi muq::Modeling::SplitVector::StartIndices ( ) const

inline

Returns a vector containing the indices of the input vecto where each segment returned in the output begins.

Definition at line 64 of file SplitVector.h.

References ind.

Member Data Documentation

◆ ind

const Eigen::VectorXi muq::Modeling::SplitVector::ind

private

Definition at line 78 of file SplitVector.h.

Referenced by ApplyHessianImpl(), ApplyJacobianImpl(), EvaluateImpl(), GradientImpl(), JacobianImpl(), SplitVector(), and StartIndices().

◆ size

const Eigen::VectorXi muq::Modeling::SplitVector::size

private

Definition at line 80 of file SplitVector.h.

Referenced by ApplyHessianImpl(), ApplyJacobianImpl(), EvaluateImpl(), GradientImpl(), JacobianImpl(), and SplitVector().

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

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

Detailed Description

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ SplitVector() [1/2]

◆ SplitVector() [2/2]

◆ ~SplitVector()

Member Function Documentation

◆ ApplyHessianImpl()

◆ ApplyJacobianImpl()

◆ EvaluateImpl()

◆ GradientImpl()

◆ JacobianImpl()

◆ StartIndices()

Member Data Documentation

◆ ind

◆ size