IpSymScaledMatrix.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 __IPSYMSCALEDMATRIX_HPP__
#define __IPSYMSCALEDMATRIX_HPP__
 
#include "IpUtils.hpp"
#include "IpSymMatrix.hpp"
 
namespace Ipopt
{
 
/* forward declarations */
class SymScaledMatrixSpace;
 
class IPOPTLIB_EXPORT SymScaledMatrix: public SymMatrix
{
public:
 
   SymScaledMatrix(
      const SymScaledMatrixSpace* owner_space
   );
 
   ~SymScaledMatrix();
 
   void SetUnscaledMatrix(
      const SmartPtr<const SymMatrix> unscaled_matrix
   );
 
   void SetUnscaledMatrixNonConst(
      const SmartPtr<SymMatrix>& unscaled_matrix
   );
 
   SmartPtr<const SymMatrix> GetUnscaledMatrix() const;
 
   SmartPtr<SymMatrix> GetUnscaledMatrixNonConst();
 
   SmartPtr<const Vector> RowColScaling() const;
 
protected:
   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 PrintImpl(
      const Journalist&  jnlst,
      EJournalLevel      level,
      EJournalCategory   category,
      const std::string& name,
      Index              indent,
      const std::string& prefix
   ) const;
 
private:
 
   SymScaledMatrix();
 
   SymScaledMatrix(
      const SymScaledMatrix&
   );
 
   void operator=(
      const SymScaledMatrix&
   );
 
   SmartPtr<const SymMatrix> matrix_;
 
   SmartPtr<SymMatrix> nonconst_matrix_;
 
   SmartPtr<const SymScaledMatrixSpace> owner_space_;
};
 
class IPOPTLIB_EXPORT SymScaledMatrixSpace: public SymMatrixSpace
{
public:
 
   SymScaledMatrixSpace(
      const SmartPtr<const Vector>&         row_col_scaling,
      bool                                  row_col_scaling_reciprocal,
      const SmartPtr<const SymMatrixSpace>& unscaled_matrix_space
   )
      : SymMatrixSpace(unscaled_matrix_space->Dim()),
        scaling_(row_col_scaling->MakeNewCopy()),
        unscaled_matrix_space_(unscaled_matrix_space)
   {
      if( row_col_scaling_reciprocal )
      {
         scaling_->ElementWiseReciprocal();
      }
   }
 
   ~SymScaledMatrixSpace()
   { }
 
   SymScaledMatrix* MakeNewSymScaledMatrix(
      bool allocate_unscaled_matrix = false
   ) const
   {
      SymScaledMatrix* ret = new SymScaledMatrix(this);
      if( allocate_unscaled_matrix )
      {
         SmartPtr<SymMatrix> unscaled_matrix = unscaled_matrix_space_->MakeNewSymMatrix();
         ret->SetUnscaledMatrixNonConst(unscaled_matrix);
      }
      return ret;
   }
 
   virtual SymMatrix* MakeNewSymMatrix() const
   {
      return MakeNewSymScaledMatrix();
   }
 
   virtual Matrix* MakeNew() const
   {
      return MakeNewSymScaledMatrix();
   }
 
   SmartPtr<const Vector> RowColScaling() const
   {
      return ConstPtr(scaling_);
   }
 
   SmartPtr<const SymMatrixSpace> UnscaledMatrixSpace() const
   {
      return unscaled_matrix_space_;
   }
 
private:
 
   SymScaledMatrixSpace();
 
   SymScaledMatrixSpace(
      const SymScaledMatrixSpace&
   );
 
   SymScaledMatrixSpace& operator=(
      const SymScaledMatrixSpace&
   );
 
   SmartPtr<Vector> scaling_;
 
   SmartPtr<const SymMatrixSpace> unscaled_matrix_space_;
};
 
inline void SymScaledMatrix::SetUnscaledMatrix(
   const SmartPtr<const SymMatrix> unscaled_matrix
)
{
   matrix_ = unscaled_matrix;
   nonconst_matrix_ = NULL;
   ObjectChanged();
}
 
inline void SymScaledMatrix::SetUnscaledMatrixNonConst(
   const SmartPtr<SymMatrix>& unscaled_matrix
)
{
   nonconst_matrix_ = unscaled_matrix;
   matrix_ = GetRawPtr(unscaled_matrix);
   ObjectChanged();
}
 
inline SmartPtr<const SymMatrix> SymScaledMatrix::GetUnscaledMatrix() const
{
   return matrix_;
}
 
inline SmartPtr<SymMatrix> SymScaledMatrix::GetUnscaledMatrixNonConst()
{
   DBG_ASSERT(IsValid(nonconst_matrix_));
   ObjectChanged();
   return nonconst_matrix_;
}
 
inline SmartPtr<const Vector> SymScaledMatrix::RowColScaling() const
{
   return ConstPtr(owner_space_->RowColScaling());
}
 
} // namespace Ipopt
 
#endif