#include <IpVector.hpp>

Inheritance diagram for Ipopt::Vector:

Public Member Functions
Vector *	MakeNew () const
	Create new Vector of the same type with uninitialized data.

Vector *	MakeNewCopy () const
	Create new Vector of the same type and copy the data over.

bool	HasValidNumbers () const
	Method for determining if all stored numbers are valid (i.e., no Inf or Nan).

Constructor/Destructor
	Vector (const VectorSpace *owner_space)
	Constructor.

virtual	~Vector ()
	Destructor.

Standard BLAS-1 Operations
(derived classes do NOT overload these methods, instead, overload the protected versions of these methods).
void	Copy (const Vector &x)
	Copy the data of the vector x into this vector (DCOPY).

void	Scal (Number alpha)
	Scales the vector by scalar alpha (DSCAL)

void	Axpy (Number alpha, const Vector &x)
	Add the multiple alpha of vector x to this vector (DAXPY)

Number	Dot (const Vector &x) const
	Computes inner product of vector x with this (DDOT)

Number	Nrm2 () const
	Computes the 2-norm of this vector (DNRM2)

Number	Asum () const
	Computes the 1-norm of this vector (DASUM)

Number	Amax () const
	Computes the max-norm of this vector (based on IDAMAX)

Additional (Non-BLAS) Vector Methods
(derived classes do NOT overload these methods, instead, overload the protected versions of these methods).
void	Set (Number alpha)
	Set each element in the vector to the scalar alpha.

void	ElementWiseDivide (const Vector &x)
	Element-wise division \(y_i \gets y_i/x_i\).

void	ElementWiseMultiply (const Vector &x)
	Element-wise multiplication \(y_i \gets y_i*x_i\).

void	ElementWiseSelect (const Vector &x)
	Element-wise selection \(y_i \gets sgn(y_i)x_i, if y_i != 0, else 0\).

void	ElementWiseMax (const Vector &x)
	Element-wise max against entries in x.

void	ElementWiseMin (const Vector &x)
	Element-wise min against entries in x.

void	ElementWiseReciprocal ()
	Reciprocates the entries in the vector.

void	ElementWiseAbs ()
	Absolute values of the entries in the vector.

void	ElementWiseSqrt ()
	Element-wise square root of the entries in the vector.

void	ElementWiseSgn ()
	Replaces the vector values with their sgn values ( -1 if x_i < 0, 0 if x_i == 0, and 1 if x_i > 0)

void	AddScalar (Number scalar)
	Add scalar to every vector component.

Number	Max () const
	Returns the maximum value in the vector.

Number	Min () const
	Returns the minimum value in the vector.

Number	Sum () const
	Returns the sum of the vector entries.

Number	SumLogs () const
	Returns the sum of the logs of each vector entry.

Methods for specialized operations.
A prototype implementation is provided, but for efficient implementation those should be specially implemented.
void	AddOneVector (Number a, const Vector &v1, Number c)
	Add one vector, y = a * v1 + c * y.

void	AddTwoVectors (Number a, const Vector &v1, Number b, const Vector &v2, Number c)
	Add two vectors, y = a * v1 + b * v2 + c * y.

Number	FracToBound (const Vector &delta, Number tau) const
	Fraction to the boundary parameter.

void	AddVectorQuotient (Number a, const Vector &z, const Vector &s, Number c)
	Add the quotient of two vectors, y = a * z/s + c * y.

Accessor methods
Index	Dim () const
	Dimension of the Vector.

SmartPtr< const VectorSpace >	OwnerSpace () const
	Return the owner VectorSpace.

Output methods
(derived classes do NOT overload these methods, instead, overload the protected versions of these methods).
void	Print (SmartPtr< const Journalist > jnlst, EJournalLevel level, EJournalCategory category, const std::string &name, Index indent=0, const std::string &prefix="") const
	Print the entire vector.

void	Print (const Journalist &jnlst, EJournalLevel level, EJournalCategory category, const std::string &name, Index indent=0, const std::string &prefix="") const

