ABA_COLVAR Class Reference

Some optimization problems, in particular column generation problems, are better described from a variable point of view instead of a constraint point of view. For such context we provide the class ABA_COLVAR. More...

#include <colvar.h>

Inheritance diagram for ABA_COLVAR:

List of all members.

Public Member Functions
	ABA_COLVAR (ABA_MASTER *master, const ABA_SUB *sub, bool dynamic, bool local, double lBound, double uBound, ABA_VARTYPE::TYPE varType, double obj, int nnz, ABA_ARRAY< int > &support, ABA_ARRAY< double > &coeff)
	ABA_COLVAR (ABA_MASTER *master, const ABA_SUB *sub, bool dynamic, bool local, double lBound, double uBound, ABA_VARTYPE::TYPE varType, double obj, ABA_SPARVEC &vector)
	A constructor substituting nnz, support, and coeff of the previous constructor by an object of the class ABA_SPARVEC.
virtual	~ABA_COLVAR ()
virtual void	print (ostream &out)
virtual double	coeff (ABA_CONSTRAINT *con)
double	coeff (int i)
ABA_COLUMN *	column ()
Protected Attributes
ABA_COLUMN	column_
Friends
ostream &	operator<< (ostream &out, const ABA_COLVAR &rhs)

---

Detailed Description

Some optimization problems, in particular column generation problems, are better described from a variable point of view instead of a constraint point of view. For such context we provide the class ABA_COLVAR.

Parameters:

ABA_COLUMN

column_ The column representing the variable.

Definition at line 49 of file colvar.h.

---

Constructor & Destructor Documentation

ABA_COLVAR::ABA_COLVAR	(	ABA_MASTER *	master,
		const ABA_SUB *	sub,
		bool	dynamic,
		bool	local,
		double	lBound,
		double	uBound,
		ABA_VARTYPE::TYPE	varType,
		double	obj,
		int	nnz,
		ABA_ARRAY< int > &	support,
		ABA_ARRAY< double > &	coeff
	)

The constructor.

Parameters:

	master	A pointer to the corresponding master of the optimization.
	sub	A pointer to the subproblem associated with the variable. This can be also the 0-pointer.
	dynamic	If this argument is true, then the variable can be removed from the active variable set during the subproblem optimization.
	local	If this argument is true, then the constraint is considered to be only locally valid. As a local variable is associated with a subproblem, sub must not be 0 if local is true.
	lBound	The lower bound of the variable.
	uBound	The upper bound of the variable.
	varType	The type of the variable.
	obj	The objective function coefficient of the variable.
	nnz	The number of nonzero elements of the variable.
	support	The array storing the constraints with the nonzero coefficients.
	coeff	The nonzero coefficients of the constraints stored in support.

ABA_COLVAR::ABA_COLVAR	(	ABA_MASTER *	master,
		const ABA_SUB *	sub,
		bool	dynamic,
		bool	local,
		double	lBound,
		double	uBound,
		ABA_VARTYPE::TYPE	varType,
		double	obj,
		ABA_SPARVEC &	vector
	)

A constructor substituting nnz, support, and coeff of the previous constructor by an object of the class ABA_SPARVEC.

virtual ABA_COLVAR::~ABA_COLVAR

(

)

[virtual]

The destructor.

---

Member Function Documentation

virtual void ABA_COLVAR::print

(

ostream &

out

)

[virtual]

Writes the column representing the variable to an output stream.

It redefines the virtual function print() of the base class ABA_CONVAR.

Parameters:

out

The output stream.

Reimplemented from ABA_CONVAR.

virtual double ABA_COLVAR::coeff

(

ABA_CONSTRAINT *

con

)

[virtual]

Returns:

The coefficient of the constraint con.

Parameters:

con

The constraint of which the coefficient is computed. This must be a pointer to the class ABA_NUMCON.

Reimplemented from ABA_VARIABLE.

double ABA_COLVAR::coeff

(

int

i

)

This version of the function coeff() computes the coefficient of a constraint with a given number.

Returns:

The coefficient of constraint i.

Parameters:

i

The number of the constraint.

ABA_COLUMN* ABA_COLVAR::column

(

)

Returns:

A pointer to the column representing the variable.

---

Friends And Related Function Documentation

ostream& operator<<	(	ostream &	out,
		const ABA_COLVAR &	rhs
	)			[friend]

The output operator writes the column representing the variable to an output stream.

Returns:

A reference to the output stream.

Parameters:

	out	The output stream.
	rhs	The variable being output.

---

Member Data Documentation

ABA_COLUMN ABA_COLVAR::column_ [protected]

Definition at line 161 of file colvar.h.

---

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

• Include/abacus/colvar.h

---