IpExpansionMatrix.hpp

Go to the documentation of this file.

// Copyright (C) 2004, 2009 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 __IPEXPANSIONMATRIX_HPP__
#define __IPEXPANSIONMATRIX_HPP__
 
#include "IpUtils.hpp"
#include "IpMatrix.hpp"
 
namespace Ipopt
{

class ExpansionMatrixSpace;

class IPOPTLIB_EXPORT ExpansionMatrix: public Matrix
{
public:

   ExpansionMatrix(
      const ExpansionMatrixSpace* owner_space
   );

   ~ExpansionMatrix();

   const Index* ExpandedPosIndices() const;

   const Index* CompressedPosIndices() const;
 
protected:
   virtual void MultVectorImpl(
      Number        alpha,
      const Vector& x,
      Number        beta,
      Vector&       y
   ) const;
 
   virtual void TransMultVectorImpl(
      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 void SinvBlrmZMTdBrImpl(
      Number        alpha,
      const Vector& S,
      const Vector& R,
      const Vector& Z,
      const Vector& D,
      Vector&       X
   ) 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
   {
      PrintImplOffset(jnlst, level, category, name, indent, prefix, 1, 1);
   }

 
   void PrintImplOffset(
      const Journalist&  jnlst,
      EJournalLevel      level,
      EJournalCategory   category,
      const std::string& name,
      Index              indent,
      const std::string& prefix,
      Index              row_offset,
      Index              col_offset
   ) const;
 
   friend class ParExpansionMatrix;
 
private:

   ExpansionMatrix();

   ExpansionMatrix(
      const ExpansionMatrix&
   );

   void operator=(
      const ExpansionMatrix&
   );
 
   const ExpansionMatrixSpace* owner_space_;
 
};

class IPOPTLIB_EXPORT ExpansionMatrixSpace: public MatrixSpace
{
public:

   ExpansionMatrixSpace(
      Index        NLargeVec,
      Index        NSmallVec,
      const Index* ExpPos,
      const int    offset = 0
   );

   ~ExpansionMatrixSpace()
   {
      delete[] compressed_pos_;
      delete[] expanded_pos_;
   }


   ExpansionMatrix* MakeNewExpansionMatrix() const
   {
      return new ExpansionMatrix(this);
   }
 
   virtual Matrix* MakeNew() const
   {
      return MakeNewExpansionMatrix();
   }

   const Index* ExpandedPosIndices() const
   {
      return expanded_pos_;
   }

   const Index* CompressedPosIndices() const
   {
      return compressed_pos_;
   }
 
private:
   Index* expanded_pos_;
   Index* compressed_pos_;
};
 
/* inline methods */
inline const Index* ExpansionMatrix::ExpandedPosIndices() const
{
   return owner_space_->ExpandedPosIndices();
}
 
inline const Index* ExpansionMatrix::CompressedPosIndices() const
{
   return owner_space_->CompressedPosIndices();
}
 
} // namespace Ipopt
#endif