ROL
function/operator/test_02.cpp
Go to the documentation of this file.
1// @HEADER
2// ************************************************************************
3//
4// Rapid Optimization Library (ROL) Package
5// Copyright (2014) Sandia Corporation
6//
7// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8// license for use of this work by or on behalf of the U.S. Government.
9//
10// Redistribution and use in source and binary forms, with or without
11// modification, are permitted provided that the following conditions are
12// met:
13//
14// 1. Redistributions of source code must retain the above copyright
15// notice, this list of conditions and the following disclaimer.
16//
17// 2. Redistributions in binary form must reproduce the above copyright
18// notice, this list of conditions and the following disclaimer in the
19// documentation and/or other materials provided with the distribution.
20//
21// 3. Neither the name of the Corporation nor the names of the
22// contributors may be used to endorse or promote products derived from
23// this software without specific prior written permission.
24//
25// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36//
37// Questions? Contact lead developers:
38// Drew Kouri (dpkouri@sandia.gov) and
39// Denis Ridzal (dridzal@sandia.gov)
40//
41// ************************************************************************
42// @HEADER
43
49#include "ROL_Stream.hpp"
50#include "Teuchos_GlobalMPISession.hpp"
51
52typedef double RealT;
53
54int main(int argc, char *argv[]) {
55
56
57
58 using SV = ROL::StdVector<RealT>;
61
62 using vector = std::vector<RealT>;
63
64
65 Teuchos::GlobalMPISession mpiSession(&argc, &argv);
66
67 // This little trick lets us print to std::cout only if a (dummy) command-line argument is provided.
68 int iprint = argc - 1;
69 ROL::Ptr<std::ostream> outStream;
70 ROL::nullstream bhs; // outputs nothing
71 if (iprint > 0)
72 outStream = ROL::makePtrFromRef(std::cout);
73 else
74 outStream = ROL::makePtrFromRef(bhs);
75
76 // Save the format state of the original std::cout.
77 ROL::nullstream oldFormatState;
78 oldFormatState.copyfmt(std::cout);
79
80 int errorFlag = 0;
81
82 RealT tol = ROL::ROL_EPSILON<RealT>();
83
84 // *** Test body.
85
86 try {
87
88 int dim = 3;
89
90 ROL::Ptr<vector> m_ptr = ROL::makePtr<vector>(
91 std::initializer_list<RealT>{ 3.0, 1.0, 0.0, -2.0, 6.0, 2.0, 0.0, -1.0, 3.0 } );
92 ROL::Ptr<vector> a_ptr = ROL::makePtr<vector>(
93 std::initializer_list<RealT>{ 3.0, 6.0, 3.0} );
94 ROL::Ptr<vector> b_ptr = ROL::makePtr<vector>(
95 std::initializer_list<RealT>{ -2.0, -1.0 } );
96 ROL::Ptr<vector> c_ptr = ROL::makePtr<vector>(
97 std::initializer_list<RealT>{ 1.0, 2.0 } );
98
99 MAT M(m_ptr);
100 TRI T(a_ptr,b_ptr,c_ptr);
101
102 SV xm( ROL::makePtr<vector>( std::initializer_list<RealT>{1.0, 2.0, -1.0} ) );
103 SV ym( ROL::makePtr<vector>( dim ) );
104 SV zm( ROL::makePtr<vector>( dim ) );
105
106 SV xt( ROL::makePtr<vector>( dim ) );
107 SV yt( ROL::makePtr<vector>( dim ) );
108 SV zt( ROL::makePtr<vector>( dim ) );
109
110 SV error( ROL::makePtr<vector>(dim) );
111 RealT nerr = 0;
112
113 xt.set(xm);
114
115 M.apply(ym,xm,tol);
116 M.applyInverse(zm,ym,tol);
117
118 *outStream << "\nUsing StdLinearOperator - A is full matrix representation" << std::endl;
119 *outStream << "x = "; xm.print(*outStream);
120 *outStream << "y = Ax = "; ym.print(*outStream);
121 *outStream << "z = inv(A)y = "; zm.print(*outStream);
122
123 *outStream << "\nUsing StdTridiagonalOperator - T is tridiagonal representation" << std::endl;
124 T.apply(yt,xt,tol);
125 *outStream << "y = Tx = "; yt.print(*outStream);
126 error.set(yt);
127 error.axpy(-1.0,ym);
128 nerr = error.norm();
129 errorFlag += static_cast<int>(nerr>tol);
130 *outStream << "apply() error = " << nerr <<std::endl;
131
132 T.applyInverse(zt,yt,tol);
133 *outStream << "z = inv(T)y = "; yt.print(*outStream);
134 error.set(zt);
135 error.axpy(-1.0,zm);
136 nerr = error.norm();
137 errorFlag += static_cast<int>(nerr>tol);
138 *outStream << "applyInverse() error = " << nerr <<std::endl;
139
140 M.applyAdjoint(ym,xm,tol);
141 M.applyAdjointInverse(zm,ym,tol);
142 *outStream << "\nUsing StdLinearOperator - A is full matrix representation" << std::endl;
143 *outStream << "x = "; xm.print(*outStream);
144 *outStream << "y = A'x = "; ym.print(*outStream);
145 *outStream << "z = inv(A')y = "; zm.print(*outStream);
146
147 *outStream << "\nUsing StdTridiagonalOperator - T is tridiagonal representation" << std::endl;
148 T.applyAdjoint(yt,xt,tol);
149 *outStream << "y = T'x = "; yt.print(*outStream);
150 error.set(yt);
151 error.axpy(-1.0,ym);
152 nerr = error.norm();
153 errorFlag += static_cast<int>(nerr>tol);
154 *outStream << "applyAdjoint() error = " << nerr <<std::endl;
155
156 T.applyAdjointInverse(zt,yt,tol);
157 *outStream << "z = inv(T')y = "; yt.print(*outStream);
158 error.set(zt);
159 error.axpy(-1.0,zm);
160 nerr = error.norm();
161 errorFlag += static_cast<int>(nerr>tol);
162 *outStream << "applyAdjointInverse() error = " << nerr <<std::endl;
163
164
165
166
167 }
168 catch (std::logic_error& err) {
169 *outStream << err.what() << "\n";
170 errorFlag = -1000;
171 }; // end try
172
173 if (errorFlag != 0)
174 std::cout << "End Result: TEST FAILED\n";
175 else
176 std::cout << "End Result: TEST PASSED\n";
177
178 // reset format state of std::cout
179 std::cout.copyfmt(oldFormatState);
180
181 return 0;
182
183}
184
Defines a no-output stream class ROL::NullStream and a function makeStreamPtr which either wraps a re...
Provides the std::vector implementation to apply a linear operator, which is a std::vector representa...
Provides the std::vector implementation to apply a linear operator, which encapsulates a tridiagonal ...
Provides the ROL::Vector interface for scalar values, to be used, for example, with scalar constraint...
int main(int argc, char *argv[])
constexpr auto dim