Public Member Functions inherited from Ipopt::TaggedObject
	TaggedObject ()
	Constructor.

virtual	~TaggedObject ()
	Destructor.

Tag	GetTag () const
	Users of TaggedObjects call this to update their own internal tags every time they perform the expensive operation.

bool	HasChanged (const Tag comparison_tag) const
	Users of TaggedObjects call this to check if the object HasChanged since they last updated their own internal tag.

Public Member Functions inherited from Ipopt::ReferencedObject
	ReferencedObject ()

virtual	~ReferencedObject ()

Index	ReferenceCount () const

void	AddRef (const Referencer *referencer) const

void	ReleaseRef (const Referencer *referencer) const

Public Member Functions inherited from Ipopt::Subject
	Subject ()
	Default Constructor.

virtual	~Subject ()
	Destructor.

void	AttachObserver (Observer::NotifyType notify_type, Observer *observer) const
	Attach the specified observer (i.e., begin receiving notifications).

void	DetachObserver (Observer::NotifyType notify_type, Observer *observer) const
	Detach the specified observer (i.e., no longer receive notifications).

Protected Member Functions
implementation methods (derived classes MUST
overload these pure virtual protected methods.)
virtual void	CopyImpl (const Vector &x)=0
	Copy the data of the vector x into this vector (DCOPY).

virtual void	ScalImpl (Number alpha)=0
	Scales the vector by scalar alpha (DSCAL)

virtual void	AxpyImpl (Number alpha, const Vector &x)=0
	Add the multiple alpha of vector x to this vector (DAXPY)

virtual Number	DotImpl (const Vector &x) const =0
	Computes inner product of vector x with this (DDOT)

virtual Number	Nrm2Impl () const =0
	Computes the 2-norm of this vector (DNRM2)

virtual Number	AsumImpl () const =0
	Computes the 1-norm of this vector (DASUM)

virtual Number	AmaxImpl () const =0
	Computes the max-norm of this vector (based on IDAMAX)

virtual void	SetImpl (Number alpha)=0
	Set each element in the vector to the scalar alpha.

virtual void	ElementWiseDivideImpl (const Vector &x)=0
	Element-wise division \(y_i \gets y_i/x_i\).

virtual void	ElementWiseMultiplyImpl (const Vector &x)=0
	Element-wise multiplication \(y_i \gets y_i*x_i\).

virtual void	ElementWiseSelectImpl (const Vector &x)=0
	Element-wise selection \(y_i \gets sgn(y_i)x_i, if y_i != 0, else 0\).

virtual void	ElementWiseMaxImpl (const Vector &x)=0
	Element-wise max against entries in x.

virtual void	ElementWiseMinImpl (const Vector &x)=0
	Element-wise min against entries in x.

virtual void	ElementWiseReciprocalImpl ()=0
	Reciprocates the elements of the vector.

virtual void	ElementWiseAbsImpl ()=0
	Take elementwise absolute values of the elements of the vector.

virtual void	ElementWiseSqrtImpl ()=0
	Take elementwise square-root of the elements of the vector.

virtual void	ElementWiseSgnImpl ()=0
	Replaces entries with sgn of the entry.

virtual void	AddScalarImpl (Number scalar)=0
	Add scalar to every component of vector.

virtual Number	MaxImpl () const =0
	Max value in the vector.

virtual Number	MinImpl () const =0
	Min number in the vector.

virtual Number	SumImpl () const =0
	Sum of entries in the vector.

virtual Number	SumLogsImpl () const =0
	Sum of logs of entries in the vector.

virtual void	AddTwoVectorsImpl (Number a, const Vector &v1, Number b, const Vector &v2, Number c)
	Add two vectors (a * v1 + b * v2).

virtual Number	FracToBoundImpl (const Vector &delta, Number tau) const
	Fraction to boundary parameter.

virtual void	AddVectorQuotientImpl (Number a, const Vector &z, const Vector &s, Number c)
	Add the quotient of two vectors.

