GlobiPack Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
TestLagrPolyMeritFunc1D_UnitTests.cpp
Go to the documentation of this file.
1 /*
2 // @HEADER
3 // ***********************************************************************
4 //
5 // GlobiPack: Collection of Scalar 1D globalizaton utilities
6 // Copyright (2009) Sandia Corporation
7 //
8 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
9 // license for use of this work by or on behalf of the U.S. Government.
10 //
11 // Redistribution and use in source and binary forms, with or without
12 // modification, are permitted provided that the following conditions are
13 // met:
14 //
15 // 1. Redistributions of source code must retain the above copyright
16 // notice, this list of conditions and the following disclaimer.
17 //
18 // 2. Redistributions in binary form must reproduce the above copyright
19 // notice, this list of conditions and the following disclaimer in the
20 // documentation and/or other materials provided with the distribution.
21 //
22 // 3. Neither the name of the Corporation nor the names of the
23 // contributors may be used to endorse or promote products derived from
24 // this software without specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 //
38 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov)
39 //
40 // ***********************************************************************
41 // @HEADER
42 */
43 
44 
45 #include "GlobiPack_TestLagrPolyMeritFunc1D.hpp"
47 #include "Teuchos_Tuple.hpp"
48 
49 
50 namespace {
51 
52 
53 //
54 // Helper code and declarations
55 //
56 
57 
58 using Teuchos::as;
59 using Teuchos::outArg;
60 using Teuchos::null;
61 using Teuchos::RCP;
62 using Teuchos::Array;
63 using Teuchos::tuple;
65 using GlobiPack::computeValue;
66 
67 
68 template<class Scalar>
69 inline Scalar sqr(const Scalar &x) { return x*x; }
70 
71 
72 double g_tol = Teuchos::ScalarTraits<double>::eps()*100.0;
73 
74 
76 {
78  "tol", &g_tol, "Floating point tolerance" );
79 }
80 
81 
82 //
83 // Unit tests
84 //
85 
86 
87 //
88 // Here we represent the simple quadratic merit function:
89 //
90 // phi(alpha) = 0.5 * (alpha - 2.0)^2 + 2.0
91 //
92 // with the derivative:
93 //
94 // Dphi(alpha) = alpha - 2.0
95 //
96 
97 template<class Scalar>
98 Scalar phi_quad1(const Scalar &alpha)
99 {
100  return as<Scalar>(0.5)*sqr(alpha-as<Scalar>(2.0)) + as<Scalar>(2.0);
101 }
102 
103 template<class Scalar>
104 Scalar Dphi_quad1(const Scalar &alpha)
105 {
106  return alpha-as<Scalar>(2.0);
107 }
108 
109 TEUCHOS_UNIT_TEST_TEMPLATE_1_DECL( TestLagrPolyMeritFunc1D, basic, Scalar )
110 {
111 
113 
114  ECHO(Array<Scalar> alphaPoints = tuple<Scalar>(0.0, 2.0, 4.0));
115  ECHO(Array<Scalar> phiPoints = tuple<Scalar>(4.0, 2.0, 4.0));
116  ECHO(TestLagrPolyMeritFunc1D<Scalar> meritFunc(alphaPoints, phiPoints));
117  TEST_ASSERT(meritFunc.supportsDerivEvals());
118 
119  Array<Scalar> alphaTestPoints = tuple<Scalar>(0.0, 1.0, 2.0, 3.0, 4.0);
120  for (int test_i = 0; test_i < as<int>(alphaTestPoints.size()); ++test_i) {
121  out << "\ntest_i="<<test_i<<"\n\n";
122  Teuchos::OSTab tab(out);
123  ECHO(const Scalar alpha = alphaTestPoints[test_i]);
124  out << "alpha="<<alpha<<"\n";
125  ECHO(Scalar phi = as<Scalar>(-1.0));
126  ECHO(Scalar Dphi = as<Scalar>(-1.0));
127  ECHO(meritFunc.eval(alpha, outArg(phi), outArg(Dphi)));
128  TEST_FLOATING_EQUALITY(phi, phi_quad1(alpha), g_tol);
129  TEST_FLOATING_EQUALITY(Dphi, Dphi_quad1(alpha), g_tol);
130  }
131 }
132 
133 TEUCHOS_UNIT_TEST_TEMPLATE_1_INSTANT_REAL_SCALAR_TYPES( TestLagrPolyMeritFunc1D, basic )
134 
135 
136 } // namespace
137 
138 
TEUCHOS_UNIT_TEST_TEMPLATE_1_DECL(Teuchos_Conditions, NumberConditionSerialization, T)
#define TEST_ASSERT(v1)
static magnitudeType eps()
#define ECHO(statement)
static CommandLineProcessor & getCLP()
void setOption(const char option_true[], const char option_false[], bool *option_val, const char documentation[]=NULL)
TypeTo as(const TypeFrom &t)
#define TEST_FLOATING_EQUALITY(v1, v2, tol)
#define TEUCHOS_UNIT_TEST_TEMPLATE_1_INSTANT_REAL_SCALAR_TYPES(TEST_GROUP, TEST_NAME)
Lagrange Polynomial Merit Function used in testing.
TEUCHOS_STATIC_SETUP()