IpSymMatrix.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.
//
// $Id: IpSymMatrix.hpp 2269 2013-05-05 11:32:40Z stefan $
//
// Authors:  Carl Laird, Andreas Waechter     IBM    2004-08-13

#ifndef __IPSYMMATRIX_HPP__
#define __IPSYMMATRIX_HPP__

#include "IpUtils.hpp"
#include "IpMatrix.hpp"

namespace Ipopt
{

  /* forward declarations */
  class SymMatrixSpace;

  class SymMatrix : public Matrix
  {
  public:
    inline
    SymMatrix(const SymMatrixSpace* owner_space);

    virtual ~SymMatrix()
    {}

    inline
    Index Dim() const;

    inline
    SmartPtr<const SymMatrixSpace> OwnerSymMatrixSpace() const;

  protected:
    virtual void TransMultVectorImpl(Number alpha, const Vector& x, Number beta,
                                     Vector& y) const
    {
      // Since this matrix is symetric, this is the same operation as
      // MultVector
      MultVector(alpha, x, beta, y);
    }
    virtual void ComputeColAMaxImpl(Vector& cols_norms, bool init) const
    {
      ComputeRowAMaxImpl(cols_norms, init);
    }

  private:
    const SymMatrixSpace* owner_space_;
  };


  class SymMatrixSpace : public MatrixSpace
  {
  public:
    SymMatrixSpace(Index dim)
        :
        MatrixSpace(dim,dim)
    {}

    virtual ~SymMatrixSpace()
    {}

    virtual SymMatrix* MakeNewSymMatrix() const=0;

    virtual Matrix* MakeNew() const
    {
      return MakeNewSymMatrix();
    }

    Index Dim() const
    {
      DBG_ASSERT(NRows() == NCols());
      return NRows();
    }

  private:
    SymMatrixSpace();

    /* Copy constructor */
    SymMatrixSpace(const SymMatrixSpace&);

    SymMatrixSpace& operator=(const SymMatrixSpace&);

  };

  /* inline methods */
  inline
  SymMatrix::SymMatrix(const SymMatrixSpace* owner_space)
      :
      Matrix(owner_space),
      owner_space_(owner_space)
  {}

  inline
  Index SymMatrix::Dim() const
  {
    return owner_space_->Dim();
  }

  inline
  SmartPtr<const SymMatrixSpace> SymMatrix::OwnerSymMatrixSpace() const
  {
    return owner_space_;
  }

} // namespace Ipopt

#endif