virtual bool	HasValidNumbersImpl () const
	Method for determining if all stored numbers are valid (i.e., no Inf or Nan).

virtual void	PrintImpl (const Journalist &jnlst, EJournalLevel level, EJournalCategory category, const std::string &name, Index indent, const std::string &prefix) const =0
	Print the entire vector.

Protected Member Functions inherited from Ipopt::TaggedObject
void	ObjectChanged ()
	Objects derived from TaggedObject MUST call this method every time their internal state changes to update the internal tag for comparison.

Protected Member Functions inherited from Ipopt::Subject
void	Notify (Observer::NotifyType notify_type) const

Private Member Functions
Default Compiler Generated Methods
(Hidden to avoid implicit creation/calling). These methods are not implemented and we do not want the compiler to implement them for us, so we declare them private and do not define them. This ensures that they will not be implicitly created/called.
	Vector ()
	Default constructor.

	Vector (const Vector &)
	Copy constructor.

Vector &	operator= (const Vector &)
	Default Assignment Operator.

Private Attributes
const SmartPtr< const VectorSpace >	owner_space_
	Vector Space.

CachedResults data members
CachedResults< Number >	dot_cache_
	Cache for dot products.

TaggedObject::Tag	nrm2_cache_tag_

Number	cached_nrm2_

TaggedObject::Tag	asum_cache_tag_

Number	cached_asum_

TaggedObject::Tag	amax_cache_tag_

Number	cached_amax_

TaggedObject::Tag	max_cache_tag_

Number	cached_max_

TaggedObject::Tag	min_cache_tag_

Number	cached_min_

TaggedObject::Tag	sum_cache_tag_

Number	cached_sum_

TaggedObject::Tag	sumlogs_cache_tag_

Number	cached_sumlogs_

TaggedObject::Tag	valid_cache_tag_

bool	cached_valid_

Additional Inherited Members
Public Types inherited from Ipopt::TaggedObject
typedef unsigned int	Tag
	Type for the Tag values.

Detailed Description

Vector Base Class.

This is the base class for all derived vector types. Those vectors are meant to store entities like iterates, Lagrangian multipliers, constraint values etc. The implementation of a vector type depends on the computational environment (e.g. just a double array on a shared memory machine, or distributed double arrays for a distributed memory machine.)

Deriving from Vector: This class inherits from tagged object to implement an advanced caching scheme. Because of this, the TaggedObject method ObjectChanged() must be called each time the Vector changes. If you overload the XXXX_Impl protected methods, this taken care of (along with caching if possible) for you. If you have additional methods in your derived class that change the underlying data (vector values), you MUST remember to call ObjectChanged() AFTER making the change!

Definition at line 47 of file IpVector.hpp.

Constructor & Destructor Documentation

◆ Vector() [1/3]

Ipopt::Vector::Vector ( const VectorSpace * owner_space )

inline

Constructor.

It has to be given a pointer to the corresponding VectorSpace.

Definition at line 532 of file IpVector.hpp.

◆ ~Vector()

Ipopt::Vector::~Vector ( )

inlinevirtual

Destructor.

Definition at line 529 of file IpVector.hpp.

◆ Vector() [2/3]

Ipopt::Vector::Vector ( )

private

Default constructor.

◆ Vector() [3/3]

Ipopt::Vector::Vector ( const Vector & )

private

Copy constructor.

Member Function Documentation

◆ MakeNew()

Vector * Ipopt::Vector::MakeNew ( ) const

inline

Create new Vector of the same type with uninitialized data.

Definition at line 550 of file IpVector.hpp.

◆ MakeNewCopy()

Vector * Ipopt::Vector::MakeNewCopy ( ) const

inline

Create new Vector of the same type and copy the data over.

Definition at line 555 of file IpVector.hpp.

◆ Copy()

void Ipopt::Vector::Copy ( const Vector & x )

inline

Copy the data of the vector x into this vector (DCOPY).

