slp::InequalityConstraints< Scalar > Struct Template Reference

A vector of inequality 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
	InequalityConstraints (std::initializer_list< InequalityConstraints > inequality_constraints)
	Concatenates multiple inequality constraints.
	InequalityConstraints (const std::vector< InequalityConstraints > &inequality_constraints)
	Concatenates multiple inequality constraints.
template<typename LHS, typename RHS> requires (ScalarLike<LHS> || MatrixLike<LHS>) && (ScalarLike<RHS> || MatrixLike<RHS>) && (SleipnirType<LHS> || SleipnirType<RHS>)
	InequalityConstraints (LHS &&lhs, RHS &&rhs)
	Constructs an inequality 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 inequality constraints.

Detailed Description

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

A vector of inequality constraints of the form cᵢ(x) ≥ 0.

Template Parameters

Scalar

Scalar type.

Constructor & Destructor Documentation

InequalityConstraints() [1/3]

template<typename Scalar>

slp::InequalityConstraints< Scalar >::InequalityConstraints ( std::initializer_list< InequalityConstraints< Scalar > > inequality_constraints )

inline

Concatenates multiple inequality constraints.

Parameters

inequality_constraints

The list of InequalityConstraints to concatenate.

InequalityConstraints() [2/3]

template<typename Scalar>

slp::InequalityConstraints< Scalar >::InequalityConstraints ( const std::vector< InequalityConstraints< Scalar > > & inequality_constraints )

inlineexplicit

Concatenates multiple inequality constraints.

This overload is for Python bindings only.

Parameters

inequality_constraints

The list of InequalityConstraints to concatenate.

InequalityConstraints() [3/3]

template<typename Scalar>

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

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

inline

Constructs an inequality constraint from a left and right side.

The standard form for inequality constraints is c(x) ≥ 0. This function takes a constraints 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::InequalityConstraints< Scalar >::operator bool ( )

inline

Implicit conversion operator to bool.

Member Data Documentation

constraints

template<typename Scalar>

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

A vector of scalar inequality 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