// @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_HANDLER_VAR_REDUCT_PERM_STRATEGY_H
#define DECOMPOSITION_SYSTEM_HANDLER_VAR_REDUCT_PERM_STRATEGY_H

#include "MoochoPack_DecompositionSystemHandlerSelectNew_Strategy.hpp"

namespace MoochoPack {

/** \brief Subclass for selecting and updating the range/null space decomposition using
 * the DecompositionSystemVarReductPerm interface.
 *
 * ToDo: Finish documentation!
 */
class DecompositionSystemHandlerVarReductPerm_Strategy
  : public DecompositionSystemHandlerSelectNew_Strategy
{
public:
  
  /** @name Constructors / initializers */
  //@{

  /** \brief Constructor
   */
  DecompositionSystemHandlerVarReductPerm_Strategy();

  //@}

  /** @name Overridden from DecompositionSystemHandler_Strategy */
  //@{

  /** \brief . */
  bool update_decomposition(
    NLPAlgo                                &algo
    ,NLPAlgoState                          &s
    ,NLPFirstOrder                         &nlp
    ,EDecompSysTesting                     decomp_sys_testing
    ,EDecompSysPrintLevel                  decomp_sys_testing_print_level
    ,bool                                  *new_decomp_selected
    );
  /** \brief . */
  void print_update_decomposition(
    const NLPAlgo                          &algo
    ,const NLPAlgoState                    &s
    ,std::ostream                          &out
    ,const std::string                     &leading_spaces
    ) const;

  //@}

  /** @name Overridden from DecompositionSystemHandlerSelectNew_Strategy */
  //@{

  /** \brief . */
  void select_new_decomposition( bool select_new_decomposition );

  //@}

private:

  bool select_new_decomposition_;

}; // end class DecompositionSystemHandlerVarReductPerm_Strategy

} // end namespace MoochoPack

#endif // DECOMPOSITION_SYSTEM_HANDLER_VAR_REDUCT_PERM_STRATEGY_H
