leaves.cc
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 #include <ifopt/constraint_set.h>
31 #include <ifopt/cost_term.h>
32 #include <ifopt/variable_set.h>
33 
34 #include <iomanip>
35 #include <iostream>
36 
37 namespace ifopt {
38 
39 VariableSet::VariableSet(int n_var, const std::string& name)
40  : Component(n_var, name)
41 {}
42 
43 ConstraintSet::ConstraintSet(int row_count, const std::string& name)
44  : Component(row_count, name)
45 {}
46 
48 {
49  Jacobian jacobian(GetRows(), variables_->GetRows());
50 
51  int col = 0;
52  Jacobian jac;
53  std::vector<Eigen::Triplet<double>> triplet_list;
54 
55  for (const auto& vars : variables_->GetComponents()) {
56  int n = vars->GetRows();
57  jac.resize(GetRows(), n);
58 
59  FillJacobianBlock(vars->GetName(), jac);
60  // reserve space for the new elements to reduce memory allocation
61  triplet_list.reserve(triplet_list.size() + jac.nonZeros());
62 
63  // create triplets for the derivative at the correct position in the overall Jacobian
64  for (int k = 0; k < jac.outerSize(); ++k)
65  for (Jacobian::InnerIterator it(jac, k); it; ++it)
66  triplet_list.push_back(
67  Eigen::Triplet<double>(it.row(), col + it.col(), it.value()));
68  col += n;
69  }
70 
71  // transform triplet vector into sparse matrix
72  jacobian.setFromTriplets(triplet_list.begin(), triplet_list.end());
73  return jacobian;
74 }
75 
76 void ConstraintSet::LinkWithVariables(const VariablesPtr& x)
77 {
78  variables_ = x;
80 }
81 
82 CostTerm::CostTerm(const std::string& name) : ConstraintSet(1, name) {}
83 
85 {
86  VectorXd cost(1);
87  cost(0) = GetCost();
88  return cost;
89 }
90 
92 {
93  return VecBound(GetRows(), NoBound);
94 }
95 
96 void CostTerm::Print(double tol, int& index) const
97 {
98  // only one scalar cost value
99  double cost = GetValues()(0);
100 
101  std::cout.precision(2);
102  std::cout << std::fixed << std::left << std::setw(30) << GetName()
103  << std::right << std::setw(4) << GetRows() << std::setw(9) << index
104  << std::setfill('.') << std::setw(7) << index + GetRows() - 1
105  << std::setfill(' ') << std::setw(12) << cost << std::endl;
106 }
107 
108 } // namespace ifopt
ifopt::Component::VecBound
std::vector< Bounds > VecBound
Definition: composite.h:69
ifopt::ConstraintSet::FillJacobianBlock
virtual void FillJacobianBlock(std::string var_set, Jacobian &jac_block) const =0
Set individual Jacobians corresponding to each decision variable set.
ifopt::CostTerm::GetBounds
VecBound GetBounds() const final
Returns infinite bounds (e.g. no bounds).
Definition: leaves.cc:118
ifopt::ConstraintSet::LinkWithVariables
void LinkWithVariables(const VariablesPtr &x)
Connects the constraint with the optimization variables.
Definition: leaves.cc:103
constraint_set.h
ifopt::ConstraintSet::variables_
VariablesPtr variables_
Definition: constraint_set.h:170
ifopt::CostTerm::Print
void Print(double tol, int &index) const final
Definition: leaves.cc:123
cost_term.h
ifopt::ConstraintSet::GetJacobian
Jacobian GetJacobian() const final
The matrix of derivatives for these constraints and variables.
Definition: leaves.cc:74
ifopt::ConstraintSet::InitVariableDependedQuantities
virtual void InitVariableDependedQuantities(const VariablesPtr &)
Initialize quantities that depend on the optimization variables.
Definition: constraint_set.h:183
ifopt::ConstraintSet::ConstraintSet
ConstraintSet(int n_constraints, const std::string &name)
Creates constraints on the variables x.
Definition: leaves.cc:70
ifopt::Component::GetName
std::string GetName() const
Returns the name (id) of this component.
Definition: composite.cc:80
variable_set.h
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::NoBound
static const Bounds NoBound
Definition: bounds.h:94
ifopt::Component::VectorXd
Eigen::VectorXd VectorXd
Definition: composite.h:68
ifopt::Component::GetRows
int GetRows() const
Returns the number of rows of this component.
Definition: composite.cc:70
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:66
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