10#ifndef THYRA_VECTOR_STD_OPS_TESTER_HPP
11#define THYRA_VECTOR_STD_OPS_TESTER_HPP
13#include "Thyra_VectorStdOpsTester_decl.hpp"
14#include "Thyra_TestingTools.hpp"
15#include "RTOpPack_TOpSetAssendingValues.hpp"
17#include "Teuchos_Assert.hpp"
21#ifdef THYRA_VECTOR_STD_OPS_TESTER_DUMP
22# include "RTOpPack_SPMD_apply_op.hpp"
32template <
bool isComparable,
class Scalar>
33class VectorStdOpsTesterComparable {
35 static bool checkComparableStdOps(
36 const VectorSpaceBase<Scalar> &vecSpc,
37 const Ptr<VectorBase<Scalar> > &z,
40 const Ptr<std::ostream> &out,
44 return Teuchos::ScalarTraits<Scalar>::ThisShouldNotCompile();
49template <
class Scalar>
50class VectorStdOpsTesterComparable<false,Scalar> {
52 static bool checkComparableStdOps(
53 const VectorSpaceBase<Scalar> &vecSpc,
54 const Ptr<VectorBase<Scalar> > &z,
57 const Ptr<std::ostream> &out,
62 <<
"\nThis scalar type does not support comparable operations so"
63 <<
" we can not test min(), max() and other such functions.\n";
69template <
class Scalar>
70class VectorStdOpsTesterComparable<true,Scalar> {
72 static bool checkComparableStdOps(
73 const VectorSpaceBase<Scalar> &vecSpc,
74 const Ptr<VectorBase<Scalar> > &z,
77 const Ptr<std::ostream> &out,
81 typedef Teuchos::ScalarTraits<Scalar> ST;
82 using Teuchos::outArg;
84 bool success =
true, result;
86 if (
nonnull(out)) *out <<
"\nTesting comparable operations ...\n";
88 const Scalar scalarSmall(1e-5), scalarMedium(2.0), scalarLarge(100.0);
89 if (
nonnull(out)) *out <<
"\nassign(z.ptr(),"<<scalarMedium<<
");\n";
90 assign(z.ptr(),Scalar(scalarMedium));
91 if(
nonnull(out) && dumpAll) *out <<
"\nz =\n" << *z;
92 if (
nonnull(out)) *out <<
"\nset_ele(0,"<<scalarSmall<<
",z.ptr());\n";
94 if(
nonnull(out) && dumpAll) *out <<
"\nz =\n" << *z;
95 if (
nonnull(out)) *out <<
"\nset_ele(1,"<<scalarLarge<<
",z.ptr());\n";
97 if(
nonnull(out) && dumpAll) *out <<
"\nz =\n" << *z;
98 if (
nonnull(out)) *out <<
"\nset_ele(vecSpc.dim()-2,"<<scalarSmall<<
",z.ptr());\n";
99 set_ele(vecSpc.dim()-2,scalarSmall,z.ptr());
100 if(
nonnull(out) && dumpAll) *out <<
"\nz =\n" << *z;
101 if (
nonnull(out)) *out <<
"\nset_ele(vecSpc.dim()-1,"<<scalarLarge<<
",z.ptr());\n";
102 set_ele(vecSpc.dim()-1,scalarLarge,z.ptr());
103 if(
nonnull(out) && dumpAll) *out <<
"\nz =\n" << *z;
105 Scalar minEle; Ordinal minIndex;
106 Scalar maxEle; Ordinal maxIndex;
108 if(!Teuchos::testRelErr<Scalar>(
109 "min(*z)",
min(*z),
"scalarSmall",scalarSmall
110 ,
"error_tol",error_tol,
"warning_tol",warning_tol,out
114 if (
nonnull(out)) *out <<
"\nmin(*z,&minEle,&minIndex);\n";
115 minEle = ST::zero(); minIndex = 0;
116 min(*z, outArg(minEle), outArg(minIndex));
117 if(!Teuchos::testRelErr<Scalar>(
118 "minEle",minEle,
"scalarSmall",scalarSmall
119 ,
"error_tol",error_tol,
"warning_tol",warning_tol, out
122 result = minIndex == 0;
123 if (
nonnull(out)) *out <<
"\nminIndex = " << minIndex <<
" == 0 ? " <<
passfail(result) << std::endl;
124 if(!result) success =
false;
126 if (
nonnull(out)) *out <<
"\nminGreaterThanBound(*z,"<<scalarMedium<<
",&minEle,&minIndex);\n";
127 minEle = ST::zero(); minIndex = 0;
129 if(!Teuchos::testRelErr<Scalar>(
130 "minEle",minEle,
"scalarLarge",scalarLarge
131 ,
"error_tol",error_tol,
"warning_tol",warning_tol,out
134 result = minIndex == 1;
135 if (
nonnull(out)) *out <<
"\nminIndex = " << minIndex <<
" == 1 ? " <<
passfail(result) << std::endl;
136 if(!result) success =
false;
138 if (
nonnull(out)) *out <<
"\nminGreaterThanBound(*z,"<<scalarLarge<<
",&minEle,&minIndex);\n";
139 minEle = ST::zero(); minIndex = 0;
141 result = minIndex < 0;
142 if (
nonnull(out)) *out <<
"\nminIndex = " << minIndex <<
" < 0 ? " <<
passfail(result) << std::endl;
143 if(!result) success =
false;
145 if(!Teuchos::testRelErr<Scalar>(
146 "max(*z)",
max(*z),
"scalarLarge",scalarLarge
147 ,
"error_tol",error_tol,
"warning_tol",warning_tol,out)
150 if (
nonnull(out)) *out <<
"\nmax(*z,&maxEle,&maxIndex);\n";
151 maxEle = ST::zero(); maxIndex = 0;
152 max(*z, outArg(maxEle), outArg(maxIndex));
153 if(!Teuchos::testRelErr<Scalar>(
154 "maxEle",maxEle,
"scalarLarge",scalarLarge
155 ,
"error_tol",error_tol,
"warning_tol",warning_tol,out)
157 result = maxIndex == 1;
158 if (
nonnull(out)) *out <<
"\nmaxIndex = " << maxIndex <<
" == 1 ? " <<
passfail(result) << std::endl;
159 if(!result) success =
false;
161 if (
nonnull(out)) *out <<
"\nmaxLessThanBound(*z,"<<scalarMedium<<
",&maxEle,&maxIndex);\n";
162 maxEle = ST::zero(); maxIndex = 0;
164 if(!Teuchos::testRelErr<Scalar>(
165 "maxEle",maxEle,
"scalarSmall",scalarSmall
166 ,
"error_tol",error_tol,
"warning_tol",warning_tol,out)
168 result = maxIndex == 0;
169 if (
nonnull(out)) *out <<
"\nmaxIndex = " << maxIndex <<
" == 0 ? " <<
passfail(result) << std::endl;
170 if(!result) success =
false;
172 if (
nonnull(out)) *out <<
"\nmaxLessThanBound(*z,"<<scalarSmall<<
",&maxEle,&maxIndex);\n";
173 maxEle = ST::zero(); maxIndex = 0;
175 result = ( maxIndex < 0 );
176 if (
nonnull(out)) *out <<
"\nmaxIndex = " << maxIndex <<
" < 0 ? " <<
passfail(result) << std::endl;
177 if(!result) success =
false;
181 if (
nonnull(out)) *out <<
"\nTesting pair_wise_max(*v1, *v2, z0.ptr()) ...\n";
184 using Teuchos::tuple;
186 using Teuchos::outArg;
187 using Teuchos::inOutArg;
188 Teuchos::RCP<VectorBase<Scalar> > v1 =
createMember(vecSpc);
189 Teuchos::RCP<VectorBase<Scalar> > v2 =
createMember(vecSpc);
190 Teuchos::RCP<VectorBase<Scalar> > v3 =
createMember(vecSpc);
191 Teuchos::RCP<VectorBase<Scalar> > z0 =
createMember(vecSpc);
192 const Scalar alpha = as<Scalar>(2.0);
193 seed_randomize<Scalar>(12345);
201 Vp_V(v1.
ptr(), *v2, as<Scalar>(-ST::one()));
206 Vp_V(z0.
ptr(), *v3, as<Scalar>(-ST::one()));
209 ,
"error_tol",error_tol,
"warning_tol",warning_tol,out.get()
222template<
class Scalar>
224 std::ostream &out,
bool &success)
227 out <<
"\n"<<tc<<
") set_ele(z, "<<i<<
");\n";
231 const Scalar val_i = as<Scalar>(i+1);
243template <
class Scalar>
248 :warning_tol_(warning_tol_in),
249 error_tol_(error_tol_in)
253template <
class Scalar>
256 std::ostream *out_out,
261 using Teuchos::tuple;
263 using Teuchos::outArg;
264 using Teuchos::inOutArg;
268 std::ostream &out = *out_out;
270 out <<
"\n*** Entering VectorStdOpsTester<"<<ST::name()<<
">::checkStdOps(...) ...\n"
271 <<
"using a \'" << vecSpc.
description() <<
"\' object ...\n";
274 out <<
"\nvecSpc.dim() = " << vecSpc.
dim() << std::endl;
276 const Ordinal n = vecSpc.
dim();
279 "Error: n = "<<n<<
" must be least 4 or greater to"
280 " run Thyra::VectorStdOpsTester::checkStdOps(...)!" );
283 two = as<Scalar>(2.0),
284 three = as<Scalar>(3.0),
285 four = as<Scalar>(4.0);
289 out <<
"\nCreating vectors v1, v2, v3, v4, x and z ...\n";
299 out <<
"\nassign(v1.ptr(), -2.0);\n";
301 out <<
"\nassign(v2.ptr(), -3.0);\n";
303 out <<
"\nassign(v3.ptr(), -4.0);\n";
305 out <<
"\ny[i] = i+1\n";
315 out <<
"\n"<<tc<<
") sum(*y);\n";
318 Teuchos::testRelErr<Scalar>(
320 "0.5*(n+1)*n", as<Scalar>(0.5*(n+1)*n),
321 "error_tol", error_tol(),
"warning_tol", warning_tol(), inOutArg(out)),
325 out <<
"\n"<<tc<<
") nom_inf(*v1);\n";
328 Teuchos::testRelErr<Scalar>(
331 "error_tol", error_tol(),
"warning_tol", warning_tol(), inOutArg(out)),
335 out <<
"\n"<<tc<<
") norm_2(*v1);\n";
338 Teuchos::testRelErr<Scalar>(
339 "norm_2(*v1)",
norm_2(*v1),
340 "2.0*sqrt(vecSpc.dim())", as<Scalar>(2.0)*ST::squareroot(vecSpc.
dim()),
341 "error_tol", error_tol(),
"warning_tol",warning_tol(), inOutArg(out)),
345 out <<
"\n"<<tc<<
") norm_1(*v1);\n";
348 Teuchos::testRelErr<Scalar>(
349 "norm_1(*v1)" ,
norm_1(*v1),
350 "2.0*vecSpc.dim()", as<Scalar>(2.0)*as<Scalar>(vecSpc.
dim()),
351 "error_tol", error_tol(),
"warning_tol", warning_tol(), inOutArg(out)),
355 out <<
"\n"<<tc<<
") abs(z.ptr(),*v1);\n";
359 if(!Teuchos::testRelErr<Scalar>(
360 "sum(*z)",
sum(*z),
"2.0*vecSpc.dim()", as<Scalar>(2.0)*as<Scalar>(vecSpc.
dim()),
361 "error_tol", error_tol(),
"warning_tol", warning_tol(), inOutArg(out))
367 out <<
"\n"<<tc<<
") val = get_ele(y, 0);\n";
374 out <<
"\n"<<tc<<
") val = get_ele<Scalar>(*y, 1);\n";
381 out <<
"\n"<<tc<<
") val = get_ele<Scalar>(*y, n-2);\n";
388 out <<
"\n"<<tc<<
") val = get_ele<Scalar>(*y, n-1);\n";
397 out <<
"\n"<<tc<<
") get_ele<Scalar>(*y, -1);\n";
403 out <<
"\n"<<tc<<
") get_ele<Scalar>(*y, n);\n";
413 setEleTestCase<Scalar>(z.ptr(), 0, tc, out, success);
415 setEleTestCase<Scalar>(z.ptr(), 1, tc, out, success);
417 setEleTestCase<Scalar>(z.ptr(), n-2, tc, out, success);
419 setEleTestCase<Scalar>(z.ptr(), n-1, tc, out, success);
424 std::out_of_range, out, success);
427 std::out_of_range, out, success);
432 out <<
"\n"<<tc<<
") reciprocal(z.ptr(),*v1);\n";
436 if(!Teuchos::testRelErr<Scalar>(
437 "sum(*z)",
sum(*z),
"-0.5*vecSpc.dim()",as<Scalar>(-0.5)*as<Scalar>(vecSpc.
dim())
438 ,
"error_tol",error_tol(),
"warning_tol",warning_tol(),inOutArg(out))
444 out <<
"\n"<<tc<<
") linear_combination(2,{0.5,0.25},{v1.ptr(),v2.ptr()},0.0,z.ptr());\n";
448 tuple<Scalar>(0.5, 0.25)(),
453 Teuchos::testRelErr<Scalar>(
455 "(-0.5*2.0-0.25*3.0)*vecSpc.dim()", as<Scalar>((-0.5 * 2.0 - 0.25 * 3.0) *vecSpc.
dim()),
456 "error_tol", error_tol(),
"warning_tol", warning_tol(), inOutArg(out)),
460 out <<
"\nassign(z.ptr(), 2.0);\n";
462 assign(z.ptr(), as<Scalar>(2.0));
464 out <<
"\n"<<tc<<
") linear_combination(3,{0.5,0.25,0.125},{v1.ptr(),v2.ptr(),v2.ptr()},0.5,z.ptr());\n";
468 tuple<Scalar>(0.5, 0.25, 0.125)(),
472 if(!Teuchos::testRelErr<Scalar>(
474 "(0.5*2.0-0.5*2.0-0.25*3.0-0.125*4.0)*vecSpc.dim()",
475 as<Scalar>(0.5*2.0-0.5*2.0-0.25*3.0-0.125*4.0)*as<Scalar>(vecSpc.
dim()),
476 "error_tol", error_tol(),
"warning_tol", warning_tol(), inOutArg(out)
482 out <<
"\n"<<tc<<
") assign(z.ptr(),2.0);\n";
485 assign(z.ptr(),as<Scalar>(2.0));
486 if(!Teuchos::testRelErr<Scalar>(
487 "norm_2(*z,*v2)",
norm_2(*z,*v2)
488 ,
"sqrt(2.0*3.0*3.0*vecSpc.dim())",ST::magnitude(ST::squareroot(as<Scalar>(2.0*3.0*3.0)*as<Scalar>(vecSpc.
dim())))
489 ,
"error_tol",error_tol(),
"warning_tol",warning_tol(),inOutArg(out)
493 if(!VectorStdOpsTesterComparable<ST::isComparable,Scalar>::checkComparableStdOps(
494 vecSpc,z.ptr(),error_tol(),warning_tol(),inOutArg(out),dumpAll)
499 out <<
"\n"<<tc<<
") Testing Vt_S(z.ptr(),alpha) ...\n";
502#ifdef THYRA_VECTOR_STD_OPS_TESTER_DUMP
503 RTOpPack::show_spmd_apply_op_dump =
true;
507 const Scalar alpha = as<Scalar>(1.2345);
512 const Scalar norm_alpha_v1 =
norm_2(*v1);
514 const Scalar mag_alpha = ST::magnitude(alpha);
516 const Scalar norm_2_v2 =
norm_2(*v2);
518 const Scalar alpha_norm_v1 = mag_alpha * norm_2_v2;
521 "norm_alpha_v1 - alpha_norm_v1",ST::magnitude(norm_alpha_v1-alpha_norm_v1)
522 ,
"error_tol",error_tol(),
"warning_tol",warning_tol(),&out
525#ifdef THYRA_VECTOR_STD_OPS_TESTER_DUMP
526 RTOpPack::show_spmd_apply_op_dump =
false;
531 out <<
"\n"<<tc<<
") Testing V_StV(z.ptr(),alpha,*v) ...\n";
537 const Scalar alpha = as<Scalar>(-1.2345);
543 Vp_V(z.ptr(),*v2,as<Scalar>(-ST::one()));
546 ,
"error_tol",error_tol(),
"warning_tol",warning_tol(),&out
552 out <<
"\n"<<tc<<
") Testing Vp_StV(z.ptr(),alpha,*v) ...\n";
559 const Scalar alpha = as<Scalar>(-1.2345);
565 V_StV(z.ptr(),alpha,*v2);
568 Vp_V(v3.
ptr(),*z,as<Scalar>(-ST::one()));
571 ,
"error_tol",error_tol(),
"warning_tol",warning_tol(),&out
577 out <<
"\n"<<tc<<
") Testing ele_wise_prod(alpha,*v1, *v2, z.ptr()) ...\n";
584 const Scalar alpha = as<Scalar>(-1.2345);
595 Vp_V(v2.
ptr(), *z, as<Scalar>(-ST::one()));
598 ,
"error_tol",error_tol(),
"warning_tol",warning_tol(),&out
605 out <<
"\n"<<tc<<
") Testing ele_wise_scale(*v1, z.ptr()) ...\n";
610 V_S(v1.
ptr(), as<Scalar>(2.0));
611 V_S(z.ptr(), as<Scalar>(3.0));
613 if (!Teuchos::testRelErr<Scalar>(
615 "ST::squareroot(n*sqr(3.0*2.0))", ST::squareroot(n*36.0),
616 "error_tol", error_tol(),
617 "warning_tol", warning_tol(),
624 out <<
"\n"<<tc<<
") Testing Vt_StV(z.ptr(), alpha, *v) ...\n";
631 const Scalar alpha = as<Scalar>(-1.2345);
637 V_S(z.ptr(),ST::zero());
640 Vp_V(v2.
ptr(),*z,as<Scalar>(-ST::one()));
643 ,
"error_tol",error_tol(),
"warning_tol",warning_tol(),&out
649 out <<
"\n"<<tc<<
") Testing V_StVpV(z.ptr(),alpha,*v1,*v2) ...\n";
657 const Scalar alpha = as<Scalar>(1.2345);
659 randomize(as<Scalar>(as<Scalar>(-10)*ST::one()),as<Scalar>(as<Scalar>(10)*ST::one()),v1.
ptr());
660 randomize(as<Scalar>(as<Scalar>(-10)*ST::one()),as<Scalar>(as<Scalar>(10)*ST::one()),v2.
ptr());
663 Vp_V(z.ptr(),*v2,alpha);
665 Vp_V(x.ptr(),*z,as<Scalar>(-ST::one()));
668 ,
"error_tol",error_tol(),
"warning_tol",warning_tol(),&out
674 out <<
"\n"<<tc<<
") Testing V_VpStV(z.ptr(),*v1,alpha,*v2) ...\n";
682 const Scalar alpha = as<Scalar>(1.2345);
685 as<Scalar>(as<Scalar>(10)*ST::one()), v1.
ptr());
687 as<Scalar>(as<Scalar>(10)*ST::one()), v2.
ptr());
688 V_VpStV(outArg(*v3), *v1, alpha, *v2);
690 Vp_StV(z.ptr(), alpha, *v2);
691 V_VmV(outArg(*x), *z, *v3);
694 ,
"error_tol",error_tol(),
"warning_tol",warning_tol(),&out
700 out <<
"\n"<<tc<<
") Testing V_StVpStV(z.ptr(),alpha,*v1,beta,*v2) ...\n";
708 const Scalar alpha = as<Scalar>(1.2345);
709 const Scalar beta = as<Scalar>(5.4321);
711 randomize(as<Scalar>(as<Scalar>(-10)*ST::one()),as<Scalar>(as<Scalar>(10)*ST::one()),v1.
ptr());
712 randomize(as<Scalar>(as<Scalar>(-10)*ST::one()),as<Scalar>(as<Scalar>(10)*ST::one()),v2.
ptr());
714 V_StV(z.ptr(),alpha,*v1);
717 Vp_V(x.ptr(),*z,as<Scalar>(-ST::one()));
726 out <<
"\n"<<tc<<
") Testing Vp_V(v1.ptr(),*v2,beta) ...\n";
734 const Scalar alpha = as<Scalar>(-2.0);
735 const Scalar beta = as<Scalar>(10.0);
738 randomize(as<Scalar>(as<Scalar>(-10)*ST::one()),as<Scalar>(as<Scalar>(10)*ST::one()),v2.
ptr());
742 V_StVpV(x.ptr(),as<Scalar>(-ST::one()),*z,*v1);
745 ,
"error_tol",error_tol(),
"warning_tol",warning_tol(),&out
751 out <<
"\n"<<tc<<
") Testing Vp_V(v1.ptr(),*v2) ...\n";
759 const Scalar alpha = as<Scalar>(-2.0);
762 randomize(as<Scalar>(as<Scalar>(-10)*ST::one()),as<Scalar>(as<Scalar>(10)*ST::one()),v2.
ptr());
765 V_StVpV(z.ptr(),ST::one(),*v3,*v2);
766 V_StVpV(x.ptr(),as<Scalar>(-ST::one()),*z,*v1);
769 ,
"error_tol",error_tol(),
"warning_tol",warning_tol(),&out
775 out <<
"\n"<<tc<<
") Testing V_S(v1.ptr(),alpha) ...\n";
781 const Scalar alpha = as<Scalar>(1.2345);
784 V_StVpV(z.ptr(),as<Scalar>(-ST::one()),*v1,*v2);
787 ,
"error_tol",error_tol(),
"warning_tol",warning_tol(),&out
793 out <<
"\n"<<tc<<
") Testing V_V(v1.ptr(),*v2) ...\n";
800 randomize(as<Scalar>(as<Scalar>(-10)*ST::one()),as<Scalar>(as<Scalar>(10)*ST::one()),v1.
ptr());
802 V_StVpV(z.ptr(),as<Scalar>(-ST::one()),*v1,*v2);
805 ,
"error_tol",error_tol(),
"warning_tol",warning_tol(),&out
812 out <<
"\n*** Leaving VectorStdOpsTester<"<<ST::name()<<
">::checkStdOps(...) ...\n";
virtual std::string description() const
void assign(const Ptr< MultiVectorBase< Scalar > > &V, Scalar alpha)
V = alpha.
void randomize(Scalar l, Scalar u, const Ptr< MultiVectorBase< Scalar > > &V)
Generate a random multi-vector with elements uniformly distributed elements.
void V_VpV(const Ptr< MultiVectorBase< Scalar > > &Z, const MultiVectorBase< Scalar > &X, const MultiVectorBase< Scalar > &Y)
Z(i,j) = X(i,j) + Y(i,j), i = 0...Z->range()->dim()-1, j = 0...Z->domain()->dim()-1.
void applyOp(const RTOpPack::RTOpT< Scalar > &primary_op, const ArrayView< const Ptr< const MultiVectorBase< Scalar > > > &multi_vecs, const ArrayView< const Ptr< MultiVectorBase< Scalar > > > &targ_multi_vecs, const ArrayView< const Ptr< RTOpPack::ReductTarget > > &reduct_objs, const Ordinal primary_global_offset=0)
Apply a reduction/transformation operator column by column and return an array of the reduction objec...
void Vt_S(const Ptr< MultiVectorBase< Scalar > > &Z, const Scalar &alpha)
Z(i,j) *= alpha, i = 0...Z->range()->dim()-1, j = 0...Z->domain()->dim()-1.
ScalarTraits< Scalar >::magnitudeType norm_1(const MultiVectorBase< Scalar > &V)
Take the induced matrix one norm of a multi-vector.
void V_VmV(const Ptr< MultiVectorBase< Scalar > > &Z, const MultiVectorBase< Scalar > &X, const MultiVectorBase< Scalar > &Y)
Z(i,j) = X(i,j) - Y(i,j), i = 0...Z->range()->dim()-1, j = 0...Z->domain()->dim()-1.
void linear_combination(const ArrayView< const Scalar > &alpha, const ArrayView< const Ptr< const MultiVectorBase< Scalar > > > &X, const Scalar &beta, const Ptr< MultiVectorBase< Scalar > > &Y)
Y.col(j)(i) = beta*Y.col(j)(i) + sum( alpha[k]*X[k].col(j)(i), k=0...m-1 ), for i = 0....
void V_StVpV(const Ptr< MultiVectorBase< Scalar > > &Z, const Scalar &alpha, const MultiVectorBase< Scalar > &X, const MultiVectorBase< Scalar > &Y)
Z(i,j) = alpha*X(i,j) + Y(i), i = 0...z->space()->dim()-1, , j = 0...Z->domain()->dim()-1.
void Vp_V(const Ptr< MultiVectorBase< Scalar > > &Z, const MultiVectorBase< Scalar > &X)
Z(i,j) += X(i,j), i = 0...Z->range()->dim()-1, j = 0...Z->domain()->dim()-1.
Abstract interface for finite-dimensional dense vectors.
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...
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.
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.
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.
void set_ele(Ordinal i, Scalar alpha, const Ptr< VectorBase< Scalar > > &v)
Set single element: v(i) = alpha.
Teuchos::ScalarTraits< Scalar >::magnitudeType norm_2(const VectorBase< Scalar > &v)
Euclidean (2) norm: result = ||v||2.
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.
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.
Teuchos::ScalarTraits< Scalar >::magnitudeType norm_inf(const VectorBase< Scalar > &v_rhs)
Infinity norm: result = ||v||inf.
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.
Scalar min(const VectorBase< Scalar > &x)
Min element: result = min{ x(i), i = 0...x.space()->dim()-1 } .
Scalar sum(const VectorBase< Scalar > &v)
Sum of vector elements: result = sum( v(i), i = 0...v.space()->dim()-1 ).
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.
Scalar get_ele(const VectorBase< Scalar > &v, Ordinal i)
Get single element: result = v(i).
void seed_randomize(unsigned int s)
Seed the random number generator used in randomize().
void V_S(const Ptr< VectorBase< Scalar > > &y, const Scalar &alpha)
y(i) = alpha, i = 0...y->space()->dim()-1.
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.
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...
void V_V(const Ptr< VectorBase< Scalar > > &y, const VectorBase< Scalar > &x)
y(i) = x(i), i = 0...y->space()->dim()-1.
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.
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.
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.
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.
Scalar max(const VectorBase< Scalar > &x)
Max element: result = max{ x(i), i = 1...n } .
Abstract interface for objects that represent a space for vectors.
virtual Ordinal dim() const =0
Return the dimension of the vector space.
RCP< VectorBase< Scalar > > createMember(const RCP< const VectorSpaceBase< Scalar > > &vs, const std::string &label="")
Create a vector member from the vector space.
bool checkStdOps(const VectorSpaceBase< Scalar > &vecSpc, std::ostream *out=0, const bool &dumpAll=false)
Run the tests using a vector space.
VectorStdOpsTester(const ScalarMag &warning_tol=0, const ScalarMag &error_tol=0)
Teuchos::ScalarTraits< Scalar >::magnitudeType ScalarMag
#define TEUCHOS_ASSERT(assertion_test)
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
bool nonnull(const std::shared_ptr< T > &p)
const std::string passfail(const bool result)
bool testMaxErr(const std::string &error_name, const Scalar &error, const std::string &max_error_name, const typename Teuchos::ScalarTraits< Scalar >::magnitudeType &max_error, const std::string &max_warning_name, const typename Teuchos::ScalarTraits< Scalar >::magnitudeType &max_warning, std::ostream *out, const std::string &leadingIndent=std::string(""))
Check that an error is less than some error tolerence.
TypeTo as(const TypeFrom &t)
#define TEUCHOS_TEST_ASSERT(v1, out, success)
#define TEUCHOS_TEST_THROW(code, ExceptType, out, success)
#define TEUCHOS_TEST_EQUALITY_CONST(v1, v2, out, success)