DiagMatrix Class Reference

#include <IpDiagMatrix.hpp>

Inheritance diagram for DiagMatrix:

List of all members.

---

Detailed Description

Class for diagonal matrices.

The diagonal is stored as a Vector.

Public Member Functions
void	SetDiag (const Vector &diag)
	Method for setting the diagonal elements (as a Vector).
SmartPtr< const Vector >	GetDiag () const
	Method for setting the diagonal elements.
Constructors / Destructors
	DiagMatrix (const SymMatrixSpace *owner_space)
	Constructor, given the corresponding matrix space.
	~DiagMatrix ()
	Destructor.
Protected Member Functions
Methods overloaded from matrix
virtual void	MultVectorImpl (Number alpha, const Vector &x, Number beta, Vector &y) const
	Method for determining if all stored numbers are valid (i.e., no Inf or Nan).
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
	Method for determining if all stored numbers are valid (i.e., no Inf or Nan).

---

Constructor & Destructor Documentation

DiagMatrix

(

const SymMatrixSpace *

owner_space

)

Constructor, given the corresponding matrix space.

~DiagMatrix

(

)

Destructor.

---

Member Function Documentation

void SetDiag

(

const Vector &

diag

)

[inline]

Method for setting the diagonal elements (as a Vector).

SmartPtr<const Vector> GetDiag

(

)

const [inline]

Method for setting the diagonal elements.

void MultVectorImpl	(	Number	alpha,
		const Vector &	x,
		Number	beta,
		Vector &	y
	)			const [protected, virtual]

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

Implements Matrix.

References Vector::Axpy(), DBG_ASSERT, Vector::Dim(), SymMatrix::Dim(), Ipopt::IsValid(), Vector::MakeNew(), Vector::Scal(), and Vector::Set().

bool HasValidNumbersImpl

(

)

const [protected, virtual]

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

Reimplemented from Matrix.

References DBG_ASSERT, and Ipopt::IsValid().

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

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

Implements Matrix.

References SymMatrix::Dim(), Ipopt::IsValid(), Journalist::Printf(), and Journalist::PrintfIndented().

---

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

• IpDiagMatrix.hpp
• IpDiagMatrix.cpp