MOOCHO (Single Doxygen Collection)
Version of the Day
Main Page
Related Pages
Modules
Namespaces
Classes
Files
File List
File Members
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Friends
Macros
Groups
Pages
src
MoochoPack
src
std
MoochoPack_QuasiNewtonStats.hpp
Go to the documentation of this file.
1
// @HEADER
2
// ***********************************************************************
3
//
4
// Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
5
// Copyright (2003) Sandia Corporation
6
//
7
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8
// license for use of this work by or on behalf of the U.S. Government.
9
//
10
// Redistribution and use in source and binary forms, with or without
11
// modification, are permitted provided that the following conditions are
12
// met:
13
//
14
// 1. Redistributions of source code must retain the above copyright
15
// notice, this list of conditions and the following disclaimer.
16
//
17
// 2. Redistributions in binary form must reproduce the above copyright
18
// notice, this list of conditions and the following disclaimer in the
19
// documentation and/or other materials provided with the distribution.
20
//
21
// 3. Neither the name of the Corporation nor the names of the
22
// contributors may be used to endorse or promote products derived from
23
// this software without specific prior written permission.
24
//
25
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36
//
37
// Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov)
38
//
39
// ***********************************************************************
40
// @HEADER
41
42
#ifndef QUASI_NEWTON_STATS_H
43
#define QUASI_NEWTON_STATS_H
44
45
#include "
MoochoPack_Types.hpp
"
46
47
namespace
MoochoPack {
48
51
class
QuasiNewtonStats
{
52
public
:
53
54
// Public types
55
57
enum
EUpdate
{
UNKNOWN
,
REINITIALIZED
,
UPDATED
,
DAMPENED_UPDATED
58
,
SKIPED
,
INDEF_SKIPED
};
59
60
// Public interface
61
63
QuasiNewtonStats
()
64
:
update_
(
UNKNOWN
)
65
{}
66
68
void
set_updated_stats
(
EUpdate
update )
69
{
70
update_
= update;
71
}
72
74
EUpdate
updated
()
const
75
{
76
return
update_
;
77
}
78
79
private
:
80
EUpdate
update_
;
81
82
};
// end class QuasiNewtonStats
83
84
}
// end namespace MoochoPack
85
86
#endif // QUASI_NEWTON_STATS_H
MoochoPack::QuasiNewtonStats::UNKNOWN
Definition:
MoochoPack_QuasiNewtonStats.hpp:57
MoochoPack::QuasiNewtonStats::QuasiNewtonStats
QuasiNewtonStats()
Construct all unknowns.
Definition:
MoochoPack_QuasiNewtonStats.hpp:63
MoochoPack::QuasiNewtonStats
Class for storing statistics about the Quasi-Newton updating.
Definition:
MoochoPack_QuasiNewtonStats.hpp:51
MoochoPack::QuasiNewtonStats::EUpdate
EUpdate
Set to this value if a statistic is not known.
Definition:
MoochoPack_QuasiNewtonStats.hpp:57
MoochoPack::QuasiNewtonStats::updated
EUpdate updated() const
Definition:
MoochoPack_QuasiNewtonStats.hpp:74
MoochoPack_Types.hpp
MoochoPack::QuasiNewtonStats::UPDATED
Definition:
MoochoPack_QuasiNewtonStats.hpp:57
MoochoPack::QuasiNewtonStats::SKIPED
Definition:
MoochoPack_QuasiNewtonStats.hpp:58
MoochoPack::QuasiNewtonStats::REINITIALIZED
Definition:
MoochoPack_QuasiNewtonStats.hpp:57
MoochoPack::QuasiNewtonStats::update_
EUpdate update_
Definition:
MoochoPack_QuasiNewtonStats.hpp:80
MoochoPack::QuasiNewtonStats::DAMPENED_UPDATED
Definition:
MoochoPack_QuasiNewtonStats.hpp:57
MoochoPack::QuasiNewtonStats::set_updated_stats
void set_updated_stats(EUpdate update)
Initialize the statistics.
Definition:
MoochoPack_QuasiNewtonStats.hpp:68
MoochoPack::QuasiNewtonStats::INDEF_SKIPED
Definition:
MoochoPack_QuasiNewtonStats.hpp:58
Generated on Wed Dec 2 2015 08:50:26 for MOOCHO (Single Doxygen Collection) by
1.8.6