slp::NewtonMatrixCallbacks< Scalar > Struct Template Reference

Matrix callbacks for the Newton's method solver. More...

#include </home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/sleipnir/include/sleipnir/optimization/solver/newton_matrix_callbacks.hpp>

Public Types
using	DenseVector = Eigen::Vector<Scalar, Eigen::Dynamic>
	Type alias for dense vector.
using	SparseMatrix = Eigen::SparseMatrix<Scalar>
	Type alias for sparse matrix.
using	SparseVector = Eigen::SparseVector<Scalar>
	Type alias for sparse vector.

Public Attributes
std::function< Scalar(const DenseVector &x)>	f
	Cost function value f(x) getter.
std::function< SparseVector(const DenseVector &x)>	g
	Cost function gradient ∇f(x) getter.
std::function< SparseMatrix(const DenseVector &x)>	H
	Lagrangian Hessian ∇ₓₓ²L(x) getter.

Detailed Description

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

Matrix callbacks for the Newton's method solver.

Template Parameters

Scalar

Scalar type.

Member Typedef Documentation

DenseVector

template<typename Scalar>

using slp::NewtonMatrixCallbacks< Scalar >::DenseVector = Eigen::Vector<Scalar, Eigen::Dynamic>

Type alias for dense vector.

SparseMatrix

template<typename Scalar>

using slp::NewtonMatrixCallbacks< Scalar >::SparseMatrix = Eigen::SparseMatrix<Scalar>

Type alias for sparse matrix.

SparseVector

template<typename Scalar>

using slp::NewtonMatrixCallbacks< Scalar >::SparseVector = Eigen::SparseVector<Scalar>

Type alias for sparse vector.

Member Data Documentation

f

template<typename Scalar>

std::function<Scalar(const DenseVector& x)> slp::NewtonMatrixCallbacks< Scalar >::f

Cost function value f(x) getter.

Variable	Rows	Columns
x	num_decision_variables	1
f(x)	1	1

g

template<typename Scalar>

std::function<SparseVector(const DenseVector& x)> slp::NewtonMatrixCallbacks< Scalar >::g

Cost function gradient ∇f(x) getter.

Variable	Rows	Columns
x	num_decision_variables	1
∇f(x)	num_decision_variables	1

H

template<typename Scalar>

std::function<SparseMatrix(const DenseVector& x)> slp::NewtonMatrixCallbacks< Scalar >::H

Lagrangian Hessian ∇ₓₓ²L(x) getter.

L(xₖ) = f(xₖ)

Variable	Rows	Columns
x	num_decision_variables	1
∇ₓₓ²L(x)	num_decision_variables	num_decision_variables

---

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

• /home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/sleipnir/include/sleipnir/optimization/solver/newton_matrix_callbacks.hpp