/usr/include/trilinos/Thyra_DefaultColumnwiseMultiVector_decl.hpp is in libtrilinos-thyra-dev 12.4.2-2.
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 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 | // @HEADER
// ***********************************************************************
//
// Thyra: Interfaces and Support for Abstract Numerical Algorithms
// Copyright (2004) 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 (bartlettra@ornl.gov)
//
// ***********************************************************************
// @HEADER
#ifndef THYRA_DEFAULT_COLUMNWISE_MULTI_VECTOR_DECL_HPP
#define THYRA_DEFAULT_COLUMNWISE_MULTI_VECTOR_DECL_HPP
#include "Thyra_MultiVectorDefaultBase_decl.hpp"
#include "Thyra_VectorSpaceBase_decl.hpp"
#include "Thyra_VectorBase.hpp"
namespace Thyra {
/** \brief Default subclass for <tt>MultiVectorBase</tt> implemented using columns
* of separate abstract vectors.
*
* This is a very bad implementation of a multi-vector but this will
* work in situations where you need a multi-vector but some
* underlying linear algebra library does not directly support them.
*
* This subclass can be used to represent a <tt>%MultiVectorBase</tt>
* wrapper around a single <tt>VectorBase</tt> object so that a single
* vector can be passed to a method that expects a <tt>%MultiVectorBase</tt>
* object.
*/
template<class Scalar>
class DefaultColumnwiseMultiVector : virtual public MultiVectorDefaultBase<Scalar>
{
public:
/** @name Constructors/Initializers */
//@{
/** \brief Construct to initialized.
*
* Postconditions:<ul>
* <tt> <tt>this->range().get() == NULL</tt>
* <tt> <tt>this->domain().get() == NULL</tt>
* </ul>
*/
DefaultColumnwiseMultiVector();
/** \brief Calls <tt>initialize()</tt>. */
DefaultColumnwiseMultiVector(
const RCP<VectorBase<Scalar> > &col_vec
);
/** \brief Calls <tt>initialize()</tt>. */
DefaultColumnwiseMultiVector(
const RCP<const VectorSpaceBase<Scalar> > &range,
const RCP<const VectorSpaceBase<Scalar> > &domain,
const ArrayView<const RCP<VectorBase<Scalar> > > &col_vecs = Teuchos::null
);
/** \brief Initialize given a single vector object.
*
* \param col_vec [in] A single column vector. It is not allowed for
* <tt>col_vecs==NULL</tt>.
*
* Preconditions:<ul>
* <li> <tt>col_vec.get() != NULL</tt> (throw <tt>std::invalid_argument</tt>)
* <li> <tt>col_vec->dim() > 0</tt> (throw <tt>std::invalid_argument</tt>)
* </ul>
*
* Postconditions:<ul>
* <tt> <tt>this->range().get() == col_vec.space().get()</tt>
* <tt> <tt>this->domain()->dim() == 1</tt>
* <li> <tt>this->col(0).get() == col_vec.get()</tt>
* </ul>
*/
void initialize(
const RCP<VectorBase<Scalar> > &col_vec
);
/** \brief Initialize given the spaces for the columns and rows and possibly
* the column vectors.
*
* \param range [in] The space that the columns must lie in. The underlying
* vector space must not be changed while <tt>this</tt> is in use.
*
* \param domain [in] The space that the rows must lie in. The underlying
* vector space must not be changed while <tt>this</tt> is in use. What
* this argument really specifies is what vector type will be compatible
* with the vectors that the client may try to use to interact with the rows
* of this multivector.
*
* \param col_vecs [in] Array (size <tt>domain->dim()</tt>) of column
* vectors to use for the columns of <tt>this</tt>. It is allowed for
* <tt>col_vecs==NULL</tt> in which case <tt>range->createMember()</tt> will
* be used to create the columns of <tt>this</tt>.
*
* Preconditions:<ul>
* <li> <tt>range.get() != NULL</tt> (throw <tt>std::invalid_argument</tt>)
* <li> <tt>domain.get() != NULL</tt> (throw <tt>std::invalid_argument</tt>)
* <li> <tt>range->dim() > 0</tt> (throw <tt>std::invalid_argument</tt>)
* <li> <tt>domain->dim() > 0</tt> (throw <tt>std::invalid_argument</tt>)
* <li> [<tt>col_vecs != NULL</tt>]
* <tt>col_vecs[j].get() != NULL &&
* col_vecs[j]->space()->is_compatible(*range) == true</tt>,
* for <tt>j=0..domain->dim()-1</tt>
* </ul>
*
* Postconditions:<ul>
* <tt> <tt>this->range().get() == range.get()</tt>
* <tt> <tt>this->domain().get() == domain.get()</tt>
* <li> [<tt>col_vecs != NULL</tt>]
* <tt>this->col(j).get() == col_vecs[j].get()</tt>,
* for <tt>j=0..domain->dim()-1</tt>
* </ul>
*/
void initialize(
const RCP<const VectorSpaceBase<Scalar> > &range,
const RCP<const VectorSpaceBase<Scalar> > &domain,
const ArrayView<const RCP<VectorBase<Scalar> > > &col_vecs = Teuchos::null
);
/** \brief Set uninitialized. */
void uninitialize();
//@}
/** @name Overridden from LinearOpBAse */
//@{
/** \brief . */
RCP<const VectorSpaceBase<Scalar> > range() const;
/** \brief . */
RCP<const VectorSpaceBase<Scalar> > domain() const;
//@}
/** @name Overridden from MultiVectorBase */
//@{
/** \brief . */
RCP<VectorBase<Scalar> > nonconstColImpl(Ordinal j);
/** \brief . */
RCP<MultiVectorBase<Scalar> >
nonconstContigSubViewImpl( const Range1D& col_rng );
//@}
protected:
/** @name Overridden protected functions from MultiVectorBase */
//@{
/** \brief . */
void assignImpl(Scalar alpha);
//@}
/** @name Overridden protected functions from LinearOpBase */
//@{
/** \brief For complex <tt>Scalar</tt> types returns <tt>true</tt> for
* <tt>NOTRANS</tt> and <tt>CONJTRANS</tt> and for real types returns true
* for all values of <tt>M_trans</tt>.
*/
bool opSupportedImpl(EOpTransp M_trans) const;
/** \brief This function is implemented in terms of the multi-vector
* <tt>applyOp()</tt> function.
*
* The implementation takes care of two types of operations. One
* (<tt>M_trans==TRANS</tt>) is the block dot product of two vectors to form
* scalar (stored as the vector <tt>y</tt> which as one component). The
* other (<tt>M_trans==NOTRANS</tt>) is essentially an axpy operation where
* <tt>x</tt> is a vector with one element. Both of these operations are
* performed using reduction/transformation operators.
*
* This implementation is near optimal but the default implementation of the
* multi-vector version of <tt>apply()</tt> as implemented in the base class
* <tt>LinearOpBase</tt> will not be a near optimal implementation in its
* current form do to multiple, sequential reductions but it could be made
* to be with a little work.
*/
void applyImpl(
const EOpTransp M_trans,
const MultiVectorBase<Scalar> &X,
const Ptr<MultiVectorBase<Scalar> > &Y,
const Scalar alpha,
const Scalar beta
) const;
//@}
private:
RCP<const VectorSpaceBase<Scalar> > range_;
RCP<const VectorSpaceBase<Scalar> > domain_;
Array<RCP<VectorBase<Scalar> > > col_vecs_;
};
} // end namespace Thyra
#endif // THYRA_DEFAULT_COLUMNWISE_MULTI_VECTOR_DECL_HPP
|