/usr/include/trilinos/ConstrainedOptPack_MatrixIdentConcatStd.hpp is in libtrilinos-dev 10.4.0.dfsg-1ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 | // @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.
//
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov)
//
// ***********************************************************************
// @HEADER
#ifndef MATRIX_IDENT_CONCAT_STD_H
#define MATRIX_IDENT_CONCAT_STD_H
#include "ConstrainedOptPack_MatrixIdentConcat.hpp"
#include "AbstractLinAlgPack_VectorSpace.hpp"
#include "Teuchos_RCP.hpp"
namespace ConstrainedOptPack {
/** \brief Concrete implementation class for a matrix vertically concatonated with an identity matrix.
*
* Represents an interface for a matrix that represents:
\verbatim
M = [ alpha*op(D) ] (TOP)
[ I ]
or
M = [ I ]
[ alpha*op(D) ] (BOTTOM)
\endverbatim
*
* This subclass allows a client to set the representation matrix \c D.
*/
class MatrixIdentConcatStd : public MatrixIdentConcat {
public:
/** @name Public types */
//@{
/** \brief . */
enum ETopBottom { TOP, BOTTOM };
/** \brief . */
typedef Teuchos::RCP<const MatrixOp> D_ptr_t;
//@}
/** @name Constructors/initializers. */
//@{
/** \brief Constructs to uninitialized.
*/
MatrixIdentConcatStd();
/** \brief Setup with a matrix object.
*
* @param top_or_bottom
* [in] If <tt>TOP</tt> then <tt>M = [ alpha*op(D); I ]</tt> and if <tt>BOTTOM</tt> then
* <tt>M = [ I; alpha*op(D) ]</tt>
* @param alpha [in] Scalar that multiplies \c op(D)
* @param D_ptr [in] Smart pointer to a matrix object that represents \c D. The matrix object pointed to must
* not be altered until \c this object is no longer in use or <tt>this->set_uninitialized()</tt>
* has been called.
* @param D_trans [in] Determines if <tt>op(D) = D</tt> (\c no_trans#) or <tt>op(D) = D'</tt> (\c trans).
*
* Preconditions:<ul>
* <li> <tt>D.get() != NULL</tt> (throw <tt>std::invalid_argument</tt>)
* <li> <tt>space_cols->dim() == rows(op(D)) + cols(op(D))</tt> (throw <tt>std::invalid_argument</tt>)
* <li> <tt>space_rows->dim() == cols(op(D))</tt> (throw <tt>std::invalid_argument</tt>)
* <li> <tt>space_cols->sub_space(D_rng)->is_compatible(op(D).space_cols())</tt>
* (throw <tt>std::invalid_argument</tt>) See \c D_rng defined below
* <li> <tt>space_rows->is_compatible(op(D).space_rows())</tt> (throw <tt>std::invalid_argument</tt>)
* </ul>
*
* Postconditions:<ul>
* <li> <tt>this->D_ptr().get() == D_ptr.get()</tt>
* <li> <tt>&this->D() == this->D_ptr().get()</tt>
* <li> <tt>this->D_trans() == D_trans</tt>
* <li> <tt>this->alpha() == alpha</tt>
* <li> <tt>this->rows() == rows(op(D)) + cols(op(D))</tt>
* <li> <tt>this->cols() == cols(op(D))</tt>
* <li> <tt>&this->space_cols() == space_cols.get()</tt>
* <li> <tt>&this->space_rows() == space_rows.get()</tt>
* <li> [<tt>top_or_bottom == TOP</tt>] <tt>this->D_rng() = [1,rows(op(D))]</tt>
* <li> [<tt>top_or_bottom == TOP</tt>] <tt>this->I_rng() = [rows(op(D))+1,rows(op(D))+cols(op(D))]</tt>
* <li> [<tt>top_or_bottom == BOTTOM</tt>] <tt>this->D_rng() = [cols(op(D))+1,rows(op(D))+cols(op(D))]</tt>
* <li> [<tt>top_or_bottom == BOTTOM</tt>] <tt>this->I_rng() = [1,cols(op(D))]</tt>
* </ul>
*/
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
);
/** \brief Set the matrix to uninitialized.
*
* Postconditions:<ul>
* <li> <tt>this->space_cols()</tt> throws an exception
* <li> <tt>this->space_rows()</tt> throws an exception
* <li> <tt>this->D_ptr().get() == NULL</tt>
* <li> <tt>&this->D()</tt> throws an exception
* <li> <tt>this->D_trans() == no_trans</tt>
* <li> <tt>this->alpha() == 0.0</tt>
* <li> <tt>this->rows() == 0</tt>
* <li> <tt>this->cols() == 0</tt>
* <li> [<tt>top_or_bottom == TOP</tt>] <tt>this->D_rng() = [1,rows(op(D))]</tt>
* <li> [<tt>top_or_bottom == TOP</tt>] <tt>this->I_rng() = [rows(op(D))+1,rows(op(D))+cols(op(D))]</tt>
* <li> [<tt>top_or_bottom == BOTTOM</tt>] <tt>this->D_rng() = [cols(op(D))+1,rows(op(D))+cols(op(D))]</tt>
* <li> [<tt>top_or_bottom == BOTTOM</tt>] <tt>this->I_rng() = [1,cols(op(D))]</tt>
* </ul>
*/
virtual void set_uninitialized();
/** \brief Return the smart reference counted point to the \c D matrix.
*
* If the matrix object \c D is owned exclusively by \c this matrix object
* then <tt>this->D_ptr().count() == 1</tt> on return.
*/
virtual const D_ptr_t& D_ptr() const;
//@}
/** @name Overridden form MatrixIdentConcat */
//@{
/** \brief . */
Range1D D_rng() const;
/** \brief . */
Range1D I_rng() const;
/** \brief . */
value_type alpha() const;
/** \brief . */
const MatrixOp& D() const;
/** \brief . */
BLAS_Cpp::Transp D_trans() const;
//@}
/** @name Overridden from MatrixOp */
//@{
/** \brief . */
const VectorSpace& space_cols() const;
/** \brief . */
const VectorSpace& space_rows() const;
/** \brief 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.
*/
MatrixOp& operator=(const MatrixOp& m);
//@}
private:
#ifdef DOXYGEN_COMPILE
AbstractLinAlgPack::VectorSpace *space_cols;
AbstractLinAlgPack::VectorSpace *space_rows;
AbstractLinAlgPack::MatrixOp *D;
RangePack::Range1D D_rng;
RangePack::Range1D I_rng;
#else
VectorSpace::space_ptr_t space_cols_;
VectorSpace::space_ptr_t space_rows_;
D_ptr_t D_ptr_;
Range1D D_rng_;
Range1D I_rng_;
#endif
value_type alpha_;
BLAS_Cpp::Transp D_trans_;
//
void assert_initialized() const;
}; // end class MatrixIndentConcatStd
} // end namespace ConstrainedOptPack
#endif // MATRIX_IDENT_CONCAT_STD_H
|