Aikido
Satisfied.hpp
Go to the documentation of this file.
1 #ifndef AIKIDO_CONSTRAINT_SATISFIED_HPP_
2 #define AIKIDO_CONSTRAINT_SATISFIED_HPP_
7 
8 namespace aikido {
9 namespace constraint {
10 
14 class Satisfied
17  , public constraint::Testable
18 {
19 public:
21 
25 
26  // Documentation inherited.
28 
30  std::size_t getConstraintDimension() const override;
31 
33  std::vector<constraint::ConstraintType> getConstraintTypes() const override;
34 
40  bool isSatisfied(
41  const statespace::StateSpace::State* state,
42  TestableOutcome* outcome = nullptr) const override;
43 
46  std::unique_ptr<TestableOutcome> createOutcome() const override;
47 
52  bool project(
54  statespace::StateSpace::State* _out) const override;
55 
60  void getValue(const statespace::StateSpace::State* _s, Eigen::VectorXd& _out)
61  const override;
62 
67  void getJacobian(
69  Eigen::MatrixXd& _out) const override;
70 
71 private:
73 };
74 
75 } // namespace constraint
76 } // namespace aikido
77 
78 #endif // ifndef AIKIDO_CONSTRAINT_SATISFIED_HPP_
aikido::constraint::Satisfied::getConstraintTypes
std::vector< constraint::ConstraintType > getConstraintTypes() const override
Returns an empty vector.
aikido::constraint::Differentiable
A differentiable constraint.
Definition: Differentiable.hpp:27
aikido::constraint::Satisfied::isSatisfied
bool isSatisfied(const statespace::StateSpace::State *state, TestableOutcome *outcome=nullptr) const override
Returns true.
aikido
Format of serialized trajectory in YAML.
Definition: algorithm.hpp:4
Differentiable.hpp
aikido::constraint::Satisfied::getJacobian
void getJacobian(const statespace::StateSpace::State *_s, Eigen::MatrixXd &_out) const override
Returns an empty matrix.
aikido::constraint::Satisfied::mStateSpace
statespace::ConstStateSpacePtr mStateSpace
Definition: Satisfied.hpp:72
aikido::constraint::Testable
Constraint which can be tested.
Definition: Testable.hpp:17
aikido::statespace::ConstStateSpacePtr
std::shared_ptr< const StateSpace > ConstStateSpacePtr
Definition: StateSpace.hpp:15
aikido::constraint::Projectable
A projectable constraint.
Definition: Projectable.hpp:12
aikido::constraint::Satisfied
A constraint which is always satisfied.
Definition: Satisfied.hpp:14
Sampleable.hpp
Projectable.hpp
aikido::constraint::TestableOutcome
Base class for constraint outcomes.
Definition: TestableOutcome.hpp:13
aikido::constraint::Satisfied::getValue
void getValue(const statespace::StateSpace::State *_s, Eigen::VectorXd &_out) const override
Returns an empty vector.
aikido::constraint::Satisfied::getConstraintDimension
std::size_t getConstraintDimension() const override
Returns 0.
aikido::constraint::Satisfied::getStateSpace
statespace::ConstStateSpacePtr getStateSpace() const override
Gets the StateSpace that this constraint operates on.
Testable.hpp
aikido::constraint::Differentiable::getValueAndJacobian
virtual void getValueAndJacobian(const statespace::StateSpace::State *_s, Eigen::VectorXd &_val, Eigen::MatrixXd &_jac) const
Get both Value and Jacobian.
aikido::statespace::StateSpace::State
Definition: StateSpace.hpp:167
aikido::constraint::Satisfied::createOutcome
std::unique_ptr< TestableOutcome > createOutcome() const override
Return an instance of DefaultTestableOutcome, since this class doesn't have a more specialized Testab...
aikido::constraint::Satisfied::project
bool project(const statespace::StateSpace::State *_s, statespace::StateSpace::State *_out) const override
Sets _out to _s.
aikido::constraint::Satisfied::Satisfied
Satisfied(statespace::ConstStateSpacePtr _space)
Constructor.