Thyra Version of the Day
Loading...
Searching...
No Matches
Thyra_VectorStdOps_decl.hpp
1// @HEADER
2// *****************************************************************************
3// Thyra: Interfaces and Support for Abstract Numerical Algorithms
4//
5// Copyright 2004 NTESS and the Thyra contributors.
6// SPDX-License-Identifier: BSD-3-Clause
7// *****************************************************************************
8// @HEADER
9
10#ifndef THYRA_VECTOR_STD_OPS_DECL_HPP
11#define THYRA_VECTOR_STD_OPS_DECL_HPP
12
13
14#include "Thyra_OperatorVectorTypes.hpp"
15
16
17namespace Thyra {
18
19
25template<class Scalar>
26Scalar sum( const VectorBase<Scalar>& v );
27
28
35template<class Scalar>
36Scalar scalarProd( const VectorBase<Scalar>& x, const VectorBase<Scalar>& y );
37
38
45template<class Scalar>
46Scalar inner( const VectorBase<Scalar>& x, const VectorBase<Scalar>& y );
47
48
56template<class Scalar>
57typename Teuchos::ScalarTraits<Scalar>::magnitudeType
58norm( const VectorBase<Scalar>& v );
59
60
65template<class Scalar>
66typename Teuchos::ScalarTraits<Scalar>::magnitudeType
67norm_1( const VectorBase<Scalar>& v );
68
69
74template<class Scalar>
75typename Teuchos::ScalarTraits<Scalar>::magnitudeType
76norm_2( const VectorBase<Scalar>& v );
77
78
84template<class Scalar>
85typename Teuchos::ScalarTraits<Scalar>::magnitudeType
86norm_2( const VectorBase<Scalar> &w, const VectorBase<Scalar>& v );
87
88
93template<class Scalar>
94typename Teuchos::ScalarTraits<Scalar>::magnitudeType
95norm_inf( const VectorBase<Scalar>& v_rhs );
96
97
102template<class Scalar>
103Scalar dot( const VectorBase<Scalar>& x, const VectorBase<Scalar>& y );
104
105
110template<class Scalar>
111Scalar get_ele( const VectorBase<Scalar>& v, Ordinal i );
112
113
118template<class Scalar>
119void set_ele( Ordinal i, Scalar alpha, const Ptr<VectorBase<Scalar> > &v );
120
121
127template<class Scalar>
128void put_scalar( const Scalar& alpha, const Ptr<VectorBase<Scalar> > &y );
129
130
136template<class Scalar>
137void copy( const VectorBase<Scalar>& x, const Ptr<VectorBase<Scalar> > &y );
138
139
145template<class Scalar>
146void add_scalar( const Scalar& alpha, const Ptr<VectorBase<Scalar> > &y );
147
148
158template<class Scalar>
159void scale( const Scalar& alpha, const Ptr<VectorBase<Scalar> > &y );
160
161
167template<class Scalar>
168void abs( const VectorBase<Scalar> &x, const Ptr<VectorBase<Scalar> > &y );
169
170
176template<class Scalar>
177void reciprocal( const VectorBase<Scalar> &x, const Ptr<VectorBase<Scalar> > &y );
178
179
185template<class Scalar>
186void ele_wise_prod( const Scalar& alpha, const VectorBase<Scalar>& x,
187 const VectorBase<Scalar>& v, const Ptr<VectorBase<Scalar> > &y );
188
189
195template<class Scalar>
196void pair_wise_max(const Scalar& alpha, const VectorBase<Scalar>& x,
197 const VectorBase<Scalar>& v, const Ptr<VectorBase<Scalar> > &y );
198
204template<class Scalar>
205void ele_wise_conj_prod( const Scalar& alpha, const VectorBase<Scalar>& x,
206 const VectorBase<Scalar>& v, const Ptr<VectorBase<Scalar> > &y );
207
208
214template<class Scalar>
215void ele_wise_scale( const VectorBase<Scalar>& x, const Ptr<VectorBase<Scalar> > &y );
216
217
223template<class Scalar>
224void Vp_StVtV( const Ptr<VectorBase<Scalar> > &y, const Scalar& alpha,
225 const VectorBase<Scalar>& x, const VectorBase<Scalar>& v);
226
227
233template<class Scalar>
234void ele_wise_prod_update( const Scalar& alpha, const VectorBase<Scalar>& x,
235 const Ptr<VectorBase<Scalar> > &y );
236
237
243template<class Scalar>
244void pair_wise_max_update( const Scalar& alpha, const VectorBase<Scalar>& x,
245 const Ptr<VectorBase<Scalar> > &y );
246
252template<class Scalar>
253void Vt_StV( const Ptr<VectorBase<Scalar> > &y, const Scalar& alpha,
254 const VectorBase<Scalar> &x );
255
256
262template<class Scalar>
263void ele_wise_divide( const Scalar& alpha, const VectorBase<Scalar>& x,
264 const VectorBase<Scalar>& v, const Ptr<VectorBase<Scalar> > &y );
265
266
289template<class Scalar>
290void linear_combination(
291 const ArrayView<const Scalar> &alpha,
292 const ArrayView<const Ptr<const VectorBase<Scalar> > > &x,
293 const Scalar &beta,
294 const Ptr<VectorBase<Scalar> > &y
295 );
296
297
307template<class Scalar>
308void seed_randomize( unsigned int s );
309
310
321template<class Scalar>
322void randomize( Scalar l, Scalar u, const Ptr<VectorBase<Scalar> > &v );
323
324
330template<class Scalar>
331void assign( const Ptr<VectorBase<Scalar> > &y, const Scalar& alpha );
332
333
339template<class Scalar>
340void assign( const Ptr<VectorBase<Scalar> > &y, const VectorBase<Scalar>& x );
341
342
348template<class Scalar>
349void Vp_S( const Ptr<VectorBase<Scalar> > &y, const Scalar& alpha );
350
351
361template<class Scalar>
362void Vt_S( const Ptr<VectorBase<Scalar> > &y, const Scalar& alpha );
363
364
370template<class Scalar>
371void V_StV( const Ptr<VectorBase<Scalar> > &y, const Scalar& alpha,
372 const VectorBase<Scalar> &x );
373
374
380template<class Scalar>
381void Vp_StV( const Ptr<VectorBase<Scalar> > &y, const Scalar& alpha,
382 const VectorBase<Scalar>& x );
383
384
389template<class Scalar>
390void Vp_V(
391 const Ptr<VectorBase<Scalar> > &y, const VectorBase<Scalar>& x,
392 const Scalar& beta = static_cast<Scalar>(1.0)
393 );
394
395
400template<class Scalar>
401void V_V( const Ptr<VectorBase<Scalar> > &y, const VectorBase<Scalar>& x );
402
403
408template<class Scalar>
409void V_S( const Ptr<VectorBase<Scalar> > &y, const Scalar& alpha );
410
411
416template<class Scalar>
417void V_VpV( const Ptr<VectorBase<Scalar> > &z, const VectorBase<Scalar>& x,
418 const VectorBase<Scalar>& y );
419
420
425template<class Scalar>
426void V_VmV( const Ptr<VectorBase<Scalar> > &z, const VectorBase<Scalar>& x,
427 const VectorBase<Scalar>& y );
428
429
434template<class Scalar>
435void V_StVpV( const Ptr<VectorBase<Scalar> > &z, const Scalar &alpha,
436 const VectorBase<Scalar>& x, const VectorBase<Scalar>& y );
437
438
443template<class Scalar>
444void V_VpStV( const Ptr<VectorBase<Scalar> > &z,
445 const VectorBase<Scalar>& x,
446 const Scalar &alpha, const VectorBase<Scalar>& y );
447
448
453template<class Scalar>
454void V_StVpStV( const Ptr<VectorBase<Scalar> > &z, const Scalar &alpha,
455 const VectorBase<Scalar>& x, const Scalar &beta, const VectorBase<Scalar>& y );
456
457
462template<class Scalar>
463Scalar min( const VectorBase<Scalar>& x );
464
465
485template<class Scalar>
486void min( const VectorBase<Scalar>& x,
487 const Ptr<Scalar> &maxEle, const Ptr<Ordinal> &maxIndex );
488
489
519template<class Scalar>
520void minGreaterThanBound( const VectorBase<Scalar>& x, const Scalar &bound,
521 const Ptr<Scalar> &minEle, const Ptr<Ordinal> &minIndex );
522
523
528template<class Scalar>
529Scalar max( const VectorBase<Scalar>& x );
530
531
551template<class Scalar>
552void max( const VectorBase<Scalar>& x,
553 const Ptr<Scalar> &maxEle, const Ptr<Ordinal> &maxIndex );
554
555
584template<class Scalar>
585void maxLessThanBound( const VectorBase<Scalar>& x, const Scalar &bound,
586 const Ptr<Scalar> &maxEle, const Ptr<Ordinal> &maxIndex );
587
588
589
590
591} // end namespace Thyra
592
593
594// /////////////////////////
595// Inline functions
596
597
598template<class Scalar>
599inline
600Scalar Thyra::scalarProd( const VectorBase<Scalar>& x, const VectorBase<Scalar>& y )
601{
602 return x.space()->scalarProd(x, y);
603}
604
605
606template<class Scalar>
607inline
608Scalar Thyra::inner( const VectorBase<Scalar>& x, const VectorBase<Scalar>& y )
609{
610 return x.space()->scalarProd(x, y);
611}
612
613
614template<class Scalar>
615inline
616typename Teuchos::ScalarTraits<Scalar>::magnitudeType
617Thyra::norm( const VectorBase<Scalar>& v )
618{
619 typedef Teuchos::ScalarTraits<Scalar> ST;
620 return ST::magnitude(ST::squareroot(v.space()->scalarProd(v, v)));
621}
622
623
624#endif // THYRA_VECTOR_STD_OPS_DECL_HPP
Thyra::VectorBase
Abstract interface for finite-dimensional dense vectors.
Definition Thyra_VectorBase.hpp:115
Thyra::VectorBase::dot
Scalar dot(const VectorBase< Scalar > &x, const VectorBase< Scalar > &y)
Dot product: result = conj(x)'*y.
Thyra::VectorBase::maxLessThanBound
void maxLessThanBound(const VectorBase< Scalar > &x, const Scalar &bound, const Ptr< Scalar > &maxEle, const Ptr< Ordinal > &maxIndex)
Max element less than bound and its index: Returns maxEle = x(k) and maxIndex = k such that x(k) >= x...
Thyra::VectorBase::V_StVpV
void V_StVpV(const Ptr< VectorBase< Scalar > > &z, const Scalar &alpha, const VectorBase< Scalar > &x, const VectorBase< Scalar > &y)
z(i) = alpha*x(i) + y(i), i = 0...z->space()->dim()-1.
Thyra::VectorBase::linear_combination
void linear_combination(const ArrayView< const Scalar > &alpha, const ArrayView< const Ptr< const VectorBase< Scalar > > > &x, const Scalar &beta, const Ptr< VectorBase< Scalar > > &y)
Linear combination: y(i) = beta*y(i) + sum( alpha[k]*x[k](i), k=0...m-1 ), i = 0.....
Thyra::VectorBase::sum
Scalar sum(const VectorBase< Scalar > &v)
Sum of vector elements: result = sum( v(i), i = 0...v.space()->dim()-1 ).
Thyra::VectorBase::Vp_StV
void Vp_StV(const Ptr< VectorBase< Scalar > > &y, const Scalar &alpha, const VectorBase< Scalar > &x)
AXPY: y(i) = alpha * x(i) + y(i), i = 0...y->space()->dim()-1.
Thyra::VectorBase::min
void min(const VectorBase< Scalar > &x, const Ptr< Scalar > &maxEle, const Ptr< Ordinal > &maxIndex)
Min element and its index: Returns maxEle = x(k) and maxIndex = k such that x(k) <= x(i) for all i = ...
Thyra::VectorBase::seed_randomize
void seed_randomize(unsigned int s)
Seed the random number generator used in randomize().
Thyra::VectorBase::V_VpStV
void V_VpStV(const Ptr< VectorBase< Scalar > > &z, const VectorBase< Scalar > &x, const Scalar &alpha, const VectorBase< Scalar > &y)
z(i) = x(i) + alpha*y(i), i = 0...z->space()->dim()-1.
Thyra::VectorBase::Vp_S
void Vp_S(const Ptr< VectorBase< Scalar > > &y, const Scalar &alpha)
Add a scalar to all elements: y(i) += alpha, i = 0...y->space()->dim()-1.
Thyra::VectorBase::V_StV
void V_StV(const Ptr< VectorBase< Scalar > > &y, const Scalar &alpha, const VectorBase< Scalar > &x)
Assign scaled vector: y(i) = alpha * x(i), i = 0...y->space()->dim()-1.
Thyra::VectorBase::reciprocal
void reciprocal(const VectorBase< Scalar > &x, const Ptr< VectorBase< Scalar > > &y)
Element-wise reciprocal: y(i) = 1/x(i), i = 0...y->space()->dim()-1.
Thyra::VectorBase::Vt_S
void Vt_S(const Ptr< VectorBase< Scalar > > &y, const Scalar &alpha)
Scale all elements by a scalar: y(i) *= alpha, i = 0...y->space()->dim()-1.
Thyra::VectorBase::ele_wise_conj_prod
void ele_wise_conj_prod(const Scalar &alpha, const VectorBase< Scalar > &x, const VectorBase< Scalar > &v, const Ptr< VectorBase< Scalar > > &y)
Element-wise conjugate product update: y(i) += alpha * conj(x(i)) * v(i), i = 0......
Thyra::VectorBase::inner
Scalar inner(const VectorBase< Scalar > &x, const VectorBase< Scalar > &y)
Inner/Scalar product result = <x,y>.
Thyra::VectorBase::add_scalar
void add_scalar(const Scalar &alpha, const Ptr< VectorBase< Scalar > > &y)
Add a scalar to all elements: y(i) += alpha, i = 0...y->space()->dim()-1.
Thyra::VectorBase::norm
Teuchos::ScalarTraits< Scalar >::magnitudeType norm(const VectorBase< Scalar > &v)
Natural norm: result = sqrt(<v,v>).
Thyra::VectorBase::V_S
void V_S(const Ptr< VectorBase< Scalar > > &y, const Scalar &alpha)
y(i) = alpha, i = 0...y->space()->dim()-1.
Thyra::VectorBase::V_VpV
void V_VpV(const Ptr< VectorBase< Scalar > > &z, const VectorBase< Scalar > &x, const VectorBase< Scalar > &y)
z(i) = x(i) + y(i), i = 0...z->space()->dim()-1.
Thyra::VectorBase::pair_wise_max_update
void pair_wise_max_update(const Scalar &alpha, const VectorBase< Scalar > &x, const Ptr< VectorBase< Scalar > > &y)
Element-wise maximum update: y(i) = alpha * max(x(i), y(i)), i = 0...y->space()->dim()-1.
Thyra::VectorBase::min
Scalar min(const VectorBase< Scalar > &x)
Min element: result = min{ x(i), i = 0...x.space()->dim()-1 } .
Thyra::VectorBase::norm_2
Teuchos::ScalarTraits< Scalar >::magnitudeType norm_2(const VectorBase< Scalar > &v)
Euclidean (2) norm: result = ||v||2.
Thyra::VectorBase::assign
void assign(const Ptr< VectorBase< Scalar > > &y, const VectorBase< Scalar > &x)
Vector assignment: y(i) = x(i), i = 0...y->space()->dim()-1.
Thyra::VectorBase::pair_wise_max
void pair_wise_max(const Scalar &alpha, const VectorBase< Scalar > &x, const VectorBase< Scalar > &v, const Ptr< VectorBase< Scalar > > &y)
Element-wise maximum: y(i) = alpha * max(x(i), v(i)), i = 0...y->space()->dim()-1.
Thyra::VectorBase::scale
void scale(const Scalar &alpha, const Ptr< VectorBase< Scalar > > &y)
Scale all elements by a scalar: y(i) *= alpha, i = 0...y->space()->dim()-1.
Thyra::VectorBase::Vp_StVtV
void Vp_StVtV(const Ptr< VectorBase< Scalar > > &y, const Scalar &alpha, const VectorBase< Scalar > &x, const VectorBase< Scalar > &v)
Element-wise product update: y(i) += alpha * x(i) * v(i), i = 0...y->space()->dim()-1.
Thyra::VectorBase::randomize
void randomize(Scalar l, Scalar u, const Ptr< VectorBase< Scalar > > &v)
Random vector generation: v(i) = rand(l,u), , i = 1...v->space()->dim().
Thyra::VectorBase::max
Scalar max(const VectorBase< Scalar > &x)
Max element: result = max{ x(i), i = 1...n } .
Thyra::VectorBase::norm_2
Teuchos::ScalarTraits< Scalar >::magnitudeType norm_2(const VectorBase< Scalar > &w, const VectorBase< Scalar > &v)
Weighted Euclidean (2) norm: result = sqrt( sum( w(i)*conj(v(i))*v(i)) ).
Thyra::VectorBase::norm_1
Teuchos::ScalarTraits< Scalar >::magnitudeType norm_1(const VectorBase< Scalar > &v)
One (1) norm: result = ||v||1.
Thyra::VectorBase::ele_wise_divide
void ele_wise_divide(const Scalar &alpha, const VectorBase< Scalar > &x, const VectorBase< Scalar > &v, const Ptr< VectorBase< Scalar > > &y)
Element-wise division update: y(i) += alpha * x(i) / v(i), i = 0...y->space()->dim()-1.
Thyra::VectorBase::set_ele
void set_ele(Ordinal i, Scalar alpha, const Ptr< VectorBase< Scalar > > &v)
Set single element: v(i) = alpha.
Thyra::VectorBase::minGreaterThanBound
void minGreaterThanBound(const VectorBase< Scalar > &x, const Scalar &bound, const Ptr< Scalar > &minEle, const Ptr< Ordinal > &minIndex)
Minimum element greater than some bound and its index: Returns minEle = x(k) and minIndex = k such th...
Thyra::VectorBase::Vt_StV
void Vt_StV(const Ptr< VectorBase< Scalar > > &y, const Scalar &alpha, const VectorBase< Scalar > &x)
Element-wise product update: y(i) *= alpha * x(i), i = 0...y->space()->dim()-1.
Thyra::VectorBase::get_ele
Scalar get_ele(const VectorBase< Scalar > &v, Ordinal i)
Get single element: result = v(i).
Thyra::VectorBase::Vp_V
void Vp_V(const Ptr< VectorBase< Scalar > > &y, const VectorBase< Scalar > &x, const Scalar &beta=static_cast< Scalar >(1.0))
y(i) = x(i) + beta*y(i), i = 0...y->space()->dim()-1.
Thyra::VectorBase::abs
void abs(const VectorBase< Scalar > &x, const Ptr< VectorBase< Scalar > > &y)
Element-wise absolute value: y(i) = abs(x(i)), i = 0...y->space()->dim()-1.
Thyra::VectorBase::put_scalar
void put_scalar(const Scalar &alpha, const Ptr< VectorBase< Scalar > > &y)
Assign all elements to a scalar: y(i) = alpha, i = 0...y->space()->dim()-1.
Thyra::VectorBase::scalarProd
Scalar scalarProd(const VectorBase< Scalar > &x, const VectorBase< Scalar > &y)
Scalar product result = <x,y>.
Thyra::VectorBase::max
void max(const VectorBase< Scalar > &x, const Ptr< Scalar > &maxEle, const Ptr< Ordinal > &maxIndex)
Max element and its index: Returns maxEle = x(k) and maxIndex = k such that x(k) >= x(i) for i = 0....
Thyra::VectorBase::V_StVpStV
void V_StVpStV(const Ptr< VectorBase< Scalar > > &z, const Scalar &alpha, const VectorBase< Scalar > &x, const Scalar &beta, const VectorBase< Scalar > &y)
z(i) = alpha*x(i) + beta*y(i), i = 0...z->space()->dim()-1.
Thyra::VectorBase::ele_wise_prod_update
void ele_wise_prod_update(const Scalar &alpha, const VectorBase< Scalar > &x, const Ptr< VectorBase< Scalar > > &y)
Element-wise product update: y(i) *= alpha * x(i), i = 0...y->space()->dim()-1.
Thyra::VectorBase::V_VmV
void V_VmV(const Ptr< VectorBase< Scalar > > &z, const VectorBase< Scalar > &x, const VectorBase< Scalar > &y)
z(i) = x(i) - y(i), i = 0...z->space()->dim()-1.
Thyra::VectorBase::ele_wise_prod
void ele_wise_prod(const Scalar &alpha, const VectorBase< Scalar > &x, const VectorBase< Scalar > &v, const Ptr< VectorBase< Scalar > > &y)
Element-wise product update: y(i) += alpha * x(i) * v(i), i = 0...y->space()->dim()-1.
Thyra::VectorBase::space
virtual RCP< const VectorSpaceBase< Scalar > > space() const =0
Return a smart pointer to the vector space that this vector belongs to.
Thyra::VectorBase::ele_wise_scale
void ele_wise_scale(const VectorBase< Scalar > &x, const Ptr< VectorBase< Scalar > > &y)
Element-wise scaling: y(i) *= x(i), i = 0...y->space()->dim()-1.
Thyra::VectorBase::copy
void copy(const VectorBase< Scalar > &x, const Ptr< VectorBase< Scalar > > &y)
Vector assignment: y(i) = x(i), i = 0...y->space()->dim()-1.
Thyra::VectorBase::V_V
void V_V(const Ptr< VectorBase< Scalar > > &y, const VectorBase< Scalar > &x)
y(i) = x(i), i = 0...y->space()->dim()-1.
Thyra::VectorBase::assign
void assign(const Ptr< VectorBase< Scalar > > &y, const Scalar &alpha)
Assign all elements to a scalar: y(i) = alpha, i = 0...y->space()->dim()-1.
Thyra::VectorBase::norm_inf
Teuchos::ScalarTraits< Scalar >::magnitudeType norm_inf(const VectorBase< Scalar > &v_rhs)
Infinity norm: result = ||v||inf.
Thyra::Ordinal
Teuchos::Ordinal Ordinal
Type for the dimension of a vector space. `*.
Definition Thyra_OperatorVectorTypes.hpp:95
Generated on Thu Oct 9 2025 21:00:31 for Thyra by doxygen 1.9.8