ABA_OPTSENSE Class Reference

We can either minimize or maximize the objective function. We encapsulate this information in a class since it is required in various classes. More...

#include <optsense.h>

Inheritance diagram for ABA_OPTSENSE:

List of all members.

Public Types
enum	SENSE { Min, Max, Unknown }
Public Member Functions
	ABA_OPTSENSE (SENSE s=Unknown)
void	sense (SENSE s)
	This version of the function sense() sets the optimization sense.
SENSE	sense () const
bool	min () const
bool	max () const
bool	unknown () const
Private Attributes
SENSE	sense_
Friends
ostream &	operator<< (ostream &out, const ABA_OPTSENSE &rhs)
	The output operator writes the optimization sense on an output stream in the form { maximize}, { minimize}, or { unknown}.

---

Detailed Description

We can either minimize or maximize the objective function. We encapsulate this information in a class since it is required in various classes.

Definition at line 43 of file optsense.h.

---

Member Enumeration Documentation

enum ABA_OPTSENSE::SENSE

The enumeration defining the sense of optimization.

Parameters:

	Min	Minimization problem.
	Max	Maximization problem.
	Unknown	Unknown optimization sense, required to recognize uninitialized object.

Enumerator:

Min
Max
Unknown

Definition at line 53 of file optsense.h.

---

Constructor & Destructor Documentation

ABA_OPTSENSE::ABA_OPTSENSE

(

SENSE

s = Unknown

)

[inline]

The constructor initializes the optimization sense.

Parameters:

s

The sense of the optimization. The default value is Unknown.

Definition at line 106 of file optsense.h.

---

Member Function Documentation

void ABA_OPTSENSE::sense

(

SENSE

s

)

[inline]

This version of the function sense() sets the optimization sense.

Parameters:

s

The new sense of the optimization.

Definition at line 116 of file optsense.h.

ABA_OPTSENSE::SENSE ABA_OPTSENSE::sense

(

)

const [inline]

Returns:

The sense of the optimization.

Definition at line 111 of file optsense.h.

bool ABA_OPTSENSE::min

(

)

const [inline]

Returns:

true If it is minimization problem,

false otherwise.

Definition at line 121 of file optsense.h.

bool ABA_OPTSENSE::max

(

)

const [inline]

Returns:

true If it is maximization problem,

false otherwise.

Definition at line 126 of file optsense.h.

bool ABA_OPTSENSE::unknown

(

)

const [inline]

Returns:

true If the optimization sense is unknown,

false otherwise.

Definition at line 131 of file optsense.h.

---

Friends And Related Function Documentation

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

The output operator writes the optimization sense on an output stream in the form { maximize}, { minimize}, or { unknown}.

Returns:

The output stream.

Parameters:

	out	The output stream.
	rhs	The sense being output.

---

Member Data Documentation

SENSE ABA_OPTSENSE::sense_ [private]

The optimization sense.

Definition at line 102 of file optsense.h.

---

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

• Include/abacus/optsense.h

---