/usr/include/trilinos/AbstractLinAlgPack_MatrixSymDiagStd.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 192 193 194 195 196 197 198 199 200 201 202 203 204 | // @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_SYM_DIAGONAL_STD_H
#define MATRIX_SYM_DIAGONAL_STD_H
#include "AbstractLinAlgPack_MatrixSymInitDiag.hpp"
#include "AbstractLinAlgPack_MatrixSymDiag.hpp"
#include "AbstractLinAlgPack_VectorSpace.hpp"
namespace AbstractLinAlgPack {
/** \brief Simple diagonal matrix class.
*
* ToDo: Implement clone_mswons() and deal with this->diag_ptr().count() > 1
* by cloning vector if told to. This allows lazy evaluation of the clone_mswons()
* method.
*/
class MatrixSymDiagStd
: public virtual MatrixSymInitDiag
, public virtual MatrixSymDiag
{
public:
/** \brief PostMod class to use with <tt>MemMngPack::AbstractFactorStd</tt>.
*/
class PostMod {
public:
PostMod(VectorSpace::space_ptr_t vectorSpace)
: vectorSpace_(vectorSpace) {}
void initialize(MatrixSymDiagStd* matrix) const
{ matrix->initialize(vectorSpace_->create_member()); }
private:
VectorSpace::space_ptr_t vectorSpace_;
}; // end PostMod
/** @name Constructors/initalizers */
//@{
/// Calls <tt>this->initialize()</tt>.
MatrixSymDiagStd(
const VectorSpace::vec_mut_ptr_t& diag = Teuchos::null
,bool unique = true
);
/** \brief Initialize given the diagonal vector (or no vector at all).
*
* @param diag [in] Vector to be used for the diagonal. If <tt>diag.get() == NULL</tt>
* then \c this will be uninitialized.
* @param unique [in] Determines if the underlying \c diag vector is guaranteed to be
* unique and not shared.
*/
void initialize(
const VectorSpace::vec_mut_ptr_t& diag
,bool unique = true
);
//@}
/** @name Access */
//@{
/** \brief Give non-const access to the diagonal vector.
*
* Preconditions:<ul>
* <li> <tt>this->diag_ptr().get() != NULL</tt> (throw <tt>???</tt>)
* </ul>
*
* ToDo: Finish documentation!
*/
VectorMutable& diag();
/** \brief . */
const VectorSpace::vec_mut_ptr_t& diag_ptr() const;
/** \brief . */
bool unique() const;
//@}
/** @name Overridden from MatrixBase */
//@{
/// Returns 0 if not initalized (this->diag() == NULL).
size_type rows() const;
/** \brief . */
size_type nz() const;
//@}
/** @name Overridden from MatrixOp */
//@{
/** \brief . */
const VectorSpace& space_rows() const;
/** \brief . */
const VectorSpace& space_cols() const;
/** \brief . */
MatrixOp& operator=(const MatrixOp& mwo_rhs);
/** \brief Add to a mutable matrix lhs.
*
* Preconditions:<ul>
* <li> #dynamic_cast<MultiVectorMutable*>(m_lhs) != NULL#.
* </ul>
*/
bool Mp_StM(MatrixOp* g_lhs, value_type alpha, BLAS_Cpp::Transp trans_rhs) const;
/** \brief . */
void Vp_StMtV(VectorMutable* v_lhs, value_type alpha, BLAS_Cpp::Transp trans_rhs1
, const Vector& v_rhs2, value_type beta) const;
/** \brief . */
void Vp_StMtV(VectorMutable* v_lhs, value_type alpha, BLAS_Cpp::Transp trans_rhs1
, const SpVectorSlice& sv_rhs2, value_type beta) const;
/** \brief Implements the symmetric rank-k update for all diagonal matrix lhs
*
* @return Returns <tt>true</tt> if <tt>dynamic_cast<MatrixSymDiagStd>(sym_lhs) != NULL</tt>.
* Otherwise, returns false.
*/
bool syrk(
BLAS_Cpp::Transp M_trans
,value_type alpha
,value_type beta
,MatrixSymOp *sym_lhs
) const;
//@}
/** Overridden from MatrixOpNonsing */
//@{
/** \brief . */
void V_InvMtV(VectorMutable* v_lhs, BLAS_Cpp::Transp trans_rhs1
, const Vector& v_rhs2) const;
/** \brief . */
void V_InvMtV(VectorMutable* v_lhs, BLAS_Cpp::Transp trans_rhs1
, const SpVectorSlice& sv_rhs2) const;
//@}
/** @name Overridden from MatrixSymInitDiag */
//@{
/** \brief . */
void init_identity( const VectorSpace& space_diag, value_type alpha );
/** \brief . */
void init_diagonal( const Vector& diag );
//@}
/** @name Overridden from MatrixSymDiag */
//@{
/** \brief . */
const Vector& diag() const;
//@}
private:
VectorSpace::vec_mut_ptr_t diag_;
bool unique_;
void copy_unique();
}; // end class MatrixSymDiagStd
// ////////////////////////////////////////
// Inline members
inline
bool MatrixSymDiagStd::unique() const
{
return unique_;
}
} // end namespace AbstractLinAlgPack
#endif // MATRIX_SYM_DIAGONAL_STD_H
|