Definition at line 563 of file IpVector.hpp.

◆ Scal()

void Ipopt::Vector::Scal ( Number alpha )

Scales the vector by scalar alpha (DSCAL)

◆ Axpy()

void Ipopt::Vector::Axpy	(	Number	alpha,
		const Vector &	x
	)

inline

Add the multiple alpha of vector x to this vector (DAXPY)

Definition at line 609 of file IpVector.hpp.

◆ Dot()

Number Ipopt::Vector::Dot ( const Vector & x ) const

inline

Computes inner product of vector x with this (DDOT)

Definition at line 618 of file IpVector.hpp.

◆ Nrm2()

Number Ipopt::Vector::Nrm2 ( ) const

inline

Computes the 2-norm of this vector (DNRM2)

Definition at line 640 of file IpVector.hpp.

◆ Asum()

Number Ipopt::Vector::Asum ( ) const

inline

Computes the 1-norm of this vector (DASUM)

Definition at line 650 of file IpVector.hpp.

◆ Amax()

Number Ipopt::Vector::Amax ( ) const

inline

Computes the max-norm of this vector (based on IDAMAX)

Definition at line 660 of file IpVector.hpp.

◆ Set()

void Ipopt::Vector::Set ( Number alpha )

inline

Set each element in the vector to the scalar alpha.

Definition at line 696 of file IpVector.hpp.

◆ ElementWiseDivide()

void Ipopt::Vector::ElementWiseDivide ( const Vector & x )

inline

Element-wise division \(y_i \gets y_i/x_i\).

Definition at line 705 of file IpVector.hpp.

◆ ElementWiseMultiply()

void Ipopt::Vector::ElementWiseMultiply ( const Vector & x )

inline

Element-wise multiplication \(y_i \gets y_i*x_i\).

Definition at line 713 of file IpVector.hpp.

◆ ElementWiseSelect()

void Ipopt::Vector::ElementWiseSelect ( const Vector & x )

inline

Element-wise selection \(y_i \gets sgn(y_i)x_i, if y_i != 0, else 0\).

So like ElementWiseSgn().ElementWiseMultiply(x), but with 0*inf = 0.

Since: 3.14.0

Definition at line 721 of file IpVector.hpp.

◆ ElementWiseMax()

void Ipopt::Vector::ElementWiseMax ( const Vector & x )

inline

Element-wise max against entries in x.

Definition at line 735 of file IpVector.hpp.

◆ ElementWiseMin()

void Ipopt::Vector::ElementWiseMin ( const Vector & x )

inline

Element-wise min against entries in x.

Definition at line 744 of file IpVector.hpp.

◆ ElementWiseReciprocal()

void Ipopt::Vector::ElementWiseReciprocal ( )

inline

Reciprocates the entries in the vector.

Definition at line 729 of file IpVector.hpp.

◆ ElementWiseAbs()

void Ipopt::Vector::ElementWiseAbs ( )

inline

Absolute values of the entries in the vector.

Definition at line 753 of file IpVector.hpp.

◆ ElementWiseSqrt()

void Ipopt::Vector::ElementWiseSqrt ( )

inline

Element-wise square root of the entries in the vector.

Definition at line 760 of file IpVector.hpp.

◆ ElementWiseSgn()

void Ipopt::Vector::ElementWiseSgn ( )

inline

Replaces the vector values with their sgn values ( -1 if x_i < 0, 0 if x_i == 0, and 1 if x_i > 0)

Definition at line 690 of file IpVector.hpp.

◆ AddScalar()

void Ipopt::Vector::AddScalar ( Number scalar )

inline

Add scalar to every vector component.

Definition at line 766 of file IpVector.hpp.

◆ Max()

Number Ipopt::Vector::Max ( ) const

inline

Returns the maximum value in the vector.

Definition at line 774 of file IpVector.hpp.

◆ Min()

Number Ipopt::Vector::Min ( ) const

inline

Returns the minimum value in the vector.

