ConstrainedOptPack::MatrixIdentConcatStd Class Reference

Concrete implementation class for a matrix vertically concatonated with an identity matrix. More...

#include <ConstrainedOptPack_MatrixIdentConcatStd.hpp>

Inheritance diagram for ConstrainedOptPack::MatrixIdentConcatStd:

[legend]
List of all members.

Public types

typedef Teuchos::RCP< const
MatrixOp > 
D_ptr_t
 
enum  ETopBottom { TOP, BOTTOM }
  More...

Constructors/initializers.

 MatrixIdentConcatStd ()
 Constructs to uninitialized.
virtual void initialize (const VectorSpace::space_ptr_t &space_cols, const VectorSpace::space_ptr_t &space_rows, ETopBottom top_or_bottom, value_type alpha, const D_ptr_t &D_ptr, BLAS_Cpp::Transp D_trans)
 Setup with a matrix object.
virtual void set_uninitialized ()
 Set the matrix to uninitialized.
virtual const D_ptr_tD_ptr () const
 Return the smart reference counted point to the D matrix.

Overridden form MatrixIdentConcat

Range1D D_rng () const
 
Range1D I_rng () const
 
value_type alpha () const
 
const MatrixOp & D () const
 
BLAS_Cpp::Transp D_trans () const
 

Overridden from MatrixOp

const VectorSpacespace_cols () const
 
const VectorSpacespace_rows () const
 
MatrixOp & operator= (const MatrixOp &m)
 The default just performs a shallow copy and just copies the underlying smart reference counted pointer. If other behavior is desired then this method must be overridden.

Private Member Functions

void assert_initialized () const

Private Attributes

AbstractLinAlgPack::VectorSpacespace_cols
AbstractLinAlgPack::VectorSpacespace_rows
AbstractLinAlgPack::MatrixOpD
RangePack::Range1D D_rng
RangePack::Range1D I_rng
value_type alpha_
BLAS_Cpp::Transp D_trans_

Detailed Description

Concrete implementation class for a matrix vertically concatonated with an identity matrix.

Represents an interface for a matrix that represents:

 M = [ alpha*op(D) ]    (TOP)
     [     I       ]

 or

 M = [     I       ]
     [ alpha*op(D) ]   (BOTTOM)
 

This subclass allows a client to set the representation matrix D.

Definition at line 54 of file ConstrainedOptPack_MatrixIdentConcatStd.hpp.


Member Typedef Documentation

typedef Teuchos::RCP<const MatrixOp> ConstrainedOptPack::MatrixIdentConcatStd::D_ptr_t

Definition at line 62 of file ConstrainedOptPack_MatrixIdentConcatStd.hpp.


Member Enumeration Documentation

enum ConstrainedOptPack::MatrixIdentConcatStd::ETopBottom

Enumerator:
TOP 
BOTTOM 

Definition at line 60 of file ConstrainedOptPack_MatrixIdentConcatStd.hpp.


Constructor & Destructor Documentation

ConstrainedOptPack::MatrixIdentConcatStd::MatrixIdentConcatStd (  ) 

Constructs to uninitialized.

Definition at line 38 of file ConstrainedOptPack_MatrixIdentConcatStd.cpp.


Member Function Documentation

void ConstrainedOptPack::MatrixIdentConcatStd::initialize ( const VectorSpace::space_ptr_t &  space_cols,
const VectorSpace::space_ptr_t &  space_rows,
ETopBottom  top_or_bottom,
value_type  alpha,
const D_ptr_t D_ptr,
BLAS_Cpp::Transp  D_trans 
) [virtual]

Setup with a matrix object.

