1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
// Copyright (C) 2004, 2007 International Business Machines and others.
// All Rights Reserved.
// This code is published under the Eclipse Public License.
//
// Authors: Carl Laird, Andreas Waechter IBM 2004-08-13
#ifndef __IPMUORACLE_HPP__
#define __IPMUORACLE_HPP__
#include "IpAlgStrategy.hpp"
namespace Ipopt
{
/** Abstract Base Class for classes that are able to compute a
* suggested value of the barrier parameter that can be used
* as an oracle in the NonmontoneMuUpdate class.
*/
class MuOracle: public AlgorithmStrategyObject
{
public:
/**@name Constructors / Destructor */
///@{
/** Default Constructor */
MuOracle()
{ }
/** Destructor */
virtual ~MuOracle()
{ }
///@}
virtual bool InitializeImpl(
const OptionsList& options,
const std::string& prefix
) = 0;
/** Method for computing the value of the barrier parameter that
* could be used in the current iteration.
*
* Here, mu_min and
* mu_max are the lower and upper bounds on acceptable values for
* the barrier parameter. The new value of mu is returned in
* new_mu, and the method returns false if a new value could not
* be determined (e.g., because the linear system could not be
* solved for a predictor step).
*/
virtual bool CalculateMu(
Number mu_min,
Number mu_max,
Number& new_mu
) = 0;
private:
/**@name Default Compiler Generated Methods
* (Hidden to avoid implicit creation/calling).
*
* These methods are not implemented and
* we do not want the compiler to implement
* them for us, so we declare them private
* and do not define them. This ensures that
* they will not be implicitly created/called.
*/
///@{
/** Copy Constructor */
MuOracle(
const MuOracle&
);
void operator=(
const MuOracle&
);
///@}
};
} // namespace Ipopt
#endif