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.
// 
// 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 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