MoochoPack : Framework for Large-Scale Optimization Algorithms  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
MoochoPack_ActSetStats.hpp
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 ACT_SET_STATS_H
43 #define ACT_SET_STATS_H
44 
45 #include "MoochoPack_Types.hpp"
46 
47 namespace MoochoPack {
48 
52 class ActSetStats {
53 public:
54 
55  // Public types
56 
58  enum { NOT_KNOWN = -1 };
59 
60  // Public interface
61 
64  : num_active_(NOT_KNOWN), num_adds_(NOT_KNOWN), num_drops_(NOT_KNOWN)
65  , num_active_indep_(NOT_KNOWN), num_adds_indep_(NOT_KNOWN), num_drops_indep_(NOT_KNOWN)
66  {}
67 
69  void set_stats(
70  int num_active, int num_adds, int num_drops
72  )
73  {
74  num_active_ = num_active;
75  num_adds_ = num_adds;
76  num_drops_ = num_drops;
77  num_active_indep_ = num_active_indep;
78  num_adds_indep_ = num_adds_indep;
79  num_drops_indep_ = num_drops_indep;
80  }
81 
83  int num_active() const
84  {
85  return num_active_;
86  }
88  int num_adds() const
89  {
90  return num_adds_;
91  }
93  int num_drops() const
94  {
95  return num_drops_;
96  }
97 
99  int num_active_indep() const
100  {
101  return num_active_indep_;
102  }
104  int num_adds_indep() const
105  {
106  return num_adds_indep_;
107  }
109  int num_drops_indep() const
110  {
111  return num_drops_indep_;
112  }
113 
114 private:
115  int num_active_;
116  int num_adds_;
117  int num_drops_;
118  int num_active_indep_;
119  int num_adds_indep_;
120  int num_drops_indep_;
121 
122 }; // end class ActSetStats
123 
124 } // end namespace MoochoPack
125 
126 #endif // ACT_SET_STATS_H
void set_stats(int num_active, int num_adds, int num_drops, int num_active_indep, int num_adds_indep, int num_drops_indep)
Initialize the statistics.
ActSetStats()
Construct all unknowns.
Class for storing statistics about the changes in the active set of an SQP algorithm.