cost_term.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_COST_TERM_H_
31 #define IFOPT_INCLUDE_IFOPT_COST_TERM_H_
32 
33 #include "constraint_set.h"
34 
35 namespace ifopt {
36 
46 class CostTerm : public ConstraintSet {
47  public:
48  CostTerm(const std::string& name);
49  virtual ~CostTerm() = default;
50 
51  private:
55  virtual double GetCost() const = 0;
56 
57  public:
61  VectorXd GetValues() const final;
62 
66  VecBound GetBounds() const final;
67 
71  void Print(double tol, int& index) const final;
72 };
73 
74 } // namespace ifopt
75 
76 #endif /* IFOPT_INCLUDE_IFOPT_COST_TERM_H_ */
ifopt::Component::VecBound
std::vector< Bounds > VecBound
Definition: composite.h:69
ifopt::CostTerm::GetBounds
VecBound GetBounds() const final
Returns infinite bounds (e.g. no bounds).
Definition: leaves.cc:118
constraint_set.h
ifopt::CostTerm::Print
void Print(double tol, int &index) const final
Definition: leaves.cc:123
ifopt
common namespace for all elements in this library.
Definition: bounds.h:33
ifopt::CostTerm::GetValues
VectorXd GetValues() const final
Wrapper function that converts double to Eigen::VectorXd.
Definition: leaves.cc:111
ifopt::CostTerm::CostTerm
CostTerm(const std::string &name)
Definition: leaves.cc:109
ifopt::CostTerm::~CostTerm
virtual ~CostTerm()=default
ifopt::Component::VectorXd
Eigen::VectorXd VectorXd
Definition: composite.h:68
ifopt::CostTerm::GetCost
virtual double GetCost() const =0
Returns the scalar cost term calculated from the variables.


ifopt
Author(s): Alexander W. Winkler
autogenerated on Mon Sep 18 2023 02:14:38