coco::sparsity_visitor Class Reference
[Advanced Utilities]

Preorder visitor which calculates sparsity structures. More...

Inheritance diagram for coco::sparsity_visitor:

[legend]

Collaboration diagram for coco::sparsity_visitor:

[legend]

List of all members.

Public Types
typedef _Ret	return_value
Public Member Functions
	sparsity_visitor (splist &__o, int __n, bool __b=false)
	sparsity_visitor (const sparsity_visitor &__c)
virtual void	vinit ()
virtual bool	preorder (const _Node &__n)
virtual void	collect (const _Node &__n, collect_value __r)
bool	preorder (const expression_node &r)
const variable_indicator &	vvalue ()
const variable_indicator &	value ()
void	collect (const expression_node &r, const variable_indicator &__v)

---

Detailed Description

This preorder visitor is used to calculate the sparsity structure of Hessians and Jacobi matrices.

Definition at line 62 of file sparsity.cc.

---

Member Typedef Documentation

typedef _Ret preorder_visitor< class, class, class >::return_value [inherited]

---

Constructor & Destructor Documentation

coco::sparsity_visitor::sparsity_visitor	(	splist &	__o,
		int	__n,
		bool	__b = false
	)			[inline]

Constructor, which initializes the output variable holding the sparsity structure to __o, and the number of variables to __n. If __b is true, the array base is set to 1, and to 0 otherwise.

Definition at line 116 of file sparsity.cc.

coco::sparsity_visitor::sparsity_visitor

(

const sparsity_visitor &

__c

)

[inline]

Standard Copy Constructor

Definition at line 121 of file sparsity.cc.

---

Member Function Documentation

virtual void preorder_visitor< class, class, class >::collect	(	const _Node &	__n,
		collect_value	__r
	)			[virtual, inherited]

void coco::sparsity_visitor::collect	(	const expression_node &	r,
		const variable_indicator &	__v
	)			[inline]

This is a method as needed by a preorder visitor.

Definition at line 249 of file sparsity.cc.

virtual bool preorder_visitor< class, class, class >::preorder

(

const _Node &

__n

)

[virtual, inherited]

bool coco::sparsity_visitor::preorder

(

const expression_node &

r

)

[inline]

This is a method as needed by a preorder visitor.

Definition at line 128 of file sparsity.cc.

const variable_indicator& coco::sparsity_visitor::value

(

)

[inline]

This is a method as needed by a preorder visitor.

Definition at line 247 of file sparsity.cc.

virtual void preorder_visitor< class, class, class >::vinit

(

)

[virtual, inherited]

const variable_indicator& coco::sparsity_visitor::vvalue

(

)

[inline, virtual]

This is a method as needed by a preorder visitor.

Reimplemented from preorder_visitor< expression_node, const variable_indicator &, const variable_indicator & >.

Definition at line 246 of file sparsity.cc.

---

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

• sparsity.cc