Epetra_SerialDenseMatrix.h

Go to the documentation of this file.

/*
//@HEADER
// ************************************************************************
//
//               Epetra: Linear Algebra Services Package
//                 Copyright 2011 Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ************************************************************************
//@HEADER
*/

#ifndef EPETRA_SERIALDENSEMATRIX_H
#define EPETRA_SERIALDENSEMATRIX_H

#include "Epetra_ConfigDefs.h"
#include "Epetra_Object.h"
#include "Epetra_CompObject.h"
#include "Epetra_BLAS.h"
#include "Epetra_SerialDenseOperator.h"
class Epetra_SerialSymDenseMatrix;
class Epetra_VbrMatrix;


//=========================================================================
class EPETRA_LIB_DLL_EXPORT Epetra_SerialDenseMatrix : public Epetra_CompObject, public Epetra_Object, public Epetra_SerialDenseOperator, public Epetra_BLAS {

  public:



  Epetra_SerialDenseMatrix(bool set_object_label=true);


  Epetra_SerialDenseMatrix(int NumRows, int NumCols, bool set_object_label=true);


  Epetra_SerialDenseMatrix(Epetra_DataAccess CV, double* A_in, int LDA_in, int NumRows, int NumCols,
                           bool set_object_label=true);


  Epetra_SerialDenseMatrix(const Epetra_SerialDenseMatrix& Source);

  virtual ~Epetra_SerialDenseMatrix ();



  int Shape(int NumRows, int NumCols);


  int Reshape(int NumRows, int NumCols);




  int Multiply(char TransA, char TransB, double ScalarAB,
         const Epetra_SerialDenseMatrix& A,
         const Epetra_SerialDenseMatrix& B,
         double ScalarThis);

  /* This method is intended to imitate the semantics of the matrix-vector
    multiplication provided by Epetra's sparse matrices. The 'vector' arguments
    are actually matrices; this method will return an error if the
    dimensions of 'x' are not compatible. 'y' will be reshaped if necessary.
  */
  int Multiply(bool transA,
               const Epetra_SerialDenseMatrix& x,
               Epetra_SerialDenseMatrix& y);


  int Multiply(char SideA, double ScalarAB,
         const Epetra_SerialSymDenseMatrix& A,
         const Epetra_SerialDenseMatrix& B,
         double ScalarThis);


  int Scale(double ScalarA);


  virtual double NormOne() const;

  virtual double NormInf() const;





    Epetra_SerialDenseMatrix & operator = (const Epetra_SerialDenseMatrix& Source);


    bool operator==(const Epetra_SerialDenseMatrix& rhs) const;


    bool operator!=(const Epetra_SerialDenseMatrix& rhs) const
    { return !(*this == rhs); }


    Epetra_SerialDenseMatrix & operator += (const Epetra_SerialDenseMatrix& Source);


      double& operator () (int RowIndex, int ColIndex);


    const double& operator () (int RowIndex, int ColIndex) const;


    double* operator [] (int ColIndex);


    const double* operator [] (int ColIndex) const;


  int Random();

  int M() const {return(M_);};

  int N() const {return(N_);};

  double* A() const {return(A_);};

  double* A() {return(A_);};

  int LDA() const {return(LDA_);};

  Epetra_DataAccess CV() const {return(CV_);};


  virtual void Print(std::ostream& os) const;




  virtual double OneNorm() const {return(NormOne());};

  virtual double InfNorm() const {return(NormInf());};




    virtual int SetUseTranspose(bool UseTranspose_in) { UseTranspose_ = UseTranspose_in; return (0); }


  virtual int Apply(const Epetra_SerialDenseMatrix& X, Epetra_SerialDenseMatrix& Y);


    virtual int ApplyInverse(const Epetra_SerialDenseMatrix & X, Epetra_SerialDenseMatrix & Y)
    {
      (void)X;//prevents unused variable compiler warning
      (void)Y;
      return (-1);
    }

    virtual const char * Label() const { return Epetra_Object::Label(); }

    virtual bool UseTranspose() const { return UseTranspose_; }

    virtual bool HasNormInf() const { return true; }

    virtual int RowDim() const { return M(); }

    virtual int ColDim() const { return N(); }

 protected:

  void CopyMat(const double* Source, int Source_LDA, int NumRows, int NumCols,
               double* Target, int Target_LDA, bool add=false);
  void CleanupData();

  int M_;
  int N_;
  bool A_Copied_;
  Epetra_DataAccess CV_;

  //For performance reasons, it's better if Epetra_VbrMatrix can access the
  //LDA_ and A_ members of this class directly without going through an
  //accessor method. Rather than making them public members, we'll make
  //Epetra_VbrMatrix a friend class.

  friend class Epetra_VbrMatrix;

  int LDA_;
  double* A_;

  bool UseTranspose_;
};

// inlined definitions of op() and op[]
//=========================================================================
inline double& Epetra_SerialDenseMatrix::operator () (int RowIndex, int ColIndex) {
#ifdef HAVE_EPETRA_ARRAY_BOUNDS_CHECK
  if (RowIndex >= M_ || RowIndex < 0)
    throw ReportError("Row index = " +toString(RowIndex) +
                      " Out of Range 0 - " + toString(M_-1),-1);
  if (ColIndex >= N_ || ColIndex < 0)
    throw ReportError("Column index = " +toString(ColIndex) +
                      " Out of Range 0 - " + toString(N_-1),-2);
#endif
   return(A_[ColIndex*LDA_ + RowIndex]);
}
//=========================================================================
inline const double& Epetra_SerialDenseMatrix::operator () (int RowIndex, int ColIndex) const {
#ifdef HAVE_EPETRA_ARRAY_BOUNDS_CHECK
  if (RowIndex >= M_ || RowIndex < 0)
    throw ReportError("Row index = " +toString(RowIndex) +
                      " Out of Range 0 - " + toString(M_-1),-1);
  if (ColIndex >= N_ || ColIndex < 0)
    throw ReportError("Column index = " +toString(ColIndex) +
                      " Out of Range 0 - " + toString(N_-1),-2);
#endif
  return(A_[ColIndex*LDA_ + RowIndex]);
}
//=========================================================================
inline double* Epetra_SerialDenseMatrix::operator [] (int ColIndex) {
#ifdef HAVE_EPETRA_ARRAY_BOUNDS_CHECK
  if (ColIndex >= N_ || ColIndex < 0)
    throw ReportError("Column index = " +toString(ColIndex) +
                      " Out of Range 0 - " + toString(N_-1),-2);
#endif
  return(A_ + ColIndex*LDA_);
}
//=========================================================================
inline const double* Epetra_SerialDenseMatrix::operator [] (int ColIndex) const {
#ifdef HAVE_EPETRA_ARRAY_BOUNDS_CHECK
  if (ColIndex >= N_ || ColIndex < 0)
    throw ReportError("Column index = " +toString(ColIndex) +
                      " Out of Range 0 - " + toString(N_-1),-2);
#endif
  return(A_+ ColIndex*LDA_);
}
//=========================================================================

#endif /* EPETRA_SERIALDENSEMATRIX_H */