AnasaziTypes.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
//
//                 Anasazi: Block Eigensolvers Package
//                 Copyright (2004) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
// @HEADER

#ifndef ANASAZI_TYPES_HPP
#define ANASAZI_TYPES_HPP

#include "AnasaziConfigDefs.hpp"
#include "Teuchos_RCP.hpp"
#include "Teuchos_ScalarTraits.hpp"

namespace Anasazi {

typedef Teuchos_Ordinal Array_size_type;



  class AnasaziError : public std::logic_error { 
    public: AnasaziError(const std::string& what_arg) : std::logic_error(what_arg) {} 
  };




  template <class ScalarType>
  struct Value {
    typename Teuchos::ScalarTraits<ScalarType>::magnitudeType realpart; 
    typename Teuchos::ScalarTraits<ScalarType>::magnitudeType imagpart;
    void set(const typename Teuchos::ScalarTraits<ScalarType>::magnitudeType &rp, const typename Teuchos::ScalarTraits<ScalarType>::magnitudeType &ip){
      realpart=rp;imagpart=ip;
    }
    Value<ScalarType> &operator=(const Value<ScalarType> &rhs) {
      realpart=rhs.realpart;imagpart=rhs.imagpart;
      return *this;
    }
  };

  template <class ScalarType, class MV>
  struct Eigensolution {
    Teuchos::RCP<MV> Evecs;
    Teuchos::RCP<MV> Espace;
    std::vector<Value<ScalarType> >  Evals;
    std::vector<int>         index;
    int numVecs;
    
    Eigensolution() : Evecs(),Espace(),Evals(0),index(0),numVecs(0) {}
  };




  enum ReturnType 
  {
    Converged,       
    Unconverged      
  };


  enum ConjType 
  {
    NO_CONJ,      
    CONJ          
  };


  enum TestStatus
  {
    Passed    = 0x1,    
    Failed    = 0x2,    
    Undefined = 0x4     
  };

  enum ResType {
    RES_ORTH,
    RES_2NORM,
    RITZRES_2NORM
  };


  enum MsgType 
  {
    Errors = 0,                 
    Warnings = 0x1,             
    IterationDetails = 0x2,     
    OrthoDetails = 0x4,         
    FinalSummary = 0x8,         
    TimingDetails = 0x10,       
    StatusTestDetails = 0x20,   
    Debug = 0x40                
  };


} // end of namespace Anasazi
#endif
// end of file AnasaziTypes.hpp