summaryrefslogtreecommitdiff
path: root/thirdparty/linux/include/coin1/IpIdentityMatrix.hpp
blob: 803230640028762c1ca585e959c981260ad5b846 (plain)
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
// Copyright (C) 2004, 2008 International Business Machines and others.
// All Rights Reserved.
// This code is published under the Eclipse Public License.
//
// $Id: IpIdentityMatrix.hpp 2269 2013-05-05 11:32:40Z stefan $
//
// Authors:  Carl Laird, Andreas Waechter     IBM    2004-08-13

#ifndef __IPIDENTITYMATRIX_HPP__
#define __IPIDENTITYMATRIX_HPP__

#include "IpUtils.hpp"
#include "IpSymMatrix.hpp"

namespace Ipopt
{

  /** Class for Matrices which are multiples of the identity matrix.
   *
   */
  class IdentityMatrix : public SymMatrix
  {
  public:

    /**@name Constructors / Destructors */
    //@{

    /** Constructor, initializing with dimensions of the matrix
     *  (true identity matrix).
     */
    IdentityMatrix(const SymMatrixSpace* owner_space);

    /** Destructor */
    ~IdentityMatrix();
    //@}

    /** Method for setting the factor for the identity matrix. */
    void SetFactor(Number factor)
    {
      factor_ = factor;
    }

    /** Method for getting the factor for the identity matrix. */
    Number GetFactor() const
    {
      return factor_;
    }

    /** Method for obtaining the dimention of the matrix. */
    Index Dim() const;

  protected:
    /**@name Methods overloaded from matrix */
    //@{
    virtual void MultVectorImpl(Number alpha, const Vector& x,
                                Number beta, Vector& y) const;

    virtual void AddMSinvZImpl(Number alpha, const Vector& S,
                               const Vector& Z, Vector& X) const;

    /** Method for determining if all stored numbers are valid (i.e.,
     *  no Inf or Nan). */
    virtual bool HasValidNumbersImpl() const;

    virtual void ComputeRowAMaxImpl(Vector& rows_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 */
    IdentityMatrix();

    /** Copy Constructor */
    IdentityMatrix(const IdentityMatrix&);

    /** Overloaded Equals Operator */
    void operator=(const IdentityMatrix&);
    //@}

    /** Scaling factor for this identity matrix */
    Number factor_;
  };

  /** This is the matrix space for IdentityMatrix. */
  class IdentityMatrixSpace : public SymMatrixSpace
  {
  public:
    /** @name Constructors / Destructors */
    //@{
    /** Constructor, given the dimension of the matrix. */
    IdentityMatrixSpace(Index dim)
        :
        SymMatrixSpace(dim)
    {}

    /** Destructor */
    virtual ~IdentityMatrixSpace()
    {}
    //@}

    /** Overloaded MakeNew method for the SymMatrixSpace base class.
     */
    virtual SymMatrix* MakeNewSymMatrix() const
    {
      return MakeNewIdentityMatrix();
    }

    /** Method for creating a new matrix of this specific type. */
    IdentityMatrix* MakeNewIdentityMatrix() const
    {
      return new IdentityMatrix(this);
    }

  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 */
    IdentityMatrixSpace();

    /** Copy Constructor */
    IdentityMatrixSpace(const IdentityMatrixSpace&);

    /** Overloaded Equals Operator */
    void operator=(const IdentityMatrixSpace&);
    //@}
  };

} // namespace Ipopt
#endif