Parameters:
top_or_bottom [in] If TOP then M = [ alpha*op(D); I ] and if BOTTOM then M = [ I; alpha*op(D) ]
alpha [in] Scalar that multiplies op(D)
D_ptr [in] Smart pointer to a matrix object that represents D. The matrix object pointed to must not be altered until this object is no longer in use or this->set_uninitialized() has been called.
D_trans [in] Determines if op(D) = D (no_trans#) or op(D) = D' (trans).
Preconditions:

Postconditions:

Definition at line 43 of file ConstrainedOptPack_MatrixIdentConcatStd.cpp.

void ConstrainedOptPack::MatrixIdentConcatStd::set_uninitialized (  )  [virtual]

Set the matrix to uninitialized.

Postconditions:

Definition at line 81 of file ConstrainedOptPack_MatrixIdentConcatStd.cpp.

const MatrixIdentConcatStd::D_ptr_t & ConstrainedOptPack::MatrixIdentConcatStd::D_ptr (  )  const [virtual]

Return the smart reference counted point to the D matrix.

If the matrix object D is owned exclusively by this matrix object then this->D_ptr().count() == 1 on return.

Definition at line 93 of file ConstrainedOptPack_MatrixIdentConcatStd.cpp.

Range1D ConstrainedOptPack::MatrixIdentConcatStd::D_rng (  )  const [virtual]

Implements ConstrainedOptPack::MatrixIdentConcat.

Range1D ConstrainedOptPack::MatrixIdentConcatStd::I_rng (  )  const [virtual]

Implements ConstrainedOptPack::MatrixIdentConcat.

value_type ConstrainedOptPack::MatrixIdentConcatStd::alpha (  )  const [virtual]

Implements ConstrainedOptPack::MatrixIdentConcat.

Definition at line 110 of file ConstrainedOptPack_MatrixIdentConcatStd.cpp.

const MatrixOp& ConstrainedOptPack::MatrixIdentConcatStd::D (  )  const [virtual]

Implements ConstrainedOptPack::MatrixIdentConcat.

BLAS_Cpp::Transp ConstrainedOptPack::MatrixIdentConcatStd::D_trans (  )  const [virtual]

Implements ConstrainedOptPack::MatrixIdentConcat.

Definition at line 120 of file ConstrainedOptPack_MatrixIdentConcatStd.cpp.

const VectorSpace& ConstrainedOptPack::MatrixIdentConcatStd::space_cols (  )  const [virtual]

Implements AbstractLinAlgPack::MatrixBase.

const VectorSpace& ConstrainedOptPack::MatrixIdentConcatStd::space_rows (  )  const [virtual]

Implements AbstractLinAlgPack::MatrixBase.

MatrixOp & ConstrainedOptPack::MatrixIdentConcatStd::operator= ( const MatrixOp &  m  ) 

The default just performs a shallow copy and just copies the underlying smart reference counted pointer. If other behavior is desired then this method must be overridden.

Definition at line 137 of file ConstrainedOptPack_MatrixIdentConcatStd.cpp.

void ConstrainedOptPack::MatrixIdentConcatStd::assert_initialized (  )  const [private]

Definition at line 145 of file ConstrainedOptPack_MatrixIdentConcatStd.cpp.


Member Data Documentation

const VectorSpace & ConstrainedOptPack::MatrixIdentConcatStd::space_cols [private]

Definition at line 169 of file ConstrainedOptPack_MatrixIdentConcatStd.hpp.

const VectorSpace & ConstrainedOptPack::MatrixIdentConcatStd::space_rows [private]

Definition at line 170 of file ConstrainedOptPack_MatrixIdentConcatStd.hpp.

const MatrixOp & ConstrainedOptPack::MatrixIdentConcatStd::D [private]

Definition at line 171 of file ConstrainedOptPack_MatrixIdentConcatStd.hpp.

Range1D ConstrainedOptPack::MatrixIdentConcatStd::D_rng [private]

Definition at line 172 of file ConstrainedOptPack_MatrixIdentConcatStd.hpp.

Range1D ConstrainedOptPack::MatrixIdentConcatStd::I_rng [private]

Definition at line 173 of file ConstrainedOptPack_MatrixIdentConcatStd.hpp.

value_type ConstrainedOptPack::MatrixIdentConcatStd::alpha_ [private]

Definition at line 181 of file ConstrainedOptPack_MatrixIdentConcatStd.hpp.

BLAS_Cpp::Transp ConstrainedOptPack::MatrixIdentConcatStd::D_trans_ [private]

Definition at line 182 of file ConstrainedOptPack_MatrixIdentConcatStd.hpp.


The documentation for this class was generated from the following files:
Generated on Tue Oct 20 12:54:11 2009 for MOOCHO (Single Doxygen Collection) by doxygen 1.4.7