AbstractLinAlgPack: C++ Interfaces For Vectors, Matrices And Related Linear Algebra Objects  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
AbstractLinAlgPack_BasisSystemTester.hpp
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
5 // Copyright (2003) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #ifndef BASIS_SYSTEM_TESTER_H
43 #define BASIS_SYSTEM_TESTER_H
44 
45 #include <iosfwd>
46 
47 #include "AbstractLinAlgPack_Types.hpp"
49 
50 namespace AbstractLinAlgPack {
51 
70 public:
71 
74 
78  ,PRINT_NONE = 1
80  ,PRINT_MORE = 3
81  ,PRINT_ALL = 4
82  };
83 
85 
88 
92  STANDARD_MEMBER_COMPOSITION_MEMBERS( bool, dump_all );
94  STANDARD_MEMBER_COMPOSITION_MEMBERS( bool, throw_exception );
96  STANDARD_MEMBER_COMPOSITION_MEMBERS( size_type, num_random_tests );
98  STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, warning_tol );
100  STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, error_tol );
101 
103 
106 
109  EPrintTestLevel print_tests = PRINT_NOT_SELECTED
110  ,bool dump_all = false
111  ,bool throw_exception = true
112  ,size_type num_random_tests = 1
113  ,value_type warning_tol = 1e-14
114  ,value_type error_tol = 1e-8
115  );
116 
118 
121 
161  bool test_basis_system(
162  const BasisSystem &basis_sys
163  ,const MatrixOp *Gc
164  ,const MatrixOpNonsing *C
165  ,const MatrixOp *N
166  ,const MatrixOp *D
167  ,const MatrixOp *GcUP
168  ,std::ostream *out
169  );
170 
172 
173 }; // end class BasisSystemTester
174 
175 } // end namespace AbstractLinAlgPack
176 
177 #endif // BASIS_SYSTEM_TESTER_H
Interface for the creation and maintainance of a basis matrix for a decomposition of linearlized cons...
bool test_basis_system(const BasisSystem &basis_sys, const MatrixOp *Gc, const MatrixOpNonsing *C, const MatrixOp *N, const MatrixOp *D, const MatrixOp *GcUP, std::ostream *out)
Test a BasisSystem object after BasisSystem::update_basis() is called.
STANDARD_MEMBER_COMPOSITION_MEMBERS(EPrintTestLevel, print_tests)
Set the level of output produced durring tests.
The print option has not been selected (will default to PRINT_NONE if not set)
BasisSystemTester(EPrintTestLevel print_tests=PRINT_NOT_SELECTED, 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)
Constructor (default options)
Base class for all matrices that support basic matrix operations.
Abstract base class for all nonsingular polymorphic matrices that can be used to compute matrix-vecto...
Print everything all the tests in great detail but output is independent of problem size...