Definition at line 784 of file IpVector.hpp.

◆ Sum()

Number Ipopt::Vector::Sum ( ) const

inline

Returns the sum of the vector entries.

Definition at line 670 of file IpVector.hpp.

◆ SumLogs()

Number Ipopt::Vector::SumLogs ( ) const

inline

Returns the sum of the logs of each vector entry.

Definition at line 680 of file IpVector.hpp.

◆ AddOneVector()

void Ipopt::Vector::AddOneVector	(	Number	a,
		const Vector &	v1,
		Number	c
	)

inline

Add one vector, y = a * v1 + c * y.

This is automatically reduced to call AddTwoVectors.

Definition at line 794 of file IpVector.hpp.

◆ AddTwoVectors()

void Ipopt::Vector::AddTwoVectors	(	Number	a,
		const Vector &	v1,
		Number	b,
		const Vector &	v2,
		Number	c
	)

inline

Add two vectors, y = a * v1 + b * v2 + c * y.

Here, this vector is y.

Definition at line 803 of file IpVector.hpp.

◆ FracToBound()

Number Ipopt::Vector::FracToBound	(	const Vector &	delta,
		Number	tau
	)		const

inline

Fraction to the boundary parameter.

Computes \(\alpha = \max\{\bar\alpha\in(0,1] : x + \bar\alpha \Delta \geq (1-\tau)x\}\)

Definition at line 815 of file IpVector.hpp.

◆ AddVectorQuotient()

void Ipopt::Vector::AddVectorQuotient	(	Number	a,
		const Vector &	z,
		const Vector &	s,
		Number	c
	)

inline

Add the quotient of two vectors, y = a * z/s + c * y.

Definition at line 837 of file IpVector.hpp.

◆ HasValidNumbers()

bool Ipopt::Vector::HasValidNumbers ( ) const

inline

Method for determining if all stored numbers are valid (i.e., no Inf or Nan).

Definition at line 848 of file IpVector.hpp.

◆ Dim()

Index Ipopt::Vector::Dim ( ) const

inline

Dimension of the Vector.

Definition at line 858 of file IpVector.hpp.

◆ OwnerSpace()

SmartPtr< const VectorSpace > Ipopt::Vector::OwnerSpace ( ) const

inline

Return the owner VectorSpace.

Definition at line 863 of file IpVector.hpp.

◆ Print() [1/2]

void Ipopt::Vector::Print	(	SmartPtr< const Journalist >	jnlst,
		EJournalLevel	level,
		EJournalCategory	category,
		const std::string &	name,
		Index	indent = `0`,
		const std::string &	prefix = `""`
	)		const

Print the entire vector.

◆ Print() [2/2]

void Ipopt::Vector::Print	(	const Journalist &	jnlst,
		EJournalLevel	level,
		EJournalCategory	category,
		const std::string &	name,
		Index	indent = `0`,
		const std::string &	prefix = `""`
	)		const

◆ CopyImpl()

virtual void Ipopt::Vector::CopyImpl ( const Vector & x )

protectedpure virtual

Copy the data of the vector x into this vector (DCOPY).

Implemented in Ipopt::CompoundVector, and Ipopt::DenseVector.

◆ ScalImpl()

virtual void Ipopt::Vector::ScalImpl ( Number alpha )

protectedpure virtual

Scales the vector by scalar alpha (DSCAL)

Implemented in Ipopt::CompoundVector, and Ipopt::DenseVector.

◆ AxpyImpl()

virtual void Ipopt::Vector::AxpyImpl	(	Number	alpha,
		const Vector &	x
	)

protectedpure virtual

Add the multiple alpha of vector x to this vector (DAXPY)

Implemented in Ipopt::CompoundVector, and Ipopt::DenseVector.

◆ DotImpl()

virtual Number Ipopt::Vector::DotImpl ( const Vector & x ) const

protectedpure virtual

Computes inner product of vector x with this (DDOT)

Implemented in Ipopt::CompoundVector, and Ipopt::DenseVector.

◆ Nrm2Impl()

virtual Number Ipopt::Vector::Nrm2Impl ( ) const

protectedpure virtual

Computes the 2-norm of this vector (DNRM2)

Implemented in Ipopt::CompoundVector, and Ipopt::DenseVector.

◆ AsumImpl()

virtual Number Ipopt::Vector::AsumImpl ( ) const

protectedpure virtual

Computes the 1-norm of this vector (DASUM)

Implemented in Ipopt::CompoundVector, and Ipopt::DenseVector.

◆ AmaxImpl()

virtual Number Ipopt::Vector::AmaxImpl ( ) const

protectedpure virtual

Computes the max-norm of this vector (based on IDAMAX)

Implemented in Ipopt::CompoundVector, and Ipopt::DenseVector.

◆ SetImpl()

virtual void Ipopt::Vector::SetImpl ( Number alpha )

protectedpure virtual

Set each element in the vector to the scalar alpha.

Implemented in Ipopt::CompoundVector, and Ipopt::DenseVector.

◆ ElementWiseDivideImpl()

virtual void Ipopt::Vector::ElementWiseDivideImpl ( const Vector & x )

protectedpure virtual

Element-wise division \(y_i \gets y_i/x_i\).

Implemented in Ipopt::CompoundVector, and Ipopt::DenseVector.

◆ ElementWiseMultiplyImpl()

virtual void Ipopt::Vector::ElementWiseMultiplyImpl ( const Vector & x )

protectedpure virtual

Element-wise multiplication \(y_i \gets y_i*x_i\).

Implemented in Ipopt::CompoundVector, and Ipopt::DenseVector.

◆ ElementWiseSelectImpl()

virtual void Ipopt::Vector::ElementWiseSelectImpl ( const Vector & x )

protectedpure virtual

Element-wise selection \(y_i \gets sgn(y_i)x_i, if y_i != 0, else 0\).

Implemented in Ipopt::CompoundVector, and Ipopt::DenseVector.

◆ ElementWiseMaxImpl()

virtual void Ipopt::Vector::ElementWiseMaxImpl ( const Vector & x )

protectedpure virtual

Element-wise max against entries in x.

Implemented in Ipopt::CompoundVector, and Ipopt::DenseVector.

◆ ElementWiseMinImpl()

virtual void Ipopt::Vector::ElementWiseMinImpl ( const Vector & x )

protectedpure virtual

Element-wise min against entries in x.

Implemented in Ipopt::CompoundVector, and Ipopt::DenseVector.

◆ ElementWiseReciprocalImpl()

virtual void Ipopt::Vector::ElementWiseReciprocalImpl ( )

protectedpure virtual

Reciprocates the elements of the vector.

Implemented in Ipopt::CompoundVector, and Ipopt::DenseVector.

◆ ElementWiseAbsImpl()

virtual void Ipopt::Vector::ElementWiseAbsImpl ( )

protectedpure virtual

Take elementwise absolute values of the elements of the vector.

Implemented in Ipopt::CompoundVector, and Ipopt::DenseVector.

◆ ElementWiseSqrtImpl()

virtual void Ipopt::Vector::ElementWiseSqrtImpl ( )

protectedpure virtual

Take elementwise square-root of the elements of the vector.

Implemented in Ipopt::CompoundVector, and Ipopt::DenseVector.

◆ ElementWiseSgnImpl()

virtual void Ipopt::Vector::ElementWiseSgnImpl ( )

protectedpure virtual

Replaces entries with sgn of the entry.

Implemented in Ipopt::CompoundVector, and Ipopt::DenseVector.

◆ AddScalarImpl()

virtual void Ipopt::Vector::AddScalarImpl ( Number scalar )

protectedpure virtual

Add scalar to every component of vector.

Implemented in Ipopt::CompoundVector, and Ipopt::DenseVector.

◆ MaxImpl()

virtual Number Ipopt::Vector::MaxImpl ( ) const

protectedpure virtual

Max value in the vector.

Implemented in Ipopt::CompoundVector, and Ipopt::DenseVector.

◆ MinImpl()

virtual Number Ipopt::Vector::MinImpl ( ) const

protectedpure virtual

Min number in the vector.

Implemented in Ipopt::CompoundVector, and Ipopt::DenseVector.

◆ SumImpl()

virtual Number Ipopt::Vector::SumImpl ( ) const

protectedpure virtual

Sum of entries in the vector.

Implemented in Ipopt::CompoundVector, and Ipopt::DenseVector.

◆ SumLogsImpl()

virtual Number Ipopt::Vector::SumLogsImpl ( ) const

protectedpure virtual

Sum of logs of entries in the vector.

Implemented in Ipopt::CompoundVector, and Ipopt::DenseVector.

◆ AddTwoVectorsImpl()

virtual void Ipopt::Vector::AddTwoVectorsImpl	(	Number	a,
		const Vector &	v1,
		Number	b,
		const Vector &	v2,
		Number	c
	)

protectedvirtual

Add two vectors (a * v1 + b * v2).

Result is stored in this vector.

Reimplemented in Ipopt::CompoundVector, and Ipopt::DenseVector.

◆ FracToBoundImpl()

virtual Number Ipopt::Vector::FracToBoundImpl	(	const Vector &	delta,
		Number	tau
	)		const

protectedvirtual

Fraction to boundary parameter.

Reimplemented in Ipopt::CompoundVector, and Ipopt::DenseVector.

◆ AddVectorQuotientImpl()

virtual void Ipopt::Vector::AddVectorQuotientImpl	(	Number	a,
		const Vector &	z,
		const Vector &	s,
		Number	c
	)

protectedvirtual

Add the quotient of two vectors.

Reimplemented in Ipopt::CompoundVector, and Ipopt::DenseVector.

◆ HasValidNumbersImpl()

virtual bool Ipopt::Vector::HasValidNumbersImpl ( ) const

protectedvirtual

Method for determining if all stored numbers are valid (i.e., no Inf or Nan).

A default implementation using Asum is provided.

Reimplemented in Ipopt::CompoundVector.

◆ PrintImpl()

virtual void Ipopt::Vector::PrintImpl	(	const Journalist &	jnlst,
		EJournalLevel	level,
		EJournalCategory	category,
		const std::string &	name,
		Index	indent,
		const std::string &	prefix
	)		const

protectedpure virtual

Print the entire vector.

Implemented in Ipopt::CompoundVector, and Ipopt::DenseVector.

◆ operator=()

Vector & Ipopt::Vector::operator= ( const Vector & )

private

Default Assignment Operator.

Member Data Documentation

◆ owner_space_

const SmartPtr<const VectorSpace> Ipopt::Vector::owner_space_

private

Vector Space.

Definition at line 424 of file IpVector.hpp.

◆ dot_cache_

CachedResults<Number> Ipopt::Vector::dot_cache_

mutableprivate

Cache for dot products.

Definition at line 429 of file IpVector.hpp.

◆ nrm2_cache_tag_

TaggedObject::Tag Ipopt::Vector::nrm2_cache_tag_

mutableprivate

Definition at line 431 of file IpVector.hpp.

◆ cached_nrm2_

Number Ipopt::Vector::cached_nrm2_

mutableprivate

Definition at line 432 of file IpVector.hpp.

◆ asum_cache_tag_

TaggedObject::Tag Ipopt::Vector::asum_cache_tag_

mutableprivate

Definition at line 434 of file IpVector.hpp.

◆ cached_asum_

Number Ipopt::Vector::cached_asum_

mutableprivate

Definition at line 435 of file IpVector.hpp.

◆ amax_cache_tag_

TaggedObject::Tag Ipopt::Vector::amax_cache_tag_

mutableprivate

Definition at line 437 of file IpVector.hpp.

◆ cached_amax_

Number Ipopt::Vector::cached_amax_

