MOOCHO (Single Doxygen Collection) Version of the Day
AbstractLinAlgPack_MatrixOpNonsingTester.hpp
Go to the documentation of this file.
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
00005 //                  Copyright (2003) Sandia Corporation
00006 // 
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 // 
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00038 // 
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef MATRIX_WITH_OP_NONSINGULAR_TESTER_H
00043 #define MATRIX_WITH_OP_NONSINGULAR_TESTER_H
00044 
00045 #include <iosfwd>
00046 
00047 #include "AbstractLinAlgPack_Types.hpp"
00048 #include "Teuchos_StandardMemberCompositionMacros.hpp"
00049 
00050 namespace AbstractLinAlgPack {
00051 
00064 class MatrixOpNonsingTester {
00065 public:
00066 
00069 
00071   enum ETestLevel {
00072     TEST_LEVEL_2_BLAS  = 1  
00073     ,TEST_LEVEL_3_BLAS = 2  
00074   };
00076   enum EPrintTestLevel {
00077     PRINT_NONE   = 0  
00078     ,PRINT_BASIC = 1  
00079     ,PRINT_MORE  = 2  
00080     ,PRINT_ALL   = 3  
00081   };
00082 
00084 
00087 
00089   STANDARD_MEMBER_COMPOSITION_MEMBERS( ETestLevel, test_level );
00091   STANDARD_MEMBER_COMPOSITION_MEMBERS( EPrintTestLevel, print_tests );
00093   STANDARD_MEMBER_COMPOSITION_MEMBERS( bool, dump_all );
00095   STANDARD_MEMBER_COMPOSITION_MEMBERS( bool, throw_exception );
00097   STANDARD_MEMBER_COMPOSITION_MEMBERS( size_type, num_random_tests );
00099   STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, warning_tol );
00101   STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, error_tol );
00102 
00104 
00107 
00109   MatrixOpNonsingTester(
00110     ETestLevel       test_level       = TEST_LEVEL_2_BLAS
00111     ,EPrintTestLevel print_tests      = PRINT_NONE
00112     ,bool            dump_all         = false
00113     ,bool            throw_exception  = true
00114     ,size_type       num_random_tests = 1
00115     ,value_type      warning_tol      = 1e-14
00116     ,value_type      error_tol        = 1e-8
00117     );
00118 
00120 
00123  
00152   bool test_matrix(
00153     const MatrixOpNonsing   &M
00154     ,const char                     M_name[]
00155     ,std::ostream                   *out
00156     );
00157 
00159 
00160 }; // end class MatrixOpNonsingTester
00161 
00162 } // end namespace AbstractLinAlgPack
00163 
00164 #endif // MATRIX_WITH_OP_NONSINGULAR_TESTER_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines