- 3.0.2 optimal control module.
StateGenConstraint Class Reference
Inheritance diagram for StateGenConstraint:
ct::optcon::ConstraintBase< state_dim, control_dim >

Public Types

typedef ct::core::StateVector< state_dimstate_vector_t
 
typedef ct::core::ControlVector< control_dimcontrol_vector_t
 
- Public Types inherited from ct::optcon::ConstraintBase< state_dim, control_dim >
typedef core::StateVector< STATE_DIM, double > state_vector_t
 
typedef core::ControlVector< CONTROL_DIM, double > control_vector_t
 
typedef Eigen::Matrix< double, Eigen::Dynamic, 1 > VectorXs
 
typedef Eigen::Matrix< double, Eigen::Dynamic, Eigen::Dynamic > MatrixXs
 

Public Member Functions

 StateGenConstraint ()
 constructor with hard-coded constraint boundaries. More...
 
virtual ~StateGenConstraint ()
 
virtual StateGenConstraintclone () const override
 Creates a new instance of the object with same properties than original. More...
 
virtual size_t getConstraintSize () const override
 The evaluate method used for jit compilation in constraint container ad. More...
 
virtual Eigen::VectorXd evaluate (const state_vector_t &x, const control_vector_t &u, const double t) override
 
virtual Eigen::Matrix< ct::core::ADCGScalar, Eigen::Dynamic, 1 > evaluateCppadCg (const ct::core::StateVector< state_dim, ct::core::ADCGScalar > &x, const ct::core::ControlVector< control_dim, ct::core::ADCGScalar > &u, ct::core::ADCGScalar t) override
 
- Public Member Functions inherited from ct::optcon::ConstraintBase< state_dim, control_dim >
 ConstraintBase (std::string name="Unnamed")
 Custom constructor. More...
 
 ConstraintBase (const ConstraintBase &arg)
 Copy constructor. More...
 
virtual ~ConstraintBase ()
 Destructor. More...
 
virtual VectorXs evaluate (const state_vector_t &x, const control_vector_t &u, const double t)=0
 The evaluation of the constraint violation. Note this method is SCALAR typed. More...
 
virtual MatrixXs jacobianState (const state_vector_t &x, const control_vector_t &u, const double t)
 Returns the constraint jacobian wrt state. More...
 
virtual MatrixXs jacobianInput (const state_vector_t &x, const control_vector_t &u, const double t)
 Returns the constraint jacobian wrt input. More...
 
virtual VectorXs getLowerBound () const
 Returns the lower constraint bound. More...
 
virtual VectorXs getUpperBound () const
 Returns the upper constraint bound. More...
 
void getName (std::string &constraintName) const
 Returns the constraint name. More...
 
void setName (const std::string constraintName)
 Sets the constraint name. More...
 
virtual size_t getNumNonZerosJacobianState () const
 Returns the number of nonzeros in the jacobian wrt state. The default implementation assumes a dense matrix with only nonzero elements. More...
 
virtual size_t getNumNonZerosJacobianInput () const
 Returns the number of nonzeros in the jacobian wrt control input. The default implementation assumes a dense matrix with only nonzero elements. More...
 
virtual VectorXs jacobianStateSparse (const state_vector_t &x, const control_vector_t &u, const double t)
 Returns the constraint jacobian wrt state in sparse structure. The default implementation maps the JacobianState matrix to a vector. More...
 
virtual VectorXs jacobianInputSparse (const state_vector_t &x, const control_vector_t &u, const double t)
 Returns the constraint jacobian wrt control input in sparse structure. The default implementation maps the JacobianState matrix to a vector. More...
 
virtual void sparsityPatternState (Eigen::VectorXi &rows, Eigen::VectorXi &cols)
 Generates the sparsity pattern of the jacobian wrt state. The default implementation returns a vector of ones corresponding to the dense jacobianState. More...
 
virtual void sparsityPatternInput (Eigen::VectorXi &rows, Eigen::VectorXi &cols)
 Generates the sparsity pattern of the jacobian wrt control input. The default implementation returns a vector of ones corresponding to the dense jacobianInput. More...
 

Public Attributes

EIGEN_MAKE_ALIGNED_OPERATOR_NEW typedef ct::optcon::ConstraintBase< state_dim, control_dimBase
 
- Public Attributes inherited from ct::optcon::ConstraintBase< state_dim, control_dim >
EIGEN_MAKE_ALIGNED_OPERATOR_NEW typedef ct::core::tpl::TraitSelector< double >::Trait Trait
 

Additional Inherited Members

- Static Protected Member Functions inherited from ct::optcon::ConstraintBase< state_dim, control_dim >
static void genDiagonalIndices (const size_t num_elements, Eigen::VectorXi &iRow_vec, Eigen::VectorXi &jCol_vec)
 upper bound on the constraints More...
 
static void genSparseDiagonalIndices (const Eigen::VectorXi &diag_sparsity, Eigen::VectorXi &iRow_vec, Eigen::VectorXi &jCol_vec)
 Generates indices of a sparse diagonal square matrix. More...
 
static void genBlockIndices (const size_t num_rows, const size_t num_cols, Eigen::VectorXi &iRow_vec, Eigen::VectorXi &jCol_vec)
 Generates indices of a full matrix. More...
 
- Protected Attributes inherited from ct::optcon::ConstraintBase< state_dim, control_dim >
VectorXs lb_
 
VectorXs ub_
 lower bound on the constraints More...
 

Member Typedef Documentation

◆ state_vector_t

◆ control_vector_t

Constructor & Destructor Documentation

◆ StateGenConstraint()

StateGenConstraint::StateGenConstraint ( )
inline

constructor with hard-coded constraint boundaries.

◆ ~StateGenConstraint()

virtual StateGenConstraint::~StateGenConstraint ( )
inlinevirtual

Member Function Documentation

◆ clone()

virtual StateGenConstraint* StateGenConstraint::clone ( ) const
inlineoverridevirtual

Creates a new instance of the object with same properties than original.

Returns
Copy of this object.

Implements ct::optcon::ConstraintBase< state_dim, control_dim >.

◆ getConstraintSize()

virtual size_t StateGenConstraint::getConstraintSize ( ) const
inlineoverridevirtual

The evaluate method used for jit compilation in constraint container ad.

Parameters
[in]xThe state vector
[in]uThe control vector
[in]tThe time
Returns
The constraint violation Returns the number of constraints
The number of constraints

Implements ct::optcon::ConstraintBase< state_dim, control_dim >.

◆ evaluate()

virtual Eigen::VectorXd StateGenConstraint::evaluate ( const state_vector_t x,
const control_vector_t u,
const double  t 
)
inlineoverridevirtual

References x.

◆ evaluateCppadCg()

virtual Eigen::Matrix<ct::core::ADCGScalar, Eigen::Dynamic, 1> StateGenConstraint::evaluateCppadCg ( const ct::core::StateVector< state_dim, ct::core::ADCGScalar > &  x,
const ct::core::ControlVector< control_dim, ct::core::ADCGScalar > &  u,
ct::core::ADCGScalar  t 
)
inlineoverridevirtual

References x.

Member Data Documentation

◆ Base

EIGEN_MAKE_ALIGNED_OPERATOR_NEW typedef ct::optcon::ConstraintBase<state_dim, control_dim> StateGenConstraint::Base

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