GlobiPack  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
GlobiPack_Types.hpp
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 #ifndef GLOBIPACK_TYPES_HPP
45 #define GLOBIPACK_TYPES_HPP
46 
47 
48 #include "GlobiPack_ConfigDefs.hpp"
49 #include "Teuchos_RCP.hpp"
50 #include "Teuchos_Ptr.hpp"
51 #include "Teuchos_Array.hpp"
52 #include "Teuchos_ArrayView.hpp"
53 #include "Teuchos_ScalarTraits.hpp"
54 
55 
56 namespace Teuchos {
57 
59 class ParameterList;
60 
61 } // namespace Teuchos
62 
63 
64 namespace GlobiPack {
65 
66 
68 using Teuchos::RCP;
70 using Teuchos::Ptr;
72 using Teuchos::Array;
74 using Teuchos::ArrayView;
79 
80 
86 template<class Scalar>
87 struct PointEval1D {
89  static Scalar valNotGiven() { return std::numeric_limits<Scalar>::max(); }
93  {}
95  PointEval1D( const Scalar &alpha_in, const Scalar &phi_in,
96  const Scalar &Dphi_in = valNotGiven())
97  : alpha(alpha_in), phi(phi_in), Dphi(Dphi_in)
98  {}
100  Scalar alpha;
102  Scalar phi;
105  Scalar Dphi;
106 };
107 
108 
109 namespace Exceptions {
110 
111 
115 class NotDescentDirection : public std::logic_error
116 {public: NotDescentDirection(const std::string& what_arg) : std::logic_error(what_arg) {}};
117 
118 
119 } // namespace Exceptions
120 
121 
122 } // namespace GlobiPack
123 
124 
125 #endif // GLOBIPACK_TYPES_HPP
Scalar phi
The value of the merit function phi(alpha).
Scalar Dphi
The value of the derivative of the merit function Dphi(alpha).
Thrown if search direction not a descent direction for the merit function.
Scalar alpha
The value of the unknown alpha.
Represents the evaluation point of the merit function phi(alpha) and/or is derivative Dphi(alpha)...
PointEval1D(const Scalar &alpha_in, const Scalar &phi_in, const Scalar &Dphi_in=valNotGiven())
static Scalar valNotGiven()