mutableprivate

Definition at line 438 of file IpVector.hpp.

◆ max_cache_tag_

TaggedObject::Tag Ipopt::Vector::max_cache_tag_

mutableprivate

Definition at line 440 of file IpVector.hpp.

◆ cached_max_

Number Ipopt::Vector::cached_max_

mutableprivate

Definition at line 441 of file IpVector.hpp.

◆ min_cache_tag_

TaggedObject::Tag Ipopt::Vector::min_cache_tag_

mutableprivate

Definition at line 443 of file IpVector.hpp.

◆ cached_min_

Number Ipopt::Vector::cached_min_

mutableprivate

Definition at line 444 of file IpVector.hpp.

◆ sum_cache_tag_

TaggedObject::Tag Ipopt::Vector::sum_cache_tag_

mutableprivate

Definition at line 446 of file IpVector.hpp.

◆ cached_sum_

Number Ipopt::Vector::cached_sum_

mutableprivate

Definition at line 447 of file IpVector.hpp.

◆ sumlogs_cache_tag_

TaggedObject::Tag Ipopt::Vector::sumlogs_cache_tag_

mutableprivate

Definition at line 449 of file IpVector.hpp.

◆ cached_sumlogs_

Number Ipopt::Vector::cached_sumlogs_

mutableprivate

Definition at line 450 of file IpVector.hpp.

◆ valid_cache_tag_

TaggedObject::Tag Ipopt::Vector::valid_cache_tag_

mutableprivate

Definition at line 452 of file IpVector.hpp.

◆ cached_valid_

bool Ipopt::Vector::cached_valid_

mutableprivate

Definition at line 453 of file IpVector.hpp.

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

src/LinAlg/IpVector.hpp

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Vector() [1/3]

◆ ~Vector()

◆ Vector() [2/3]

◆ Vector() [3/3]

Member Function Documentation

◆ MakeNew()

◆ MakeNewCopy()

◆ Copy()

◆ Scal()

◆ Axpy()

◆ Dot()

◆ Nrm2()

◆ Asum()

◆ Amax()

◆ Set()

◆ ElementWiseDivide()

◆ ElementWiseMultiply()

◆ ElementWiseSelect()

◆ ElementWiseMax()

◆ ElementWiseMin()

◆ ElementWiseReciprocal()

◆ ElementWiseAbs()

◆ ElementWiseSqrt()

◆ ElementWiseSgn()

◆ AddScalar()

◆ Max()

◆ Min()

◆ Sum()

◆ SumLogs()

◆ AddOneVector()

◆ AddTwoVectors()

◆ FracToBound()

◆ AddVectorQuotient()

◆ HasValidNumbers()

◆ Dim()

◆ OwnerSpace()

◆ Print() [1/2]

◆ Print() [2/2]

◆ CopyImpl()

◆ ScalImpl()

◆ AxpyImpl()

◆ DotImpl()

◆ Nrm2Impl()

◆ AsumImpl()

◆ AmaxImpl()

◆ SetImpl()

◆ ElementWiseDivideImpl()

◆ ElementWiseMultiplyImpl()

◆ ElementWiseSelectImpl()

◆ ElementWiseMaxImpl()

◆ ElementWiseMinImpl()

◆ ElementWiseReciprocalImpl()

◆ ElementWiseAbsImpl()

◆ ElementWiseSqrtImpl()

◆ ElementWiseSgnImpl()

◆ AddScalarImpl()

◆ MaxImpl()

◆ MinImpl()

◆ SumImpl()

◆ SumLogsImpl()

◆ AddTwoVectorsImpl()

◆ FracToBoundImpl()

◆ AddVectorQuotientImpl()

◆ HasValidNumbersImpl()

◆ PrintImpl()

◆ operator=()

Member Data Documentation

◆ owner_space_

◆ dot_cache_

◆ nrm2_cache_tag_

◆ cached_nrm2_

◆ asum_cache_tag_

◆ cached_asum_