ROL
function/constraint/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
50#include "ROL_StdVector.hpp"
51#include "ROL_RandomVector.hpp"
52#include "ROL_Stream.hpp"
53#include "Teuchos_GlobalMPISession.hpp"
54
55#include <iostream>
56
57typedef double RealT;
58
59int main(int argc, char *argv[]) {
60
61 Teuchos::GlobalMPISession mpiSession(&argc, &argv);
62
63 using V = ROL::Vector<RealT>;
64
65
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 // *** Test body.
83
84 try {
85
86 int xdim = 5;
87
88 // Optimization vector
89 ROL::Ptr<V> a = ROL::makePtr<ROL::StdVector<RealT>>( ROL::makePtr<std::vector<RealT>>(xdim) );
90 ROL::Ptr<V> c = ROL::makePtr<ROL::SingletonVector<RealT>>( 0.0 );
91
92 ROL::Ptr<V> x = a->clone();
93 ROL::Ptr<V> d = x->clone();
94 ROL::Ptr<V> v = c->clone();
95
96 RealT b = 0.5;
97
102
103 std::cout << "a = "; a->print(*outStream); std::cout << std::endl;
104 std::cout << "x = "; x->print(*outStream); std::cout << std::endl;
105 std::cout << "d = "; d->print(*outStream); std::cout << std::endl;
106 std::cout << "v = "; v->print(*outStream); std::cout << std::endl;
107
109
110 con.checkApplyJacobian(*x,*d,*c,true,*outStream);
111 con.checkAdjointConsistencyJacobian(*v,*d,*x,true,*outStream);
112 con.checkApplyAdjointHessian(*x,*v,*d,*x,true,*outStream);
113
114
115
116 }
117 catch (std::logic_error& err) {
118 *outStream << err.what() << "\n";
119 errorFlag = -1000;
120 }; // end try
121
122 if (errorFlag != 0)
123 std::cout << "End Result: TEST FAILED\n";
124 else
125 std::cout << "End Result: TEST PASSED\n";
126
127 // reset format state of std::cout
128 std::cout.copyfmt(oldFormatState);
129
130 return 0;
131
132}
133
Vector< Real > V
Defines a no-output stream class ROL::NullStream and a function makeStreamPtr which either wraps a re...
virtual std::vector< std::vector< Real > > checkApplyJacobian(const Vector< Real > &x, const Vector< Real > &v, const Vector< Real > &jv, const std::vector< Real > &steps, const bool printToStream=true, std::ostream &outStream=std::cout, const int order=1)
Finite-difference check for the constraint Jacobian application.
virtual Real checkAdjointConsistencyJacobian(const Vector< Real > &w, const Vector< Real > &v, const Vector< Real > &x, const bool printToStream=true, std::ostream &outStream=std::cout)
virtual std::vector< std::vector< Real > > checkApplyAdjointHessian(const Vector< Real > &x, const Vector< Real > &u, const Vector< Real > &v, const Vector< Real > &hv, const std::vector< Real > &step, const bool printToScreen=true, std::ostream &outStream=std::cout, const int order=1)
Finite-difference check for the application of the adjoint of constraint Hessian.
This equality constraint defines an affine hyperplane.
Defines the linear algebra or vector space interface.
Definition: ROL_Vector.hpp:84
int main(int argc, char *argv[])
void RandomizeVector(Vector< Real > &x, const Real &lower=0.0, const Real &upper=1.0)
Fill a ROL::Vector with uniformly-distributed random numbers in the interval [lower,...