slp::EqualityConstraints< Scalar > Struct Template Reference

A vector of equality constraints of the form cₑ(x) = 0. More...

#include </home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/sleipnir/include/sleipnir/autodiff/variable.hpp>

Public Member Functions
	EqualityConstraints (std::initializer_list< EqualityConstraints > equality_constraints)
	Concatenates multiple equality constraints.
	EqualityConstraints (const std::vector< EqualityConstraints > &equality_constraints)
	Concatenates multiple equality constraints.
template<typename LHS, typename RHS> requires (ScalarLike<LHS> || MatrixLike<LHS>) && (ScalarLike<RHS> || MatrixLike<RHS>) && (SleipnirType<LHS> || SleipnirType<RHS>)
	EqualityConstraints (LHS &&lhs, RHS &&rhs)
	Constructs an equality constraint from a left and right side.
	operator bool ()
	Implicit conversion operator to bool.

Public Attributes
gch::small_vector< Variable< Scalar > >	constraints
	A vector of scalar equality constraints.

Detailed Description

template<typename Scalar>
struct slp::EqualityConstraints< Scalar >

A vector of equality constraints of the form cₑ(x) = 0.

Template Parameters

Scalar

Scalar type.

Constructor & Destructor Documentation

EqualityConstraints() [1/3]

template<typename Scalar>

slp::EqualityConstraints< Scalar >::EqualityConstraints ( std::initializer_list< EqualityConstraints< Scalar > > equality_constraints )

inline

Concatenates multiple equality constraints.

Parameters

equality_constraints

The list of EqualityConstraints to concatenate.

EqualityConstraints() [2/3]

template<typename Scalar>

slp::EqualityConstraints< Scalar >::EqualityConstraints ( const std::vector< EqualityConstraints< Scalar > > & equality_constraints )

inlineexplicit

Concatenates multiple equality constraints.

This overload is for Python bindings only.

Parameters

equality_constraints

The list of EqualityConstraints to concatenate.

EqualityConstraints() [3/3]

template<typename Scalar>

template<typename LHS, typename RHS>
requires (ScalarLike<LHS> || MatrixLike<LHS>) && (ScalarLike<RHS> || MatrixLike<RHS>) && (SleipnirType<LHS> || SleipnirType<RHS>)

slp::EqualityConstraints< Scalar >::EqualityConstraints ( LHS && lhs, RHS && rhs )

inline

Constructs an equality constraint from a left and right side.

The standard form for equality constraints is c(x) = 0. This function takes a constraint of the form lhs = rhs and converts it to lhs - rhs = 0.

Parameters

lhs	Left-hand side.
rhs	Right-hand side.

Member Function Documentation

operator bool()

template<typename Scalar>

slp::EqualityConstraints< Scalar >::operator bool ( )

inline

Implicit conversion operator to bool.

Member Data Documentation

constraints

template<typename Scalar>

gch::small_vector<Variable<Scalar> > slp::EqualityConstraints< Scalar >::constraints

A vector of scalar equality constraints.

---

The documentation for this struct was generated from the following file:

• /home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/sleipnir/include/sleipnir/autodiff/variable.hpp