ConstrainedOptPack_QPInitFixedFreeStd.hpp

Go to the documentation of this file.

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

#include "ConstrainedOptPack_QPSchur.hpp"

namespace ConstrainedOptPack {
namespace QPSchurPack {

class QPInitFixedFreeStd : public QP {
public:

  QPInitFixedFreeStd();

  void initialize(
    const DVectorSlice            &g
    ,const MatrixSymOp          &G
    ,const MatrixOp           *A
    ,size_type                n_R
    ,const size_type            i_x_free[]
    ,const size_type            i_x_fixed[]
    ,const EBounds              bnd_fixed[]
    ,const DVectorSlice           &b_X
    ,const MatrixSymOpNonsing   &Ko
    ,const DVectorSlice           &fo
    ,Constraints              *constraints
    ,std::ostream             *out        = NULL
    ,bool                 test_setup      = false
    ,value_type               warning_tol     = 1e-10
    ,value_type               error_tol     = 1e-5
    ,bool                 print_all_warnings  = false
    );


  size_type n() const;
  size_type m() const;
  const DVectorSlice g() const;
  const MatrixSymOp& G() const;
  const MatrixOp& A() const;
  size_type n_R() const;
  const x_init_t& x_init() const;
  const l_x_X_map_t& l_x_X_map() const;
  const i_x_X_map_t& i_x_X_map() const;
  const DVectorSlice b_X() const;
  const GenPermMatrixSlice& Q_R() const;
  const GenPermMatrixSlice& Q_X() const;
  const MatrixSymOpNonsing& Ko() const;
  const DVectorSlice fo() const;
  Constraints& constraints();
  const Constraints& constraints() const;


private:

  // ///////////////////////////////////
  // Private types

  typedef std::vector<size_type>    row_i_t;
  typedef std::vector<size_type>    col_j_t;
  
  // ///////////////////////////////////
  // Private data members


  size_type       n_;
  size_type       n_R_;
  size_type       m_;
  DVectorSlice        g_; // will not be modified!
  const MatrixSymOp *G_;
  const MatrixOp    *A_;  // If NULL not no equalities in Ko
  x_init_t        x_init_;
  l_x_X_map_t       l_x_X_map_;
  i_x_X_map_t       i_x_X_map_;
  DVectorSlice        b_X_; // will not be modified!
  GenPermMatrixSlice    Q_R_;
  row_i_t         Q_R_row_i_;
  col_j_t         Q_R_col_j_;
  GenPermMatrixSlice    Q_X_;
  row_i_t         Q_X_row_i_;
  col_j_t         Q_X_col_j_;
  const MatrixSymOpNonsing
              *Ko_;
  DVectorSlice        fo_;  // will not be modified
  Constraints       *constraints_;

  // Private member function
  void assert_initialized() const;

};  // end class QPInitFixedFreeStd

} // end namespace QPSchurPack
} // end namespace ConstrainedOptPack 

#endif  // QP_INIT_FIXED_FREE_STD_H