ConstrainedOptPack_DecompositionSystemTester.hpp

// @HEADER
// ***********************************************************************
// 
// Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
//                  Copyright (2003) Sandia Corporation
// 
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
// 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef DECOMPOSITION_SYSTEM_TESTER_H
#define DECOMPOSITION_SYSTEM_TESTER_H

#include <iosfwd>

#include "ConstrainedOptPack_Types.hpp"
#include "Teuchos_StandardMemberCompositionMacros.hpp"

namespace ConstrainedOptPack {

class DecompositionSystemTester {
public:


  enum EPrintTestLevel {
    PRINT_NOT_SELECTED =0  
    ,PRINT_NONE        =1  
    ,PRINT_BASIC       =2  
    ,PRINT_MORE        =3  
    ,PRINT_ALL         =4  
  };
  STANDARD_MEMBER_COMPOSITION_MEMBERS( EPrintTestLevel, print_tests );
  STANDARD_MEMBER_COMPOSITION_MEMBERS( bool, dump_all );
  STANDARD_MEMBER_COMPOSITION_MEMBERS( bool, throw_exception );
  STANDARD_MEMBER_COMPOSITION_MEMBERS( size_type, num_random_tests );
  STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, mult_warning_tol );
  STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, mult_error_tol );
  STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, solve_warning_tol );
  STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, solve_error_tol );


  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
    );
 
  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
    );

}; // end class DecompositionSystemTester

} // end namespace ConstrainedOptPack

#endif // DECOMPOSITION_SYSTEM_TESTER_H