LOCA's container for holding a set of parameters that are used by the LOCA continuation routines. More...

#include <LOCA_Parameter_Vector.H>

Public Member Functions
	ParameterVector ()
	Constructor.
	ParameterVector (const ParameterVector &source)
	Copy constructor.
ParameterVector *	clone () const
	Clone.
	~ParameterVector ()
	Destructor.
int	addParameter (std::string label, double value=0.0)
	Adds a parameter to the list. Returns the index value assigned to the parameter.
bool	init (double value)
	Initialize the vector. Returns true if successful.
bool	scale (double value)
	Scales the entire vector by value. Returns true if successful.
bool	scale (const ParameterVector &p)
	Scales the vactor with another vector (element-wise multiply). Returns true if successful.
bool	update (double alpha, const ParameterVector &alphaVector, double b)
	Updates the parameter vector: this = alpha * alphaVector + b * this. Returns true if successful.
ParameterVector &	operator= (const ParameterVector &y)
	Set a parameter vector equal to another. This will erase any old parameters in the object.
double &	operator[] (unsigned int i)
	Return a reference to the i-th element. Will throw an error if index is out of range.
const double &	operator[] (unsigned int i) const
	Return a reference to the i-th element (no l-value type). Will throw an error if index is out of range.
void	setValue (unsigned int i, double value)
	Set the value of the parameter with index i. Will throw an error if index is out of range.
void	setValue (std::string label, double value)
	Set the value of the parameter with the corresponding label. Will throw an error if "label" is not valid.
double	getValue (unsigned int i) const
	Returns the value of the parameter with index i. Will throw an error if index is out of range.
double	getValue (std::string label) const
	Returns the value of the parameter with the corresponding label. Will throw an error if "label" is not valid.
int	getIndex (std::string label) const
	Returns the index of the parameter with the corresponding label. Returns a -1 if "label" is not found.
double *	getDoubleArrayPointer ()
	Returns a pointer to a C-style array of the parameter values.
bool	isParameter (std::string label) const
	Returns true if the parameter std::string "label" corresponds to a parameter label in the object.
std::string	getLabel (unsigned int i) const
	Returns the label of the parameter with index i.
int	length () const
	Returns the length of parameter vector.
void	print (std::ostream &stream) const
	Prints the vector to cout.
const std::vector< double > &	getValuesVector () const
	Accessor to get the underlying stl vector with all parameter values.
const std::vector< std::string > &	getNamesVector () const
	Accessor to get the underlying stl vector with all parameter names.

Protected Attributes
std::vector< double >	x
	Parameter values.
std::vector< std::string >	l
	Parameter names.

Detailed Description

LOCA's container for holding a set of parameters that are used by the LOCA continuation routines.

Author: Roger Pawlowski (SNL 9233)

Constructor & Destructor Documentation

◆ ParameterVector() [1/2]

LOCA::ParameterVector::ParameterVector ( )

Constructor.

References l, and x.

◆ ParameterVector() [2/2]

LOCA::ParameterVector::ParameterVector ( const ParameterVector & source )

Copy constructor.

References l, and x.

Member Function Documentation

◆ addParameter()

int LOCA::ParameterVector::addParameter	(	std::string	label,
		double	value = 0.0 )

Adds a parameter to the list. Returns the index value assigned to the parameter.

References l, and x.

Referenced by LOCA::Homotopy::DeflatedGroup::DeflatedGroup(), LOCA::Homotopy::Group::Group(), LOCA::Homotopy::Group::Group(), and LOCA::Epetra::ModelEvaluatorInterface::ModelEvaluatorInterface().

◆ getDoubleArrayPointer()

double * LOCA::ParameterVector::getDoubleArrayPointer ( )

Returns a pointer to a C-style array of the parameter values.

References x.

◆ getIndex()

int LOCA::ParameterVector::getIndex ( std::string label ) const

Returns the index of the parameter with the corresponding label. Returns a -1 if "label" is not found.

References l, and x.

Referenced by LOCA::AdaptiveStepper::buildConstrainedGroup(), LOCA::Epetra::AdaptiveStepper::buildConstrainedGroup(), LOCA::MultiStepper::buildConstrainedGroup(), LOCA::Stepper::buildConstrainedGroup(), LOCA::Homotopy::DeflatedGroup::DeflatedGroup(), LOCA::Hopf::MinimallyAugmented::ExtendedGroup::ExtendedGroup(), LOCA::Pitchfork::MinimallyAugmented::ExtendedGroup::ExtendedGroup(), LOCA::Homotopy::Group::Group(), LOCA::Homotopy::Group::Group(), LOCA::Hopf::MinimallyAugmented::ExtendedGroup::setParam(), LOCA::Hopf::MooreSpence::ExtendedGroup::setParam(), LOCA::MultiContinuation::ConstrainedGroup::setParam(), LOCA::Pitchfork::MinimallyAugmented::ExtendedGroup::setParam(), LOCA::Pitchfork::MooreSpence::ExtendedGroup::setParam(), and LOCA::TurningPoint::MooreSpence::ExtendedGroup::setParam().

◆ getLabel()

std::string LOCA::ParameterVector::getLabel ( unsigned int i ) const

Returns the label of the parameter with index i.

References l.

Referenced by LOCA::MultiContinuation::ExtendedGroup::getContinuationParameterName(), LOCA::MultiContinuation::ConstrainedGroup::printSolution(), and LOCAInterface::setParameters().

◆ getNamesVector()

const std::vector< std::string > & LOCA::ParameterVector::getNamesVector ( ) const

Accessor to get the underlying stl vector with all parameter names.

References l.

◆ getValue() [1/2]

double LOCA::ParameterVector::getValue ( std::string label ) const

Returns the value of the parameter with the corresponding label. Will throw an error if "label" is not valid.

References l, and x.

◆ getValue() [2/2]

double LOCA::ParameterVector::getValue ( unsigned int i ) const

Returns the value of the parameter with index i. Will throw an error if index is out of range.

References x.

Referenced by LOCA::Epetra::Group::getParam(), LOCA::Homotopy::DeflatedGroup::getParam(), LOCA::LAPACK::Group::getParam(), LOCA::Thyra::Group::getParam(), LOCAInterface::setParameters(), and LOCA::Homotopy::Group::setParams().

◆ getValuesVector()

const std::vector< double > & LOCA::ParameterVector::getValuesVector ( ) const

Accessor to get the underlying stl vector with all parameter values.

References x.

◆ init()

bool LOCA::ParameterVector::init ( double value )

Initialize the vector. Returns true if successful.

References x.

◆ isParameter()

bool LOCA::ParameterVector::isParameter ( std::string label ) const

Returns true if the parameter std::string "label" corresponds to a parameter label in the object.

References l, and x.

◆ length()

int LOCA::ParameterVector::length ( ) const

Returns the length of parameter vector.

References x.

Referenced by LOCA::Epetra::ModelEvaluatorInterface::setParameters(), LOCAInterface::setParameters(), LOCA::Hopf::MinimallyAugmented::ExtendedGroup::setParams(), LOCA::MultiContinuation::ConstrainedGroup::setParams(), and LOCA::Pitchfork::MinimallyAugmented::ExtendedGroup::setParams().

◆ operator=()

LOCA::ParameterVector & LOCA::ParameterVector::operator= ( const ParameterVector & y )

Set a parameter vector equal to another. This will erase any old parameters in the object.

References l, and x.

◆ operator[]() [1/2]

double & LOCA::ParameterVector::operator[] ( unsigned int i )

Return a reference to the i-th element. Will throw an error if index is out of range.

References x.

◆ operator[]() [2/2]

const double & LOCA::ParameterVector::operator[] ( unsigned int i ) const

Return a reference to the i-th element (no l-value type). Will throw an error if index is out of range.

References x.

◆ print()

void LOCA::ParameterVector::print ( std::ostream & stream ) const

Prints the vector to cout.

References l, and x.

◆ scale() [1/2]

bool LOCA::ParameterVector::scale ( const ParameterVector & p )

Scales the vactor with another vector (element-wise multiply). Returns true if successful.

References x.

◆ scale() [2/2]

bool LOCA::ParameterVector::scale ( double value )

Scales the entire vector by value. Returns true if successful.

References x.

◆ setValue() [1/2]

void LOCA::ParameterVector::setValue	(	std::string	label,
		double	value )

Set the value of the parameter with the corresponding label. Will throw an error if "label" is not valid.

References l, and x.

◆ setValue() [2/2]

void LOCA::ParameterVector::setValue	(	unsigned int	i,
		double	value )

Set the value of the parameter with index i. Will throw an error if index is out of range.

References x.

◆ update()

bool LOCA::ParameterVector::update	(	double	alpha,
		const ParameterVector &	alphaVector,
		double	b )

Updates the parameter vector: this = alpha * alphaVector + b * this. Returns true if successful.

References x.

Member Data Documentation

◆ l

std::vector<std::string> LOCA::ParameterVector::l

protected

Parameter names.

Referenced by addParameter(), getIndex(), getLabel(), getNamesVector(), getValue(), isParameter(), operator=(), ParameterVector(), ParameterVector(), print(), and setValue().

◆ x

std::vector<double> LOCA::ParameterVector::x

protected

Parameter values.

Referenced by addParameter(), getDoubleArrayPointer(), getIndex(), getValue(), getValue(), getValuesVector(), init(), isParameter(), length(), operator=(), operator[](), operator[](), ParameterVector(), ParameterVector(), print(), scale(), scale(), setValue(), setValue(), and update().

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

LOCA_Parameter_Vector.H
LOCA_Parameter_Vector.C

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ParameterVector() [1/2]

◆ ParameterVector() [2/2]

Member Function Documentation

◆ addParameter()

◆ getDoubleArrayPointer()

◆ getIndex()

◆ getLabel()

◆ getNamesVector()

◆ getValue() [1/2]

◆ getValue() [2/2]

◆ getValuesVector()

◆ init()

◆ isParameter()

◆ length()

◆ operator=()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ print()

◆ scale() [1/2]

◆ scale() [2/2]

◆ setValue() [1/2]

◆ setValue() [2/2]

◆ update()

Member Data Documentation

◆ l

◆ x