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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
// Copyright (C) 2004, 2008 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 __IPSUMSYMMATRIX_HPP__
#define __IPSUMSYMMATRIX_HPP__
#include "IpUtils.hpp"
#include "IpSymMatrix.hpp"
namespace Ipopt
{
/* forward declarations */
class SumSymMatrixSpace;
/** Class for Matrices which are sum of symmetric matrices.
*
* For each term in the sum we store the matrix and a factor.
*/
class IPOPTLIB_EXPORT SumSymMatrix: public SymMatrix
{
public:
/**@name Constructors / Destructors */
///@{
/** Constructor, initializing with dimensions of the matrix and
* the number of terms in the sum.
*/
SumSymMatrix(
const SumSymMatrixSpace* owner_space
);
/** Destructor */
~SumSymMatrix();
///@}
/** Method for setting term iterm for the sum.
*
* Note that counting of terms starts at 0.
*/
void SetTerm(
Index iterm,
Number factor,
const SymMatrix& matrix
);
/** Method for getting term iterm for the sum.
*
* Note that counting of terms starts at 0.
*/
void GetTerm(
Index iterm,
Number& factor,
SmartPtr<const SymMatrix>& matrix
) const;
/** Return the number of terms */
Index NTerms() const;
protected:
/**@name Methods overloaded from matrix */
///@{
virtual void MultVectorImpl(
Number alpha,
const Vector& x,
Number beta,
Vector& y
) const;
virtual bool HasValidNumbersImpl() const;
virtual void ComputeRowAMaxImpl(
Vector& rows_norms,
bool init
) const;
virtual void ComputeColAMaxImpl(
Vector& cols_norms,
bool init
) const;
virtual void PrintImpl(
const Journalist& jnlst,
EJournalLevel level,
EJournalCategory category,
const std::string& name,
Index indent,
const std::string& prefix
) const;
///@}
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.
*/
///@{
/** Default Constructor */
SumSymMatrix();
/** Copy Constructor */
SumSymMatrix(
const SumSymMatrix&
);
/** Default Assignment Operator */
void operator=(
const SumSymMatrix&
);
///@}
/** std::vector storing the factors for each term. */
std::vector<Number> factors_;
/** std::vector storing the matrices for each term. */
std::vector<SmartPtr<const SymMatrix> > matrices_;
/** Copy of the owner_space as a SumSymMatrixSpace */
const SumSymMatrixSpace* owner_space_;
};
/** Class for matrix space for SumSymMatrix */
class IPOPTLIB_EXPORT SumSymMatrixSpace: public SymMatrixSpace
{
public:
/** @name Constructors / Destructors */
///@{
/** Constructor, given the dimension of the matrix and the number
* of terms in the sum.
*/
SumSymMatrixSpace(
Index ndim,
Index nterms
)
: SymMatrixSpace(ndim),
nterms_(nterms)
{ }
/** Destructor */
~SumSymMatrixSpace()
{ }
///@}
/** @name Accessor functions */
///@{
/** Number of terms in the sum. */
Index NTerms() const
{
return nterms_;
}
///@}
/** Use this method to set the matrix spaces for the various terms.
*
* You will not be able to create a matrix until all these spaces
* are set.
*/
void SetTermSpace(
Index term_idx,
const SymMatrixSpace& space
);
/** Get the matrix space for a particular term */
SmartPtr<const SymMatrixSpace> GetTermSpace(
Index term_idx
) const;
/** Method for creating a new matrix of this specific type. */
SumSymMatrix* MakeNewSumSymMatrix() const;
virtual SymMatrix* MakeNewSymMatrix() const;
private:
Index nterms_;
std::vector<SmartPtr<const SymMatrixSpace> > term_spaces_;
};
} // namespace Ipopt
#endif