ConstrainedOptPack_MatrixSymHessianRelaxNonSing.cpp

// @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

#include <assert.h>

#include "ConstrainedOptPack_MatrixSymHessianRelaxNonSing.hpp"
#include "AbstractLinAlgPack_VectorDenseEncap.hpp"
#include "AbstractLinAlgPack_LinAlgOpPackHack.hpp"
#include "AbstractLinAlgPack_SpVectorClass.hpp"
#include "AbstractLinAlgPack_GenPermMatrixSlice.hpp"
#include "AbstractLinAlgPack_VectorSpaceBlocked.hpp"
#include "AbstractLinAlgPack_LinAlgOpPack.hpp"
#include "DenseLinAlgPack_AssertOp.hpp"
#include "DenseLinAlgPack_LinAlgOpPack.hpp"
#include "ProfileHackPack_profile_hack.hpp"
#include "Teuchos_Assert.hpp"

namespace {

//
template<class V>
void Vp_StPtMtV_imp( 
  DenseLinAlgPack::DVectorSlice* y, DenseLinAlgPack::value_type a
  ,const AbstractLinAlgPack::GenPermMatrixSlice& P, BLAS_Cpp::Transp P_trans
  ,const ConstrainedOptPack::MatrixSymHessianRelaxNonSing& H, BLAS_Cpp::Transp H_trans
  ,const V& x, DenseLinAlgPack::value_type b
  )
{
  using BLAS_Cpp::no_trans;
  using BLAS_Cpp::trans;
  using BLAS_Cpp::trans_not;
  using AbstractLinAlgPack::Vp_StMtV;
  using AbstractLinAlgPack::Vp_StPtMtV;
  using AbstractLinAlgPack::GenPermMatrixSlice;
  using AbstractLinAlgPack::MatrixOp;
  namespace GPMSIP = AbstractLinAlgPack::GenPermMatrixSliceIteratorPack;

#ifdef TEUCHOS_DEBUG
  TEUCHOS_TEST_FOR_EXCEPT(y==NULL);
#endif

  const DenseLinAlgPack::size_type
    no = H.G().rows(),  // number of original variables
    nr = H.M().rows(),  // number of relaxation variables
    nd = no + nr,       // total number of variables
    ydim = y->dim();    // y->dim() == number of rows in op(P)

  DenseLinAlgPack::Vp_MtV_assert_sizes(
    y->dim(),P.rows(),P.cols(),P_trans
    ,BLAS_Cpp::rows( nd, nd, H_trans) );
  DenseLinAlgPack::Vp_MtV_assert_sizes(
    BLAS_Cpp::cols( P.rows(), P.cols(), P_trans)
    ,nd, nd, H_trans, x.dim() );

  //
  // y = b*y + a * op(P) * H * x
  //
  // y = b*y + a * [op(P1)  op(P2) ] * [ G  0 ] * [ x1 ]
  //                                   [ 0  M ]   [ x2 ]
  //
  // =>
  //
  // y = b*y + a*op(P1)*G*x1 + a*op(P2)*H*x2
  //
  // For this to work op(P) must be sorted by column.
  //
  if(  ( P.ordered_by() == GPMSIP::BY_ROW && P_trans == BLAS_Cpp::no_trans )
       || ( P.ordered_by() == GPMSIP::BY_COL && P_trans == BLAS_Cpp::trans )
       ||  ( P.ordered_by() == GPMSIP::UNORDERED ) )
  {
    // Call the default implementation
    //H.MatrixOp::Vp_StPtMtV(y,a,P,P_trans,H_trans,x,b);
    TEUCHOS_TEST_FOR_EXCEPT(true); // ToDo: Implement!
    return;
  }
  const DenseLinAlgPack::Range1D
    o_rng(1,no),
    r_rng(no+1,no+nr);
  const AbstractLinAlgPack::GenPermMatrixSlice
    P1 = ( P.is_identity() 
         ? GenPermMatrixSlice(
           P_trans == no_trans ? ydim : no 
           ,P_trans == no_trans ? no : ydim
           ,GenPermMatrixSlice::IDENTITY_MATRIX )
         : P.create_submatrix(o_rng,P_trans==trans?GPMSIP::BY_ROW:GPMSIP::BY_COL)
      ),
    P2 = ( P.is_identity()
         ? GenPermMatrixSlice(
           P_trans == no_trans ? ydim : nr
           ,P_trans == no_trans ? nr : ydim
           ,GenPermMatrixSlice::ZERO_MATRIX )
         : P.create_submatrix(r_rng,P_trans==trans?GPMSIP::BY_ROW:GPMSIP::BY_COL)
      );
  const V
    x1 = x(o_rng),
    x2 = x(r_rng);
  // y = b*y
  LinAlgOpPack::Vt_S(y,b);
  // y += a*op(P1)*G*x1
  if( P1.nz() )
    LinAlgOpPack::Vp_StPtMtV( y, a, P1, P_trans, H.G(), H_trans, x1, b );
  // y += a*op(P2)*M*x2
  if( P2.nz() )
    LinAlgOpPack::Vp_StPtMtV( y, a, P2, P_trans, H.M(), H_trans, x2, 1.0 );
}

} // end namespace

