IpIdentityMatrix.hpp

Go to the documentation of this file.

// 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 __IPIDENTITYMATRIX_HPP__
#define __IPIDENTITYMATRIX_HPP__
 
#include "IpUtils.hpp"
#include "IpSymMatrix.hpp"
 
namespace Ipopt
{
 
class IPOPTLIB_EXPORT IdentityMatrix: public SymMatrix
{
public:
 
   IdentityMatrix(
      const SymMatrixSpace* owner_space
   );
 
   ~IdentityMatrix();
 
   void SetFactor(
      Number factor
   )
   {
      factor_ = factor;
   }
 
   Number GetFactor() const
   {
      return factor_;
   }
 
   Index Dim() const;
 
protected:
   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;
 
   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:
 
   IdentityMatrix();
 
   IdentityMatrix(
      const IdentityMatrix&
   );
 
   void operator=(
      const IdentityMatrix&
   );
 
   Number factor_;
};
 
class IPOPTLIB_EXPORT IdentityMatrixSpace: public SymMatrixSpace
{
public:
 
   IdentityMatrixSpace(
      Index dim
   )
      : SymMatrixSpace(dim)
   { }
 
   virtual ~IdentityMatrixSpace()
   { }
 
   virtual SymMatrix* MakeNewSymMatrix() const
   {
      return MakeNewIdentityMatrix();
   }
 
   IdentityMatrix* MakeNewIdentityMatrix() const
   {
      return new IdentityMatrix(this);
   }
 
private:
 
   IdentityMatrixSpace();
 
   IdentityMatrixSpace(
      const IdentityMatrixSpace&
   );
 
   void operator=(
      const IdentityMatrixSpace&
   );
};
 
} // namespace Ipopt
#endif