Ipopt Documentation
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Friends
Macros
Pages
IpConvCheck.hpp
Go to the documentation of this file.
1
// Copyright (C) 2004, 2009 International Business Machines and others.
2
// All Rights Reserved.
3
// This code is published under the Eclipse Public License.
4
//
5
// Authors: Carl Laird, Andreas Waechter IBM 2004-08-13
6
7
#ifndef __IPCONVCHECK_HPP__
8
#define __IPCONVCHECK_HPP__
9
10
#include "
IpAlgStrategy.hpp
"
11
12
namespace
Ipopt
13
{
14
16
class
IPOPTLIB_EXPORT
ConvergenceCheck
:
public
AlgorithmStrategyObject
17
{
18
public
:
20
22
ConvergenceCheck
()
23
{ }
24
26
virtual
~ConvergenceCheck
()
27
{ }
29
31
enum
ConvergenceStatus
32
{
33
CONTINUE
,
34
CONVERGED
,
35
CONVERGED_TO_ACCEPTABLE_POINT
,
36
MAXITER_EXCEEDED
,
37
CPUTIME_EXCEEDED
,
38
DIVERGING
,
39
USER_STOP
,
40
FAILED
41
};
42
44
virtual
bool
InitializeImpl(
45
const
OptionsList
& options,
46
const
std::string& prefix
47
) = 0;
48
55
virtual
ConvergenceStatus CheckConvergence(
56
bool
call_intermediate_callback =
true
57
) = 0;
58
66
virtual
bool
CurrentIsAcceptable() = 0;
67
68
private
:
78
80
// ConvergenceCheck();
82
ConvergenceCheck
(
83
const
ConvergenceCheck
&
84
);
85
87
void
operator=(
88
const
ConvergenceCheck
&
89
);
91
92
};
93
94
}
// namespace Ipopt
95
96
#endif
IpAlgStrategy.hpp
Ipopt::AlgorithmStrategyObject
This is the base class for all algorithm strategy objects.
Definition:
IpAlgStrategy.hpp:34
Ipopt::ConvergenceCheck
Base class for checking the algorithm termination criteria.
Definition:
IpConvCheck.hpp:16
Ipopt::OptionsList
This class stores a list of user set options.
Definition:
IpOptionsList.hpp:32
Ipopt::ConvergenceCheck::CONVERGED_TO_ACCEPTABLE_POINT
Definition:
IpConvCheck.hpp:35
Ipopt::ConvergenceCheck::MAXITER_EXCEEDED
Definition:
IpConvCheck.hpp:36
Ipopt::ConvergenceCheck::ConvergenceStatus
ConvergenceStatus
Convergence return enum.
Definition:
IpConvCheck.hpp:31
Ipopt::ConvergenceCheck::USER_STOP
Definition:
IpConvCheck.hpp:39
IPOPTLIB_EXPORT
#define IPOPTLIB_EXPORT
Definition:
config_default.h:10
Ipopt::ConvergenceCheck::CONVERGED
Definition:
IpConvCheck.hpp:34
Ipopt::ConvergenceCheck::~ConvergenceCheck
virtual ~ConvergenceCheck()
Destructor.
Definition:
IpConvCheck.hpp:26
Ipopt::ConvergenceCheck::ConvergenceCheck
ConvergenceCheck()
Constructor.
Definition:
IpConvCheck.hpp:22
Ipopt::ConvergenceCheck::CONTINUE
Definition:
IpConvCheck.hpp:33
Ipopt::ConvergenceCheck::CPUTIME_EXCEEDED
Definition:
IpConvCheck.hpp:37
Ipopt::ConvergenceCheck::DIVERGING
Definition:
IpConvCheck.hpp:38