6.12 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.

#include <optsense.h>

Inheritance diagram for ABA_OPTSENSE::

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}.

6.12.1 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.

6.12.2 Member Enumeration Documentation

6.12.2.1 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.

6.12.3 Constructor & Destructor Documentation

6.12.3.1 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.

6.12.4 Member Function Documentation

6.12.4.1 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.

6.12.4.2 ABA_OPTSENSE::SENSE ABA_OPTSENSE::sense () const [inline]

Returns:

The sense of the optimization.

Definition at line 111 of file optsense.h.

6.12.4.3 bool ABA_OPTSENSE::min () const [inline]

Returns:

true If it is minimization problem,

false otherwise.

Definition at line 121 of file optsense.h.

6.12.4.4 bool ABA_OPTSENSE::max () const [inline]

Returns:

true If it is maximization problem,

false otherwise.

Definition at line 126 of file optsense.h.

6.12.4.5 bool ABA_OPTSENSE::unknown () const [inline]

Returns:

true If the optimization sense is unknown,

false otherwise.

Definition at line 131 of file optsense.h.

6.12.5 Friends And Related Function Documentation

6.12.5.1 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.

6.12.6 Member Data Documentation

6.12.6.1 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