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.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//  
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// 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