AbstractLinAlgPack_MatrixOpNonsingTester.hpp

// @HEADER
// ***********************************************************************
// 
// Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
//                  Copyright (2003) 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef MATRIX_WITH_OP_NONSINGULAR_TESTER_H
#define MATRIX_WITH_OP_NONSINGULAR_TESTER_H

#include <iosfwd>

#include "AbstractLinAlgPack_Types.hpp"
#include "Teuchos_StandardMemberCompositionMacros.hpp"

namespace AbstractLinAlgPack {

class MatrixOpNonsingTester {
public:


  enum ETestLevel {
    TEST_LEVEL_2_BLAS  = 1  
    ,TEST_LEVEL_3_BLAS = 2  
  };
  enum EPrintTestLevel {
    PRINT_NONE   = 0  
    ,PRINT_BASIC = 1  
    ,PRINT_MORE  = 2  
    ,PRINT_ALL   = 3  
  };



  STANDARD_MEMBER_COMPOSITION_MEMBERS( ETestLevel, test_level );
  STANDARD_MEMBER_COMPOSITION_MEMBERS( EPrintTestLevel, print_tests );
  STANDARD_MEMBER_COMPOSITION_MEMBERS( bool, dump_all );
  STANDARD_MEMBER_COMPOSITION_MEMBERS( bool, throw_exception );
  STANDARD_MEMBER_COMPOSITION_MEMBERS( size_type, num_random_tests );
  STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, warning_tol );
  STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, error_tol );



  MatrixOpNonsingTester(
    ETestLevel       test_level       = TEST_LEVEL_2_BLAS
    ,EPrintTestLevel print_tests      = PRINT_NONE
    ,bool            dump_all         = false
    ,bool            throw_exception  = true
    ,size_type       num_random_tests = 1
    ,value_type      warning_tol      = 1e-14
    ,value_type      error_tol        = 1e-8
    );


 
  bool test_matrix(
    const MatrixOpNonsing   &M
    ,const char                     M_name[]
    ,std::ostream                   *out
    );


}; // end class MatrixOpNonsingTester

} // end namespace AbstractLinAlgPack

#endif // MATRIX_WITH_OP_NONSINGULAR_TESTER_H