namespace ConstrainedOptPack {

MatrixSymHessianRelaxNonSing::MatrixSymHessianRelaxNonSing()
  : vec_space_(Teuchos::null)
{}

MatrixSymHessianRelaxNonSing::MatrixSymHessianRelaxNonSing(
  const G_ptr_t         &G_ptr
  ,const vec_mut_ptr_t  &M_diag_ptr
  ,const space_ptr_t    &space
  )
  : vec_space_(Teuchos::null)
{
  initialize(G_ptr,M_diag_ptr,space);
}

void MatrixSymHessianRelaxNonSing::initialize(
  const G_ptr_t         &G_ptr
  ,const vec_mut_ptr_t  &M_diag_ptr
  ,const space_ptr_t    &space
  )
{
  namespace mmp = MemMngPack;
#ifdef TEUCHOS_DEBUG
  const char err_msg_head[] = "MatrixSymHessianRelaxNonSing::initialize(...) : Error!";
  TEUCHOS_TEST_FOR_EXCEPTION(G_ptr.get()==NULL, std::invalid_argument, err_msg_head);
  TEUCHOS_TEST_FOR_EXCEPTION(M_diag_ptr.get()==NULL, std::invalid_argument, err_msg_head);
  const size_type G_rows = G_ptr->rows(), M_diag_dim = M_diag_ptr->dim();
  TEUCHOS_TEST_FOR_EXCEPTION(G_rows==0, std::invalid_argument, err_msg_head);
  TEUCHOS_TEST_FOR_EXCEPTION(M_diag_dim==0, std::invalid_argument, err_msg_head);
#endif
  if( space.get() ) {
#ifdef TEUCHOS_DEBUG
    const size_type space_dim = space->dim();
    TEUCHOS_TEST_FOR_EXCEPTION(space_dim != G_rows + M_diag_dim, std::invalid_argument, err_msg_head);
#endif
    vec_space_ = space;
  }
  else {
    VectorSpace::space_ptr_t spaces[]
      = { Teuchos::rcp(&G_ptr->space_cols(),false), Teuchos::rcp(&M_diag_ptr->space(),false) };
    vec_space_ = Teuchos::rcp(new VectorSpaceBlocked( spaces, 2 ) );
  }
  G_ptr_ = G_ptr;
  M_.initialize(M_diag_ptr);
}
  
// Overridden from MatrixOp

const VectorSpace& MatrixSymHessianRelaxNonSing::space_cols() const
{
  assert_initialized();
  return *vec_space_;
}

bool MatrixSymHessianRelaxNonSing::Mp_StM(
  MatrixOp* C, value_type a, BLAS_Cpp::Transp H_trans
  ) const
{
#ifdef PROFILE_HACK_ENABLED
  ProfileHackPack::ProfileTiming profile_timing( "MatrixSymHessianRelaxNonSing::Mp_StM(...)" );
#endif
  assert_initialized();
  return MatrixOp::Mp_StM(C,a,H_trans); // ToDo: Update below code!
/*
  const size_type
    nG = G_ptr_->rows(),
    nM = M_.rows();
  AbstractLinAlgPack::Mp_StM( &(*C)(1,nG,1,nG), a, *G_ptr_, H_trans);
  AbstractLinAlgPack::Mp_StM( &(*C)(nG+1,nG+nM,nG+1,nG+nM), a, M_, H_trans);
*/
}

void MatrixSymHessianRelaxNonSing::Vp_StMtV(
  VectorMutable* y, value_type a, BLAS_Cpp::Transp H_trans
  ,const Vector& x, value_type b
  ) const
{
#ifdef PROFILE_HACK_ENABLED
  ProfileHackPack::ProfileTiming profile_timing( "MatrixSymHessianRelaxNonSing::Vp_StMtV(...Vector...)" );
#endif
  assert_initialized();
  const size_type
    nG = G_ptr_->rows(),
    nM = M_.rows();
  AbstractLinAlgPack::Vt_S(y,b);
  AbstractLinAlgPack::Vp_StMtV( y->sub_view(1,nG).get(), a, *G_ptr_, H_trans, *x.sub_view(1,nG) );
  AbstractLinAlgPack::Vp_StMtV( y->sub_view(nG+1,nG+nM).get(), a, M_, H_trans, *x.sub_view(nG+1,nG+nM) );
}

void MatrixSymHessianRelaxNonSing::Vp_StMtV(
  VectorMutable* y, value_type a, BLAS_Cpp::Transp H_trans
  ,const SpVectorSlice& x, value_type b
  ) const
{
#ifdef PROFILE_HACK_ENABLED
  ProfileHackPack::ProfileTiming profile_timing( "MatrixSymHessianRelaxNonSing::Vp_StMtV(...SpVectorSlice...)" );
#endif
  assert_initialized();
  const size_type
    nG = G_ptr_->rows(),
    nM = M_.rows();
  AbstractLinAlgPack::Vt_S(y,b); // Takes care of b == 0.0 and y uninitialized
  AbstractLinAlgPack::Vp_StMtV( y->sub_view(1,nG).get(), a, *G_ptr_, H_trans, x(1,nG) );
  AbstractLinAlgPack::Vp_StMtV( y->sub_view(nG+1,nG+nM).get(), a, M_, H_trans, x(nG+1,nG+nM) );
}

void MatrixSymHessianRelaxNonSing::Vp_StPtMtV(
  VectorMutable* y, value_type a, const GenPermMatrixSlice& P, BLAS_Cpp::Transp P_trans
  ,BLAS_Cpp::Transp H_trans, const Vector& x, value_type b
  ) const
{
#ifdef PROFILE_HACK_ENABLED
  ProfileHackPack::ProfileTiming profile_timing( "MatrixSymHessianRelaxNonSing::Vp_StPtMtV(...Vector...)" );
#endif
  assert_initialized();
  //MatrixOp::Vp_StPtMtV(y,a,P,P_trans,H_trans,x,b); // Uncomment for this default implementation
  AbstractLinAlgPack::VectorDenseMutableEncap y_d(*y);
  AbstractLinAlgPack::VectorDenseEncap x_d(x);
  Vp_StPtMtV_imp(&y_d(),a,P,P_trans,*this,H_trans,x_d(),b);
}

void MatrixSymHessianRelaxNonSing::Vp_StPtMtV(
  VectorMutable* y, value_type a, const GenPermMatrixSlice& P, BLAS_Cpp::Transp P_trans
  ,BLAS_Cpp::Transp H_trans, const SpVectorSlice& x, value_type b
  ) const
{
#ifdef PROFILE_HACK_ENABLED
  ProfileHackPack::ProfileTiming profile_timing( "MatrixSymHessianRelaxNonSing::Vp_StPtMtV(...SpVectorSlice...)" );
#endif
  assert_initialized();
  //MatrixOp::Vp_StPtMtV(y,a,P,P_trans,H_trans,x,b); // Uncomment for this default implementation
  AbstractLinAlgPack::VectorDenseMutableEncap y_d(*y);
  Vp_StPtMtV_imp(&y_d(),a,P,P_trans,*this,H_trans,x,b);
}

// Overridden form MatrixSymOp

void MatrixSymHessianRelaxNonSing::Mp_StPtMtP(
  MatrixSymOp* S, value_type a
  ,EMatRhsPlaceHolder dummy_place_holder
  ,const GenPermMatrixSlice& P, BLAS_Cpp::Transp P_trans
  ,value_type b
  ) const
{
  using BLAS_Cpp::no_trans;
  using BLAS_Cpp::trans;
  using BLAS_Cpp::trans_not;
  namespace GPMSIP = AbstractLinAlgPack::GenPermMatrixSliceIteratorPack;
#ifdef PROFILE_HACK_ENABLED
  ProfileHackPack::ProfileTiming profile_timing( "MatrixSymHessianRelaxNonSing::Mp_StPtMtP(...)" );
#endif
  assert_initialized();

  MatrixSymOp::Mp_StPtMtP(S,a,dummy_place_holder,P,P_trans,b); // ToDo: Override when needed!
  return;
/* ToDo: Update below code!
  const DenseLinAlgPack::size_type
    no = G().rows(),     // number of original variables
    nr = M().rows(),     // number of relaxation variables
    nd = no + nr;        // total number of variables

  DenseLinAlgPack::Mp_MtM_assert_sizes( S->rows(), S->cols(), no_trans
                   , P.rows(), P.cols(), trans_not(P_trans)
                   , P.rows(), P.cols(), P_trans );
  DenseLinAlgPack::Vp_V_assert_sizes( BLAS_Cpp::rows( P.rows(), P.cols(), P_trans), nd );

  //
  // S = b*S + a * op(P)' * H * op(P)
  //
  // S = b*S + a * [op(P1)'  op(P2)' ] * [ G  0 ] * [ op(P1) ]
  //                                     [ 0  M ]   [ op(P2) ]
  //
  // =>
  //
  // S = b*S
  // S1 += op(P1)' * G * op(P1)
  // S2 += op(P2)' * M * op(P2)
  //
  // For this to work op(P) must be sorted by row.
  //
  if(   ( P.ordered_by() == GPMSIP::BY_ROW && P_trans == BLAS_Cpp::trans )
      ||  ( P.ordered_by() == GPMSIP::BY_COL && P_trans == BLAS_Cpp::no_trans )
    ||  ( P.ordered_by() == GPMSIP::UNORDERED ) )
  {
    // Call the default implementation
    MatrixSymOp::Mp_StPtMtP(S,a,dummy_place_holder,P,P_trans,b);
    return;
  }
  const DenseLinAlgPack::Range1D
    o_rng(1,no),
    r_rng(no+1,no+nr);
  const AbstractLinAlgPack::GenPermMatrixSlice
    P1 = ( P.is_identity() 
         ? GenPermMatrixSlice(
           P_trans == no_trans ? nd : no 
           ,P_trans == no_trans ? no : nd
           ,GenPermMatrixSlice::IDENTITY_MATRIX )
         : P.create_submatrix(o_rng,P_trans==no_trans?GPMSIP::BY_ROW:GPMSIP::BY_COL)
      ),
    P2 = ( P.is_identity()
         ? GenPermMatrixSlice(
           P_trans == no_trans ? nd : nr
           ,P_trans == no_trans ? nr : nd
           ,GenPermMatrixSlice::ZERO_MATRIX )
         : P.create_submatrix(r_rng,P_trans==no_trans?GPMSIP::BY_ROW:GPMSIP::BY_COL)
      );
  // S = b*S
  DenseLinAlgPack::Mt_S( &DMatrixSliceTriEle(S->gms(),S->uplo()),b); // Handles b == 0.0 properly!

  // S1 += a*op(P1)'*G*op(P1)
  if( P1.nz() )
    AbstractLinAlgPack::Mp_StPtMtP(
      &DMatrixSliceSym( S->gms()(1,no,1,no), S->uplo() )
      , a, dummy_place_holder, G(), P1, P_trans );
  // S2 += a*op(P2)'*M*op(P2)
  if( P2.nz() )
    AbstractLinAlgPack::Mp_StPtMtP(
      &DMatrixSliceSym( S->gms()(no+1,nd,no+1,nd), S->uplo() )
      , a, dummy_place_holder, M(), P2, P_trans );
*/
}

// Overridden from MatrixOpNonsing

void MatrixSymHessianRelaxNonSing::V_InvMtV(
  VectorMutable* y, BLAS_Cpp::Transp H_trans, const Vector& x
  ) const
{
#ifdef PROFILE_HACK_ENABLED
  ProfileHackPack::ProfileTiming profile_timing( "MatrixSymHessianRelaxNonSing::V_InvMtV(...Vector...)" );
#endif
  assert_initialized();
  const size_type
    nG = G_ptr_->rows(),
    nM = M_.rows();
  AbstractLinAlgPack::V_InvMtV( y->sub_view(1,nG).get(), *G_ptr_, H_trans, *x.sub_view(1,nG) );
  AbstractLinAlgPack::V_InvMtV( y->sub_view(nG+1,nG+nM).get(), M_, H_trans, *x.sub_view(nG+1,nG+nM) );
}

void MatrixSymHessianRelaxNonSing::V_InvMtV(
  VectorMutable* y, BLAS_Cpp::Transp H_trans, const SpVectorSlice& x
  ) const
{
#ifdef PROFILE_HACK_ENABLED
  ProfileHackPack::ProfileTiming profile_timing( "MatrixSymHessianRelaxNonSing::V_InvMtV(...SpVectorSlice...)" );
#endif
  assert_initialized();
  const size_type
    nG = G_ptr_->rows(),
    nM = M_.rows();
  AbstractLinAlgPack::V_InvMtV( y->sub_view(1,nG).get(), *G_ptr_, H_trans, x(1,nG) );
  AbstractLinAlgPack::V_InvMtV( y->sub_view(nG+1,nG+nM).get(), M_, H_trans, x(nG+1,nG+nM) );
}

// private

void MatrixSymHessianRelaxNonSing::assert_initialized() const
{
  TEUCHOS_TEST_FOR_EXCEPTION(
    G_ptr_.get() == NULL, std::logic_error
    ,"MatrixSymHessianRelaxNonSing::assert_initialized(): Error, Not initalized yet!" );
}

} // end namespace ConstrainedOptPack