ConstrainedOptPack: C++ Tools for Constrained (and Unconstrained) Optimization  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ConstrainedOptPack_DecompositionSystemTester.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 DECOMPOSITION_SYSTEM_TESTER_H
43 #define DECOMPOSITION_SYSTEM_TESTER_H
44 
45 #include <iosfwd>
46 
47 #include "ConstrainedOptPack_Types.hpp"
49 
50 namespace ConstrainedOptPack {
51 
70 public:
71 
74 
81  ,PRINT_ALL =4
82  };
86  STANDARD_MEMBER_COMPOSITION_MEMBERS( bool, dump_all );
88  STANDARD_MEMBER_COMPOSITION_MEMBERS( bool, throw_exception );
92  STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, mult_warning_tol );
94  STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, mult_error_tol );
96  STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, solve_warning_tol );
98  STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, solve_error_tol );
99 
101 
104  EPrintTestLevel print_tests = PRINT_NOT_SELECTED
105  ,bool dump_all = false
106  ,bool throw_exception = true
107  ,size_type num_random_tests = 1
108  ,value_type mult_warning_tol = 1e-14
109  ,value_type mult_error_tol = 1e-8
110  ,value_type solve_warning_tol = 1e-14
111  ,value_type solve_error_tol = 1e-8
112  );
113 
152  bool test_decomp_system(
153  const DecompositionSystem &decomp_sys
154  ,const MatrixOp &Gc
155  ,const MatrixOp *Z
156  ,const MatrixOp *Y
157  ,const MatrixOpNonsing *R
158  ,const MatrixOp *Uz
159  ,const MatrixOp *Uy
160  ,std::ostream *out
161  );
162 
163 }; // end class DecompositionSystemTester
164 
165 } // end namespace ConstrainedOptPack
166 
167 #endif // DECOMPOSITION_SYSTEM_TESTER_H
bool test_decomp_system(const DecompositionSystem &decomp_sys, const MatrixOp &Gc, const MatrixOp *Z, const MatrixOp *Y, const MatrixOpNonsing *R, const MatrixOp *Uz, const MatrixOp *Uy, std::ostream *out)
Test a DecompositionSystem object after DecompositionSystem::update_basis() is called.
DecompositionSystemTester(EPrintTestLevel print_tests=PRINT_NOT_SELECTED, bool dump_all=false, bool throw_exception=true, size_type num_random_tests=1, value_type mult_warning_tol=1e-14, value_type mult_error_tol=1e-8, value_type solve_warning_tol=1e-14, value_type solve_error_tol=1e-8)
Constructor (default options)
Print everything all the tests in great detail but output is independent of problem size...
STANDARD_MEMBER_COMPOSITION_MEMBERS(EPrintTestLevel, print_tests)
Set the level of output produced durring tests.
size_t size_type
This class abstracts a decomposition choice for the quasi-range space Y and null space Z matrices for...
The print option has not been selected (will default to PRINT_NONE if not set)