Ipopt  3.12.11
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
IpSumSymMatrix.hpp
Go to the documentation of this file.
1 // Copyright (C) 2004, 2008 International Business Machines and others.
2 // All Rights Reserved.
3 // This code is published under the Eclipse Public License.
4 //
5 // $Id: IpSumSymMatrix.hpp 2269 2013-05-05 11:32:40Z stefan $
6 //
7 // Authors: Carl Laird, Andreas Waechter IBM 2004-08-13
8 
9 #ifndef __IPSUMSYMMATRIX_HPP__
10 #define __IPSUMSYMMATRIX_HPP__
11 
12 #include "IpUtils.hpp"
13 #include "IpSymMatrix.hpp"
14 
15 namespace Ipopt
16 {
17 
18  /* forward declarations */
19  class SumSymMatrixSpace;
20 
24  class SumSymMatrix : public SymMatrix
25  {
26  public:
27 
30 
34  SumSymMatrix(const SumSymMatrixSpace* owner_space);
35 
37  ~SumSymMatrix();
39 
42  void SetTerm(Index iterm, Number factor, const SymMatrix& matrix);
43 
46  void GetTerm(Index iterm, Number& factor, SmartPtr<const SymMatrix>& matrix) const;
47 
49  Index NTerms() const;
50 
51  protected:
54  virtual void MultVectorImpl(Number alpha, const Vector& x,
55  Number beta, Vector& y) const;
56 
59  virtual bool HasValidNumbersImpl() const;
60 
61  virtual void ComputeRowAMaxImpl(Vector& rows_norms, bool init) const;
62 
63  virtual void ComputeColAMaxImpl(Vector& cols_norms, bool init) const;
64 
65  virtual void PrintImpl(const Journalist& jnlst,
66  EJournalLevel level,
67  EJournalCategory category,
68  const std::string& name,
69  Index indent,
70  const std::string& prefix) const;
72 
73  private:
83  SumSymMatrix();
84 
86  SumSymMatrix(const SumSymMatrix&);
87 
89  void operator=(const SumSymMatrix&);
91 
93  std::vector<Number> factors_;
94 
96  std::vector<SmartPtr<const SymMatrix> > matrices_;
97 
100  };
101 
104  {
105  public:
111  :
112  SymMatrixSpace(ndim),
113  nterms_(nterms)
114  {}
115 
118  {}
120 
124  Index NTerms() const
125  {
126  return nterms_;
127  }
129 
133  void SetTermSpace(Index term_idx, const SymMatrixSpace& space);
134 
137 
140 
143  virtual SymMatrix* MakeNewSymMatrix() const;
144 
145  private:
147 
148  std::vector< SmartPtr<const SymMatrixSpace> > term_spaces_;
149  };
150 
151 } // namespace Ipopt
152 #endif
Number * x
Input: Starting point Output: Optimal solution.
virtual SymMatrix * MakeNewSymMatrix() const
Overloaded MakeNew method for the SymMatrixSpace base class.
virtual void MultVectorImpl(Number alpha, const Vector &x, Number beta, Vector &y) const
Matrix-vector multiply.
std::vector< Number > factors_
std::vector storing the factors for each term.
SmartPtr< const SymMatrixSpace > GetTermSpace(Index term_idx) const
Get the matix space for a particular term.
std::vector< SmartPtr< const SymMatrix > > matrices_
std::vector storing the matrices for each term.
void SetTermSpace(Index term_idx, const SymMatrixSpace &space)
Use this method to set the matrix spaces for the various terms.
double Number
Type of all numbers.
Definition: IpTypes.hpp:17
Vector Base Class.
Definition: IpVector.hpp:47
std::vector< SmartPtr< const SymMatrixSpace > > term_spaces_
Index NTerms() const
Number of terms in the sum.
Class for matrix space for SumSymMatrix.
Index NTerms() const
Return the number of terms.
~SumSymMatrixSpace()
Destructor.
void operator=(const SumSymMatrix &)
Overloaded Equals Operator.
EJournalLevel
Print Level Enum.
~SumSymMatrix()
Destructor.
SumSymMatrixSpace(Index ndim, Index nterms)
Constructor, given the dimension of the matrix and the number of terms in the sum.
This is the base class for all derived symmetric matrix types.
Definition: IpSymMatrix.hpp:23
void GetTerm(Index iterm, Number &factor, SmartPtr< const SymMatrix > &matrix) const
Method for getting term iterm for the sum.
Template class for Smart Pointers.
Definition: IpSmartPtr.hpp:172
SumSymMatrix * MakeNewSumSymMatrix() const
Method for creating a new matrix of this specific type.
Class for Matrices which are sum of symmetric matrices.
virtual void ComputeRowAMaxImpl(Vector &rows_norms, bool init) const
Compute the max-norm of the rows in the matrix.
int Index
Type of all indices of vectors, matrices etc.
Definition: IpTypes.hpp:19
SymMatrixSpace base class, corresponding to the SymMatrix base class.
Definition: IpSymMatrix.hpp:81
Class responsible for all message output.
const SumSymMatrixSpace * owner_space_
Copy of the owner_space as a SumSymMatrixSpace.
virtual void PrintImpl(const Journalist &jnlst, EJournalLevel level, EJournalCategory category, const std::string &name, Index indent, const std::string &prefix) const
Print detailed information about the matrix.
SumSymMatrix()
Default Constructor.
virtual void ComputeColAMaxImpl(Vector &cols_norms, bool init) const
Since the matrix is symmetric, the row and column max norms are identical.
EJournalCategory
Category Selection Enum.
void SetTerm(Index iterm, Number factor, const SymMatrix &matrix)
Method for setting term iterm for the sum.
virtual bool HasValidNumbersImpl() const
Method for determining if all stored numbers are valid (i.e., no Inf or Nan).