ConstrainedOptPack_MatrixVarReductImplicit.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 MATRIX_VAR_REDUCT_IMPLICIT_H
#define MATRIX_VAR_REDUCT_IMPLICIT_H

#include <vector>
#include <list>

#include "ConstrainedOptPack_Types.hpp"
#include "AbstractLinAlgPack_MatrixOp.hpp"
#include "AbstractLinAlgPack_VectorSpace.hpp"

namespace ConstrainedOptPack {

class MatrixVarReductImplicit
  : public AbstractLinAlgPack::MatrixOp
{
public:

  
  typedef Teuchos::RCP<const MatrixOpNonsing>   mat_nonsing_ptr_t;
  typedef Teuchos::RCP<const MatrixOp>              mat_ptr_t;



  virtual void initialize(
    const mat_nonsing_ptr_t          &C
    ,const mat_ptr_t                 &N
    ,const mat_ptr_t                 &D_direct
    );
  virtual void set_uninitialized();



  const mat_nonsing_ptr_t& C_ptr() const;
  
  const mat_ptr_t& N_ptr() const;
  
  const mat_ptr_t& D_direct_ptr() const;
  

  size_type rows() const;
  size_type cols() const;


  const VectorSpace& space_cols() const;
  const VectorSpace& space_rows() const;
  MatrixOp& operator=(const MatrixOp& M);
  std::ostream& output(std::ostream&) const;
  void Vp_StMtV(
    VectorMutable* v_lhs, value_type alpha
    ,BLAS_Cpp::Transp trans_rhs1
    ,const Vector& v_rhs2, value_type beta
    ) const;
  void Vp_StMtV(
    VectorMutable* v_lhs, value_type alpha
    ,BLAS_Cpp::Transp trans_rhs1
    ,const SpVectorSlice& sv_rhs2, value_type beta
    ) const;
  void Vp_StPtMtV(
    VectorMutable* v_lhs, value_type alpha
    ,const GenPermMatrixSlice& P_rhs1, BLAS_Cpp::Transp P_rhs1_trans
    ,BLAS_Cpp::Transp M_rhs2_trans
    ,const Vector& v_rhs3, value_type beta
    ) const;
  void Vp_StPtMtV(
    VectorMutable* v_lhs, value_type alpha
    ,const GenPermMatrixSlice& P_rhs1, BLAS_Cpp::Transp P_rhs1_trans
    ,BLAS_Cpp::Transp M_rhs2_trans
    ,const SpVectorSlice& sv_rhs3, value_type beta
    ) const;
  
  
private:
  
  // //////////////////////////
  // Private types
  
  typedef std::vector<VectorSpace::vec_mut_ptr_t>    InvCtN_rows_t;
  typedef std::list<index_type>                      InvCtN_rows_set_list_t;

  // //////////////////////////
  // Private data members

#ifdef DOXYGEN_COMPILE
  AbstractLinAlgPack::MatrixOpNonsing  *C;
  AbstractLinAlgPack::MatrixOp             *N;
  AbstractLinAlgPack::MatrixOp             *D_direct;
#else
  mat_nonsing_ptr_t                   C_;
  mat_ptr_t                           N_;
  mat_ptr_t                           D_direct_;

  mutable InvCtN_rows_t               InvCtN_rows_;
  // InvCtN_rows_ keeps track of a set pointers of computed rows of inv(C)*N.
  // If D_direct_ is setup then InvCtN_rows_ is not necessary.  However, if
  // not, then InvCtN_rows_[j-1] will be !=NULL if it points to the precomputed
  // jth row of inv(C)*N and will be ==NULL if this row has not been computed
  // yet.  Each time initialize(...) is called, these rows are deallocated and
  // InvCtN_rows_[j-1], j=1...this->rows() is set to NULL.

  mutable InvCtN_rows_set_list_t      InvCtN_rows_set_list_;
  // InvCtN_rows_set_list_ keeps a unorderd=ed list of the row indexes that are
  // currently updated.  Keeping this list allows the vectors allocated in 
  // InvCtN_rows_[] to be deallocated much faster than if the whole array
  // had to be searched everytime that this->initialize() was called again.

#endif

  // //////////////////////////////////
  // Private member functions

  void assert_initialized() const;

};  // end class MatrixVarReductImplicit

// ////////////////////////////////
// Inline members

inline
const MatrixVarReductImplicit::mat_nonsing_ptr_t&
MatrixVarReductImplicit::C_ptr() const
{
  return C_;
}

inline
const MatrixVarReductImplicit::mat_ptr_t&
MatrixVarReductImplicit::N_ptr() const
{
  return N_;
}

inline
const MatrixVarReductImplicit::mat_ptr_t&
MatrixVarReductImplicit::D_direct_ptr() const
{
  return D_direct_;
}

} // end namespace ConstrainedOptPack 

#endif  // MATRIX_VAR_REDUCT_IMPLICIT_H