AbstractLinAlgPack: C++ Interfaces For Vectors, Matrices And Related Linear Algebra Objects Version of the Day
AbstractLinAlgPack_VectorSpaceTester.hpp
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 // This library is free software; you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as
00012 // published by the Free Software Foundation; either version 2.1 of the
00013 // License, or (at your option) any later version.
00014 //  
00015 // This library is distributed in the hope that it will be useful, but
00016 // WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018 // Lesser General Public License for more details.
00019 //  
00020 // You should have received a copy of the GNU Lesser General Public
00021 // License along with this library; if not, write to the Free Software
00022 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00023 // USA
00024 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00025 // 
00026 // ***********************************************************************
00027 // @HEADER
00028 
00029 #ifndef VECTOR_SPACE_TESTER_H
00030 #define VECTOR_SPACE_TESTER_H
00031 
00032 #include <iosfwd>
00033 
00034 #include "AbstractLinAlgPack_Types.hpp"
00035 #include "Teuchos_StandardMemberCompositionMacros.hpp"
00036 
00037 namespace AbstractLinAlgPack {
00038 
00054 class VectorSpaceTester {
00055 public:
00056 
00058   STANDARD_MEMBER_COMPOSITION_MEMBERS( bool, print_all_tests );
00059 #ifdef DOXYGEN_COMPILE
00060     ;
00061 #endif    
00062 
00063   STANDARD_MEMBER_COMPOSITION_MEMBERS( bool, print_vectors );
00064 #ifdef DOXYGEN_COMPILE
00065     ;
00066 #endif    
00067 
00068   STANDARD_MEMBER_COMPOSITION_MEMBERS( bool, throw_exception );
00069 #ifdef DOXYGEN_COMPILE
00070     ;
00071 #endif    
00072 
00073   STANDARD_MEMBER_COMPOSITION_MEMBERS( size_type, num_random_tests );
00074 #ifdef DOXYGEN_COMPILE
00075     ;
00076 #endif    
00077 
00078   STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, warning_tol );
00079 #ifdef DOXYGEN_COMPILE
00080     ;
00081 #endif    
00082 
00083   STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, error_tol );
00084 #ifdef DOXYGEN_COMPILE
00085     ;
00086 #endif    
00087 
00092   VectorSpaceTester(
00093     bool         print_all_tests  = false
00094     ,bool        print_vectors    = false
00095     ,bool        throw_exception  = true
00096     ,size_type   num_random_tests = 4
00097     ,value_type  warning_tol      = 1e-14
00098     ,value_type  error_tol        = 1e-10
00099     );
00100 
00102   virtual ~VectorSpaceTester() {}
00103 
00133   virtual bool check_vector_space(
00134     const VectorSpace &space
00135     ,std::ostream     *out
00136     ) const;
00137 
00138 private:
00139 
00141   void check_test(value_type err, std::ostream* out, bool* success) const;
00142 
00143 }; // end class VectorSpaceTester
00144 
00145 } // end namespace AbstractLinAlgPack
00146 
00147 #endif // VECTOR_SPACE_TESTER_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends