7#include <initializer_list>
8#include <source_location>
13#include <gch/small_vector.hpp>
15#include "sleipnir/autodiff/expression.hpp"
16#include "sleipnir/autodiff/expression_graph.hpp"
17#include "sleipnir/autodiff/sleipnir_base.hpp"
18#include "sleipnir/util/assert.hpp"
19#include "sleipnir/util/concepts.hpp"
21#ifndef SLEIPNIR_DISABLE_DIAGNOSTICS
22#include "sleipnir/util/print.hpp"
31template <
typename Scalar>
32class GradientExpressionGraph;
36template <
typename Scalar,
int UpLo = Eigen::Lower | Eigen::Upper>
37 requires(UpLo == Eigen::Lower) || (UpLo == (Eigen::Lower | Eigen::Upper))
40template <
typename Scalar>
46template <
typename Scalar_>
64 : expr{detail::make_expression_ptr<detail::ConstantExpression<
Scalar>>(
72 slp_assert(
value.rows() == 1 &&
value.cols() == 1);
80 : expr{detail::make_expression_ptr<detail::ConstantExpression<
Scalar>>(
88 : expr{detail::make_expression_ptr<detail::ConstantExpression<
Scalar>>(
100 : expr{std::
move(expr)} {}
108 detail::make_expression_ptr<detail::ConstantExpression<Scalar>>(
value);
109 m_graph_initialized =
false;
118#ifndef SLEIPNIR_DISABLE_DIAGNOSTICS
121 if (expr->args[0] !=
nullptr) {
122 auto location = std::source_location::current();
125 "WARNING: {}:{}: {}: Modified the value of a dependent variable",
136 if (!m_graph_initialized) {
137 m_graph = detail::topological_sort(expr);
138 m_graph_initialized =
true;
140 detail::update_values(m_graph);
149 ExpressionType
type()
const {
return expr->type(); }
156 template <ScalarLike LHS, SleipnirScalarLike<Scalar> RHS>
166 template <SleipnirScalarLike<Scalar> LHS, ScalarLike RHS>
264 detail::make_expression_ptr<detail::DecisionVariableExpression<Scalar>>();
268 gch::small_vector<detail::Expression<Scalar>*> m_graph;
271 bool m_graph_initialized =
false;
273 template <
typename Scalar>
275 template <
typename Scalar>
277 template <
typename Scalar>
279 template <
typename Scalar>
281 template <
typename Scalar>
284 template <
typename Scalar>
287 template <
typename Scalar>
290 template <
typename Scalar>
292 template <
typename Scalar>
294 template <
typename Scalar>
296 template <
typename Scalar>
298 template <
typename Scalar>
300 template <
typename Scalar>
303 template <
typename Scalar>
306 template <
typename Scalar>
309 template <
typename Scalar>
311 template <
typename Scalar>
313 template <
typename Scalar>
316 template <
typename Scalar>
319 template <
typename Scalar>
322 template <
typename Scalar>
325 template <
typename Scalar>
328 template <
typename Scalar>
331 template <
typename Scalar>
334 template <
typename Scalar>
337 template <
typename Scalar>
340 template <
typename Scalar>
342 template <
typename Scalar>
344 template <
typename Scalar>
346 template <
typename Scalar>
348 template <
typename Scalar>
350 template <
typename Scalar>
352 template <
typename Scalar>
358 template <
typename Scalar,
int UpLo>
359 requires(
UpLo == Eigen::Lower) || (
UpLo == (Eigen::Lower | Eigen::Upper))
361 template <
typename Scalar>
365template <
template <
typename>
typename T,
typename Scalar>
366 requires SleipnirMatrixLike<T<Scalar>, Scalar>
367Variable(T<Scalar>) -> Variable<Scalar>;
369template <std::
floating_po
int T>
370Variable(T) -> Variable<T>;
372template <std::
integral T>
373Variable(T) -> Variable<T>;
379template <
typename Scalar>
380Variable<Scalar> abs(
const Variable<Scalar>& x) {
381 return Variable{detail::abs(x.expr)};
388template <
typename Scalar>
389Variable<Scalar> acos(
const Variable<Scalar>& x) {
390 return Variable{detail::acos(x.expr)};
397template <
typename Scalar>
398Variable<Scalar> asin(
const Variable<Scalar>& x) {
399 return Variable{detail::asin(x.expr)};
406template <
typename Scalar>
407Variable<Scalar> atan(
const Variable<Scalar>& x) {
408 return Variable{detail::atan(x.expr)};
416template <
typename Scalar>
417Variable<Scalar> atan2(
const ScalarLike
auto& y,
const Variable<Scalar>& x) {
418 return Variable{detail::atan2(Variable<Scalar>(y).expr, x.expr)};
426template <
typename Scalar>
427Variable<Scalar> atan2(
const Variable<Scalar>& y,
const ScalarLike
auto& x) {
428 return Variable{detail::atan2(y.expr, Variable<Scalar>(x).expr)};
436template <
typename Scalar>
437Variable<Scalar> atan2(
const Variable<Scalar>& y,
const Variable<Scalar>& x) {
438 return Variable{detail::atan2(y.expr, x.expr)};
445template <
typename Scalar>
446Variable<Scalar> cbrt(
const Variable<Scalar>& x) {
447 return Variable{detail::cbrt(x.expr)};
454template <
typename Scalar>
455Variable<Scalar> cos(
const Variable<Scalar>& x) {
456 return Variable{detail::cos(x.expr)};
463template <
typename Scalar>
464Variable<Scalar> cosh(
const Variable<Scalar>& x) {
465 return Variable{detail::cosh(x.expr)};
472template <
typename Scalar>
473Variable<Scalar> erf(
const Variable<Scalar>& x) {
474 return Variable{detail::erf(x.expr)};
481template <
typename Scalar>
482Variable<Scalar> exp(
const Variable<Scalar>& x) {
483 return Variable{detail::exp(x.expr)};
491template <
typename Scalar>
492Variable<Scalar> hypot(
const ScalarLike
auto& x,
const Variable<Scalar>& y) {
493 return Variable{detail::hypot(Variable<Scalar>(x).expr, y.expr)};
501template <
typename Scalar>
502Variable<Scalar> hypot(
const Variable<Scalar>& x,
const ScalarLike
auto& y) {
503 return Variable{detail::hypot(x.expr, Variable<Scalar>(y).expr)};
511template <
typename Scalar>
512Variable<Scalar> hypot(
const Variable<Scalar>& x,
const Variable<Scalar>& y) {
513 return Variable{detail::hypot(x.expr, y.expr)};
520template <
typename Scalar>
521Variable<Scalar> log(
const Variable<Scalar>& x) {
522 return Variable{detail::log(x.expr)};
529template <
typename Scalar>
530Variable<Scalar> log10(
const Variable<Scalar>& x) {
531 return Variable{detail::log10(x.expr)};
541template <
typename Scalar>
542Variable<Scalar> max(
const ScalarLike
auto& a,
const Variable<Scalar>& b) {
543 return Variable{detail::max(Variable<Scalar>(a).expr, b.expr)};
553template <
typename Scalar>
554Variable<Scalar> max(
const Variable<Scalar>& a,
const ScalarLike
auto& b) {
555 return Variable{detail::max(a.expr, Variable<Scalar>(b).expr)};
565template <
typename Scalar>
566Variable<Scalar> max(
const Variable<Scalar>& a,
const Variable<Scalar>& b) {
567 return Variable{detail::max(a.expr, b.expr)};
577template <
typename Scalar>
578Variable<Scalar> min(
const ScalarLike
auto& a,
const Variable<Scalar>& b) {
579 return Variable{detail::min(Variable<Scalar>(a).expr, b.expr)};
589template <
typename Scalar>
590Variable<Scalar> min(
const Variable<Scalar>& a,
const ScalarLike
auto& b) {
591 return Variable{detail::min(a.expr, Variable<Scalar>(b).expr)};
601template <
typename Scalar>
602Variable<Scalar> min(
const Variable<Scalar>& a,
const Variable<Scalar>& b) {
603 return Variable{detail::min(a.expr, b.expr)};
611template <
typename Scalar>
612Variable<Scalar> pow(
const ScalarLike
auto& base,
613 const Variable<Scalar>& power) {
614 return Variable{detail::pow(Variable<Scalar>(base).expr, power.expr)};
622template <
typename Scalar>
623Variable<Scalar> pow(
const Variable<Scalar>& base,
624 const ScalarLike
auto& power) {
625 return Variable{detail::pow(base.expr, Variable<Scalar>(power).expr)};
633template <
typename Scalar>
634Variable<Scalar> pow(
const Variable<Scalar>& base,
635 const Variable<Scalar>& power) {
636 return Variable{detail::pow(base.expr, power.expr)};
643template <
typename Scalar>
644Variable<Scalar> sign(
const Variable<Scalar>& x) {
645 return Variable{detail::sign(x.expr)};
652template <
typename Scalar>
653Variable<Scalar> sin(
const Variable<Scalar>& x) {
654 return Variable{detail::sin(x.expr)};
661template <
typename Scalar>
662Variable<Scalar> sinh(
const Variable<Scalar>& x) {
663 return Variable{detail::sinh(x.expr)};
670template <
typename Scalar>
671Variable<Scalar> sqrt(
const Variable<Scalar>& x) {
672 return Variable{detail::sqrt(x.expr)};
679template <
typename Scalar>
680Variable<Scalar> tan(
const Variable<Scalar>& x) {
681 return Variable{detail::tan(x.expr)};
688template <
typename Scalar>
689Variable<Scalar> tanh(
const Variable<Scalar>& x) {
690 return Variable{detail::tanh(x.expr)};
699template <
typename Scalar>
700Variable<Scalar> hypot(
const Variable<Scalar>& x,
const Variable<Scalar>& y,
701 const Variable<Scalar>& z) {
702 return Variable{sqrt(pow(x, 2) + pow(y, 2) + pow(z, 2))};
710template <
typename Scalar, ScalarLike LHS, ScalarLike RHS>
711 requires SleipnirScalarLike<LHS, Scalar> || SleipnirScalarLike<RHS, Scalar>
712auto make_constraints(LHS&& lhs, RHS&& rhs) {
713 gch::small_vector<Variable<Scalar>> constraints;
714 constraints.emplace_back(lhs - rhs);
719template <
typename Scalar, ScalarLike LHS, MatrixLike RHS>
720 requires SleipnirScalarLike<LHS, Scalar> || SleipnirMatrixLike<RHS, Scalar>
721auto make_constraints(LHS&& lhs, RHS&& rhs) {
722 gch::small_vector<Variable<Scalar>> constraints;
723 constraints.reserve(rhs.rows() * rhs.cols());
725 for (
int row = 0; row < rhs.rows(); ++row) {
726 for (
int col = 0; col < rhs.cols(); ++col) {
728 constraints.emplace_back(lhs - rhs[row, col]);
735template <
typename Scalar, MatrixLike LHS, ScalarLike RHS>
736 requires SleipnirMatrixLike<LHS, Scalar> || SleipnirScalarLike<RHS, Scalar>
737auto make_constraints(LHS&& lhs, RHS&& rhs) {
738 gch::small_vector<Variable<Scalar>> constraints;
739 constraints.reserve(lhs.rows() * lhs.cols());
741 for (
int row = 0; row < lhs.rows(); ++row) {
742 for (
int col = 0; col < lhs.cols(); ++col) {
744 constraints.emplace_back(lhs[row, col] - rhs);
751template <
typename Scalar, MatrixLike LHS, MatrixLike RHS>
752 requires SleipnirMatrixLike<LHS, Scalar> || SleipnirMatrixLike<RHS, Scalar>
753auto make_constraints(LHS&& lhs, RHS&& rhs) {
754 slp_assert(lhs.rows() == rhs.rows() && lhs.cols() == rhs.cols());
756 gch::small_vector<Variable<Scalar>> constraints;
757 constraints.reserve(lhs.rows() * lhs.cols());
759 for (
int row = 0; row < lhs.rows(); ++row) {
760 for (
int col = 0; col < lhs.cols(); ++col) {
762 constraints.emplace_back(lhs[row, col] - rhs[row, col]);
772template <
typename Scalar>
785 elem.constraints.end());
799 elem.constraints.end());
810 template <
typename LHS,
typename RHS>
829template <
typename Scalar>
842 elem.constraints.end());
856 elem.constraints.end());
868 template <
typename LHS,
typename RHS>
888template <
typename LHS,
typename RHS>
889 requires(ScalarLike<LHS> || MatrixLike<LHS>) && SleipnirType<LHS> &&
890 (ScalarLike<RHS> || MatrixLike<RHS>) && (!SleipnirType<RHS>)
891auto operator==(LHS&& lhs, RHS&& rhs) {
892 return EqualityConstraints<typename std::decay_t<LHS>::Scalar>{lhs, rhs};
899template <
typename LHS,
typename RHS>
900 requires(ScalarLike<LHS> || MatrixLike<LHS>) && (!SleipnirType<LHS>) &&
901 (ScalarLike<RHS> || MatrixLike<RHS>) && SleipnirType<RHS>
902auto operator==(LHS&& lhs, RHS&& rhs) {
903 return EqualityConstraints<typename std::decay_t<RHS>::Scalar>{lhs, rhs};
910template <
typename LHS,
typename RHS>
911 requires(ScalarLike<LHS> || MatrixLike<LHS>) && SleipnirType<LHS> &&
912 (ScalarLike<RHS> || MatrixLike<RHS>) && SleipnirType<RHS>
913auto operator==(LHS&& lhs, RHS&& rhs) {
914 return EqualityConstraints<typename std::decay_t<LHS>::Scalar>{lhs, rhs};
922template <
typename LHS,
typename RHS>
923 requires(ScalarLike<LHS> || MatrixLike<LHS>) &&
924 (ScalarLike<RHS> || MatrixLike<RHS>) &&
925 (SleipnirType<LHS> || SleipnirType<RHS>)
926auto operator<(LHS&& lhs, RHS&& rhs) {
935template <
typename LHS,
typename RHS>
936 requires(ScalarLike<LHS> || MatrixLike<LHS>) &&
937 (ScalarLike<RHS> || MatrixLike<RHS>) &&
938 (SleipnirType<LHS> || SleipnirType<RHS>)
939auto operator<=(LHS&& lhs, RHS&& rhs) {
948template <
typename LHS,
typename RHS>
949 requires(ScalarLike<LHS> || MatrixLike<LHS>) &&
950 (ScalarLike<RHS> || MatrixLike<RHS>) &&
951 (SleipnirType<LHS> || SleipnirType<RHS>)
952auto operator>(LHS&& lhs, RHS&& rhs) {
961template <
typename LHS,
typename RHS>
962 requires(ScalarLike<LHS> || MatrixLike<LHS>) && SleipnirType<LHS> &&
963 (ScalarLike<RHS> || MatrixLike<RHS>) && (!SleipnirType<RHS>)
964auto operator>=(LHS&& lhs, RHS&& rhs) {
965 return InequalityConstraints<typename std::decay_t<LHS>::Scalar>{lhs, rhs};
973template <
typename LHS,
typename RHS>
974 requires(ScalarLike<LHS> || MatrixLike<LHS>) && (!SleipnirType<LHS>) &&
975 (ScalarLike<RHS> || MatrixLike<RHS>) && SleipnirType<RHS>
976auto operator>=(LHS&& lhs, RHS&& rhs) {
977 return InequalityConstraints<typename std::decay_t<RHS>::Scalar>{lhs, rhs};
985template <
typename LHS,
typename RHS>
986 requires(ScalarLike<LHS> || MatrixLike<LHS>) && SleipnirType<LHS> &&
987 (ScalarLike<RHS> || MatrixLike<RHS>) && SleipnirType<RHS>
988auto operator>=(LHS&& lhs, RHS&& rhs) {
989 return InequalityConstraints<typename std::decay_t<LHS>::Scalar>{lhs, rhs};
997template <
typename L,
typename X,
typename U>
998 requires(ScalarLike<L> || MatrixLike<L>) && SleipnirType<X> &&
999 (ScalarLike<U> || MatrixLike<U>)
1000auto bounds(L&& l, X&& x, U&& u) {
1001 return InequalityConstraints{l <= x, x <= u};
1012template <
typename Scalar>
1013struct NumTraits<slp::Variable<Scalar>> : NumTraits<Scalar> {
1022 static constexpr int IsComplex = 0;
1024 static constexpr int IsInteger = 0;
1026 static constexpr int IsSigned = 1;
1028 static constexpr int RequireInitialization = 1;
1030 static constexpr int ReadCost = 1;
1032 static constexpr int AddCost = 3;
1034 static constexpr int MulCost = 3;
Definition hessian.hpp:28
Definition intrusive_shared_ptr.hpp:27
Definition jacobian.hpp:28
Definition sleipnir_base.hpp:9
Definition variable.hpp:47
ExpressionType type() const
Definition variable.hpp:149
friend Variable< Scalar > operator*(const LHS &lhs, const RHS &rhs)
Definition variable.hpp:157
Variable(const detail::ExpressionPtr< Scalar > &expr)
Definition variable.hpp:94
Variable< Scalar > & operator/=(const Variable< Scalar > &rhs)
Definition variable.hpp:204
Variable< Scalar > & operator*=(const Variable< Scalar > &rhs)
Definition variable.hpp:185
friend Variable< Scalar > operator+(const Variable< Scalar > &lhs, const Variable< Scalar > &rhs)
Definition variable.hpp:214
void set_value(Scalar value)
Definition variable.hpp:117
friend Variable< Scalar > operator/(const Variable< Scalar > &lhs, const Variable< Scalar > &rhs)
Definition variable.hpp:195
Variable(std::floating_point auto value)
Definition variable.hpp:79
constexpr Variable(detail::ExpressionPtr< Scalar > &&expr)
Definition variable.hpp:99
friend Variable< Scalar > operator+(const Variable< Scalar > &lhs)
Definition variable.hpp:257
Variable(Scalar value)
Definition variable.hpp:62
constexpr Variable(std::nullptr_t)
Constructs an empty Variable.
Definition variable.hpp:56
Variable< Scalar > & operator=(ScalarLike auto value)
Definition variable.hpp:106
Variable()=default
Constructs a linear Variable with a value of zero.
friend Variable< Scalar > operator-(const Variable< Scalar > &lhs)
Definition variable.hpp:250
friend Variable< Scalar > operator*(const Variable< Scalar > &lhs, const Variable< Scalar > &rhs)
Definition variable.hpp:176
Variable(std::integral auto value)
Definition variable.hpp:87
Variable(SleipnirMatrixLike< Scalar > auto value)
Definition variable.hpp:71
Variable< Scalar > & operator+=(const Variable< Scalar > &rhs)
Definition variable.hpp:223
Scalar_ Scalar
Scalar type alias.
Definition variable.hpp:50
Scalar value()
Definition variable.hpp:135
Variable< Scalar > & operator-=(const Variable< Scalar > &rhs)
Definition variable.hpp:242
friend Variable< Scalar > operator-(const Variable< Scalar > &lhs, const Variable< Scalar > &rhs)
Definition variable.hpp:233
Definition gradient_expression_graph.hpp:25
Definition concepts.hpp:18
Definition concepts.hpp:24
Definition concepts.hpp:33
Definition concepts.hpp:15
Definition variable.hpp:773
EqualityConstraints(LHS &&lhs, RHS &&rhs)
Definition variable.hpp:814
EqualityConstraints(std::initializer_list< EqualityConstraints > equality_constraints)
Definition variable.hpp:781
gch::small_vector< Variable< Scalar > > constraints
A vector of scalar equality constraints.
Definition variable.hpp:775
EqualityConstraints(const std::vector< EqualityConstraints > &equality_constraints)
Definition variable.hpp:795
Definition variable.hpp:830
gch::small_vector< Variable< Scalar > > constraints
A vector of scalar inequality constraints.
Definition variable.hpp:832
InequalityConstraints(LHS &&lhs, RHS &&rhs)
Definition variable.hpp:872
InequalityConstraints(const std::vector< InequalityConstraints > &inequality_constraints)
Definition variable.hpp:852
InequalityConstraints(std::initializer_list< InequalityConstraints > inequality_constraints)
Definition variable.hpp:838