IpSumMatrix.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 __IPSUMMATRIX_HPP__
#define __IPSUMMATRIX_HPP__
 
#include "IpUtils.hpp"
#include "IpMatrix.hpp"
 
namespace Ipopt
{
 
/* forward declarations */
class SumMatrixSpace;
 
class SumMatrix: public Matrix
{
public:
 
   SumMatrix(
      const SumMatrixSpace* owner_space
   );
 
   virtual ~SumMatrix();
 
   void SetTerm(
      Index         iterm,
      Number        factor,
      const Matrix& matrix
   );
 
   void GetTerm(
      Index                   iterm,
      Number&                 factor,
      SmartPtr<const Matrix>& matrix
   ) const;
 
   Index NTerms() 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 bool HasValidNumbersImpl() 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;
 
private:
 
   SumMatrix();
 
   SumMatrix(
      const SumMatrix&
   );
 
   void operator=(
      const SumMatrix&
   );
 
   std::vector<Number> factors_;
 
   std::vector<SmartPtr<const Matrix> > matrices_;
 
   const SumMatrixSpace* owner_space_;
};
 
class SumMatrixSpace: public MatrixSpace
{
public:
 
   SumMatrixSpace(
      Index nrows,
      Index ncols,
      Index nterms
   )
      : MatrixSpace(nrows, ncols),
        nterms_(nterms)
   { }
 
   virtual ~SumMatrixSpace()
   { }
 
   Index NTerms() const
   {
      return nterms_;
   }
 
   void SetTermSpace(
      Index              term_idx,
      const MatrixSpace& mat_space
   );
 
   SmartPtr<const MatrixSpace> GetTermSpace(
      Index term_idx
   ) const;
 
   SumMatrix* MakeNewSumMatrix() const;
 
   virtual Matrix* MakeNew() const;
 
private:
 
   SumMatrixSpace();
 
   SumMatrixSpace(
      const SumMatrixSpace&
   );
 
   SumMatrixSpace& operator=(
      const SumMatrixSpace&
   );
 
   const Index nterms_;
 
   std::vector<SmartPtr<const MatrixSpace> > term_spaces_;
};
 
} // namespace Ipopt
#endif