SparsityInfo Class Reference

A class to represent the sparsity structure of a function. More...

#include <func.h>

List of all members.

Public Member Functions
	SparsityInfo (int init_level=0)
	SparsityInfo (const SparsityInfo &si)
	SparsityInfo (const SparsityInfo &si1, const SparsityInfo &si2)
	Joins two sparsity infos into one new.
bool	compute_sparsity_pattern (const Func &f, const vector< dvector > &sample_set)
void	add (const UserVector< double > &b)
void	add (const UserVector< double > &b, const ivector &block)
void	add (const UserMatrix &A)
void	add (const UserMatrix &A, const ivector &block)
void	add (const SparsityInfo &si)
void	add (const SparsityInfo &si, const ivector &block)
int	nr_var (bool linear_=true, bool nonlinear_=true)
Public Attributes
Pointer< map< int, SparsityInfo::LinearVariable > >	linear
	The indices of the linear variables.
Pointer< map< int, SparsityInfo::NonlinearVariable > >	nonlinear
	The indices of the nonlinear variables.
Pointer< map< int, SparsityInfo::QuadraticVariable > >	quadratic
	The indices of the quadratic variables.
Pointer< map< pair< int, int >, SparsityInfo::NonlinearConnection > >	sparsity_pattern
Private Member Functions
void	add_nonlinear (int index)
void	add_quadratic (int index, double coeff_lin, double coeff_quad)
void	add_linear (int index, double coeff)
void	add_sparsity_pattern (int index1, int index2, double coeff)
Friends
class	Decomposition
ostream &	operator<< (ostream &out, const SparsityInfo &si)
Classes
class	LinearVariable
	To represent a linear variable. More...
class	NonlinearConnection
	To represent a connection (entry in hessian) between two nonlinear variables. More...
class	NonlinearVariable
	To represent a nonlinear variable. More...
class	QuadraticVariable
	To represent a quadratic variable. More...

---

Detailed Description

A class to represent the sparsity structure of a function.

Depending on the preprocessing progress, not all members have to been set. The coefficient information is not trustable yet. Due to some design-drawbacks, it will become outdated quite fast.

Definition at line 20 of file func.h.

---

Constructor & Destructor Documentation

SparsityInfo::SparsityInfo

(

int

init_level = 0

)

SparsityInfo::SparsityInfo

(

const SparsityInfo &

si

)

SparsityInfo::SparsityInfo	(	const SparsityInfo &	si1,
		const SparsityInfo &	si2
	)

Joins two sparsity infos into one new.

Used when adding two functions, for example.

---

Member Function Documentation

void SparsityInfo::add_nonlinear

(

int

index

)

[inline, private]

Definition at line 23 of file func.h.

References nonlinear.

void SparsityInfo::add_quadratic	(	int	index,
		double	coeff_lin,
		double	coeff_quad
	)			[private]

void SparsityInfo::add_linear	(	int	index,
		double	coeff
	)			[inline, private]

Definition at line 29 of file func.h.

References linear.

void SparsityInfo::add_sparsity_pattern	(	int	index1,
		int	index2,
		double	coeff
	)			[private]

bool SparsityInfo::compute_sparsity_pattern	(	const Func &	f,
		const vector< dvector > &	sample_set
	)

Referenced by Func::compute_sparsity_pattern().

void SparsityInfo::add

(

const UserVector< double > &

b

)

void SparsityInfo::add	(	const UserVector< double > &	b,
		const ivector &	block
	)

void SparsityInfo::add

(

const UserMatrix &

A

)

void SparsityInfo::add	(	const UserMatrix &	A,
		const ivector &	block
	)

void SparsityInfo::add

(

const SparsityInfo &

si

)

void SparsityInfo::add	(	const SparsityInfo &	si,
		const ivector &	block
	)

int SparsityInfo::nr_var	(	bool	linear_ = true,
		bool	nonlinear_ = true
	)			[inline]

Definition at line 129 of file func.h.

References linear, and nonlinear.

---

Friends And Related Function Documentation

friend class Decomposition [friend]

Definition at line 21 of file func.h.

ostream& operator<<	(	ostream &	out,
		const SparsityInfo &	si
	)			[friend]

---

Member Data Documentation

Pointer<map<int, SparsityInfo::LinearVariable> > SparsityInfo::linear

The indices of the linear variables.

Definition at line 95 of file func.h.

Referenced by add_linear(), and nr_var().

Pointer<map<int, SparsityInfo::NonlinearVariable> > SparsityInfo::nonlinear

The indices of the nonlinear variables.

Definition at line 98 of file func.h.

Referenced by add_nonlinear(), and nr_var().

Pointer<map<int, SparsityInfo::QuadraticVariable> > SparsityInfo::quadratic

The indices of the quadratic variables.

If set, then this set is a subset of the set of nonlinear variables.

Definition at line 103 of file func.h.

Pointer<map<pair<int, int>, SparsityInfo::NonlinearConnection> > SparsityInfo::sparsity_pattern

Definition at line 105 of file func.h.

---

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

• func.h

---