ROL
Main Page
Modules
Namespaces
Classes
Files
File List
File Members
src
function
ROL_ScalarController.hpp
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
44
45
#ifndef ROL_SCALARCONTROLLER_H
46
#define ROL_SCALARCONTROLLER_H
47
48
#include "
ROL_VectorController.hpp
"
49
#include "
ROL_SingletonVector.hpp
"
50
51
namespace
ROL {
52
53
template
<
class
Real,
class
Key=std::vector<Real>>
54
class
ScalarController
:
public
VectorController
<Real,Key> {
55
public
:
56
ScalarController
(
void
);
57
58
bool
get
(Real &x,
const
Key ¶m);
59
60
void
set
(Real x,
const
Key ¶m);
61
62
};
// class ScalarController
63
64
}
// namespace ROL
65
66
#include "
ROL_ScalarController_Def.hpp
"
67
68
#endif
ROL_SingletonVector.hpp
ROL_ScalarController_Def.hpp
ROL::ScalarController::ScalarController
ScalarController(void)
Definition:
ROL_ScalarController_Def.hpp:51
ROL::ScalarController
Definition:
ROL_ScalarController.hpp:54
ROL::ScalarController::set
void set(Real x, const Key ¶m)
Definition:
ROL_ScalarController_Def.hpp:62
ROL_VectorController.hpp
ROL::VectorController
Definition:
ROL_VectorController.hpp:56
Generated by
1.8.5