MOOCHO (Single Doxygen Collection) Version of the Day
AbstractLinAlgPack_VectorSpaceTester.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 VECTOR_SPACE_TESTER_H
00043 #define VECTOR_SPACE_TESTER_H
00044 
00045 #include <iosfwd>
00046 
00047 #include "AbstractLinAlgPack_Types.hpp"
00048 #include "Teuchos_StandardMemberCompositionMacros.hpp"
00049 
00050 namespace AbstractLinAlgPack {
00051 
00067 class VectorSpaceTester {
00068 public:
00069 
00071   STANDARD_MEMBER_COMPOSITION_MEMBERS( bool, print_all_tests );
00072 #ifdef DOXYGEN_COMPILE
00073     ;
00074 #endif    
00075 
00076   STANDARD_MEMBER_COMPOSITION_MEMBERS( bool, print_vectors );
00077 #ifdef DOXYGEN_COMPILE
00078     ;
00079 #endif    
00080 
00081   STANDARD_MEMBER_COMPOSITION_MEMBERS( bool, throw_exception );
00082 #ifdef DOXYGEN_COMPILE
00083     ;
00084 #endif    
00085 
00086   STANDARD_MEMBER_COMPOSITION_MEMBERS( size_type, num_random_tests );
00087 #ifdef DOXYGEN_COMPILE
00088     ;
00089 #endif    
00090 
00091   STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, warning_tol );
00092 #ifdef DOXYGEN_COMPILE
00093     ;
00094 #endif    
00095 
00096   STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, error_tol );
00097 #ifdef DOXYGEN_COMPILE
00098     ;
00099 #endif    
00100 
00105   VectorSpaceTester(
00106     bool         print_all_tests  = false
00107     ,bool        print_vectors    = false
00108     ,bool        throw_exception  = true
00109     ,size_type   num_random_tests = 4
00110     ,value_type  warning_tol      = 1e-14
00111     ,value_type  error_tol        = 1e-10
00112     );
00113 
00115   virtual ~VectorSpaceTester() {}
00116 
00146   virtual bool check_vector_space(
00147     const VectorSpace &space
00148     ,std::ostream     *out
00149     ) const;
00150 
00151 private:
00152 
00154   void check_test(value_type err, std::ostream* out, bool* success) const;
00155 
00156 }; // end class VectorSpaceTester
00157 
00158 } // end namespace AbstractLinAlgPack
00159 
00160 #endif // VECTOR_SPACE_TESTER_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines