variable_set.h
Go to the documentation of this file.
1 /******************************************************************************
2 Copyright (c) 2017, Alexander W Winkler. All rights reserved.
3 
4 Redistribution and use in source and binary forms, with or without
5 modification, are permitted provided that the following conditions are met:
6 
7 * Redistributions of source code must retain the above copyright notice, this
8  list of conditions and the following disclaimer.
9 
10 * Redistributions in binary form must reproduce the above copyright notice,
11  this list of conditions and the following disclaimer in the documentation
12  and/or other materials provided with the distribution.
13 
14 * Neither the name of the copyright holder nor the names of its
15  contributors may be used to endorse or promote products derived from
16  this software without specific prior written permission.
17 
18 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
22 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
25 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
26 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 ******************************************************************************/
29 
30 #ifndef IFOPT_INCLUDE_IFOPT_VARIABLE_SET_H_
31 #define IFOPT_INCLUDE_IFOPT_VARIABLE_SET_H_
32 
33 #include "composite.h"
34 
35 namespace ifopt {
36 
46 class VariableSet : public Component {
47 public:
53  VariableSet(int n_var, const std::string& name);
54  virtual ~VariableSet() = default;
55 
56  // doesn't exist for variables, generated run-time error when used.
57  Jacobian GetJacobian() const final
58  {
59  throw std::runtime_error("not implemented for variables");
60  };
61 };
62 
63 } // namespace ifopt
64 
65 
66 
67 #endif /* IFOPT_INCLUDE_IFOPT_VARIABLE_SET_H_ */
ifopt::VariableSet::~VariableSet
virtual ~VariableSet()=default
ifopt::VariableSet::GetJacobian
Jacobian GetJacobian() const final
Returns derivatives of each row w.r.t. the variables.
Definition: variable_set.h:111
ifopt
common namespace for all elements in this library.
Definition: bounds.h:33
composite.h
Declares the classes Composite and Component used as variables, costs and constraints.
ifopt::Component::Jacobian
Eigen::SparseMatrix< double, Eigen::RowMajor > Jacobian
Definition: composite.h:67
ifopt::VariableSet::VariableSet
VariableSet(int n_var, const std::string &name)
Creates a set of variables representing a single concept.
Definition: leaves.cc:67


ifopt
Author(s): Alexander W. Winkler
autogenerated on Thu Sep 15 2022 02:14:55