ConstrainedOptPack_MatrixHessianSuperBasic.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 MATRIX_HESSIAN_SUPER_BASIC_H
#define MATRIX_HESSIAN_SUPER_BASIC_H

#include <vector>

#include "ConstrainedOptPack/src/ConstrainedOptPack_Types.hpp"
#include "AbstractLinAlgPack/src/MatrixSymWithOpFactorized.hpp"
#include "AbstractLinAlgPack/src/AbstractLinAlgPack_GenPermMatrixSlice.hpp"
#include "Miref_count_ptr.h"

namespace ConstrainedOptPack {

class MatrixHessianSuperBasic
  : public virtual MatrixSymOp
{
public:

  typedef Teuchos::RCP<const MatrixSymWithOpFactorized>
    B_RR_ptr_t;
  typedef Teuchos::RCP<const MatrixOp>
    B_RX_ptr_t;
  typedef Teuchos::RCP<const MatrixSymOp>
    B_XX_ptr_t;
  typedef std::vector<EBounds>
    bnd_fixed_t;

  MatrixHessianSuperBasic();

  virtual void initialize(
    size_type            n
    ,size_type           n_R
    ,const size_type     i_x_free[]
    ,const size_type     i_x_fixed[]
    ,const EBounds       bnd_fixed[]
    ,const B_RR_ptr_t&   B_RR_ptr
    ,const B_RX_ptr_t&   B_RX_ptr
    ,BLAS_Cpp::Transp    B_RX_trans
    ,const B_XX_ptr_t&   B_XX_ptr
    );


  const GenPermMatrixSlice& Q_R() const;
  const GenPermMatrixSlice& Q_X() const;
  const bnd_fixed_t& bnd_fixed() const;
  const B_RR_ptr_t& B_RR_ptr() const;
  const B_RX_ptr_t& B_RX_ptr() const;
  BLAS_Cpp::Transp B_RX_trans() const;
  const B_XX_ptr_t& B_XX_ptr() const;



  size_type rows() const;



  void Vp_StMtV(DVectorSlice* vs_lhs, value_type alpha, BLAS_Cpp::Transp trans_rhs1
    , const DVectorSlice& vs_rhs2, value_type beta) const;
  void Vp_StMtV(DVectorSlice* vs_lhs, value_type alpha, BLAS_Cpp::Transp trans_rhs1
    , const SpVectorSlice& sv_rhs2, value_type beta) const;
  void Vp_StPtMtV(DVectorSlice* vs_lhs, value_type alpha
    , const GenPermMatrixSlice& P_rhs1, BLAS_Cpp::Transp P_rhs1_trans
    , BLAS_Cpp::Transp M_rhs2_trans
    , const DVectorSlice& sv_rhs3, value_type beta) const;
  value_type transVtMtV(const SpVectorSlice& sv_rhs1, BLAS_Cpp::Transp trans_rhs2
    , const SpVectorSlice& sv_rhs3) const ;


protected:

  void assert_initialized() 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_;
  GenPermMatrixSlice    Q_R_;        // Sorted by row
  row_i_t         Q_R_row_i_;
  col_j_t         Q_R_col_j_;
  GenPermMatrixSlice    Q_X_;        // Sorted by row
  row_i_t         Q_X_row_i_;
  col_j_t         Q_X_col_j_;
  bnd_fixed_t             bnd_fixed_;
  B_RR_ptr_t              B_RR_ptr_;
  B_RX_ptr_t              B_RX_ptr_;
  BLAS_Cpp::Transp        B_RX_trans_;
  B_XX_ptr_t              B_XX_ptr_;

}; // end class MatrixHessianSuperBasic

// ////////////////////////////////////////////
// Inline members for MatrixHessianSuperBasic

inline
const GenPermMatrixSlice& MatrixHessianSuperBasic::Q_R() const
{
  assert_initialized();
  return Q_R_;
}

inline
const GenPermMatrixSlice& MatrixHessianSuperBasic::Q_X() const
{
  assert_initialized();
  return Q_X_;
}

inline
const MatrixHessianSuperBasic::bnd_fixed_t&
MatrixHessianSuperBasic::bnd_fixed() const
{
  return bnd_fixed_;
}

inline
const MatrixHessianSuperBasic::B_RR_ptr_t&
MatrixHessianSuperBasic::B_RR_ptr() const
{
  assert_initialized();
  return B_RR_ptr_;
}

inline
const MatrixHessianSuperBasic::B_RX_ptr_t&
MatrixHessianSuperBasic::B_RX_ptr() const{
  assert_initialized();
  return B_RX_ptr_;
}

inline
BLAS_Cpp::Transp MatrixHessianSuperBasic::B_RX_trans() const
{
  assert_initialized();
  return B_RX_trans_;
}

inline
const MatrixHessianSuperBasic::B_XX_ptr_t&
MatrixHessianSuperBasic::B_XX_ptr() const
{
  assert_initialized();
  return B_XX_ptr_;
}

} // end namespace ConstrainedOptPack

#endif // MATRIX_HESSIAN_SUPER_BASIC_H