Aikido
SE2.hpp
Go to the documentation of this file.
1 #ifndef AIKIDO_STATESPACE_SE2STATESPACE_HPP_
2 #define AIKIDO_STATESPACE_SE2STATESPACE_HPP_
3 #include <Eigen/Geometry>
4 
7 
8 namespace aikido {
9 namespace statespace {
10 
12 template <class>
13 class SE2StateHandle;
14 
19 class SE2 : public virtual StateSpace
20 {
21 public:
22  class State : public StateSpace::State
23  {
24  public:
25  using Isometry2d
26  = Eigen::Transform<double, 2, Eigen::Isometry, Eigen::DontAlign>;
27 
29  State();
30 
31  ~State() = default;
32 
36  explicit State(const Isometry2d& _transform);
37 
41  void setIsometry(const Isometry2d& _transform);
42 
46  const Isometry2d& getIsometry() const;
47 
48  private:
50 
51  friend class SE2;
52  };
53 
56 
59 
60  using StateSpace::compose;
61 
63 
65  SE2() = default;
66 
70  ScopedState createState() const;
71 
73  ScopedState cloneState(const StateSpace::State* stateIn) const;
74 
79  const Isometry2d& getIsometry(const State* _state) const;
80 
85  void setIsometry(State* _state, const Isometry2d& _transform) const;
86 
87  // Documentation inherited.
88  std::size_t getStateSizeInBytes() const override;
89 
90  // Documentation inherited.
91  StateSpace::State* allocateStateInBuffer(void* _buffer) const override;
92 
93  // Documentation inherited.
94  void freeStateInBuffer(StateSpace::State* _state) const override;
95 
96  // Documentation inherited.
97  void compose(
98  const StateSpace::State* _state1,
99  const StateSpace::State* _state2,
100  StateSpace::State* _out) const override;
101 
102  // Documentation inherited
103  void getIdentity(StateSpace::State* _out) const override;
104 
105  // Documentation inherited
106  void getInverse(
107  const StateSpace::State* _in, StateSpace::State* _out) const override;
108 
109  // Documentation inherited
110  std::size_t getDimension() const override;
111 
112  // Documentation inherited
113  void copyState(
114  const StateSpace::State* _source,
115  StateSpace::State* _destination) const override;
116 
123  void expMap(
124  const Eigen::VectorXd& _tangent, StateSpace::State* _out) const override;
125 
132  void logMap(const StateSpace::State* _state, Eigen::VectorXd& _tangent)
133  const override;
134 
136  void print(const StateSpace::State* _state, std::ostream& _os) const override;
137 };
138 
139 } // namespace statespace
140 } // namespace aikido
141 
142 #include "detail/SE2-impl.hpp"
143 
144 #endif // ifndef AIKIDO_STATESPACE_SE2STATESPACE_HPP_
aikido::statespace::SE2::createState
ScopedState createState() const
Helper function to create a ScopedState.
aikido::statespace::SE2::expMap
void expMap(const Eigen::VectorXd &_tangent, StateSpace::State *_out) const override
Exponential mapping of Lie algebra element to a Lie group element.
aikido::statespace::SE2::getStateSizeInBytes
std::size_t getStateSizeInBytes() const override
Gets the size of a State, in bytes.
aikido::statespace::SE2::getInverse
void getInverse(const StateSpace::State *_in, StateSpace::State *_out) const override
Gets the inverse of _in in this Lie group, such that:
aikido::statespace::SE2::State::mTransform
Isometry2d mTransform
Definition: SE2.hpp:49
aikido
Format of serialized trajectory in YAML.
Definition: algorithm.hpp:4
aikido::statespace::SE2::freeStateInBuffer
void freeStateInBuffer(StateSpace::State *_state) const override
Free a state previously created by allocateStateInBuffer.
StateSpace.hpp
aikido::statespace::SE2::Isometry2d
State::Isometry2d Isometry2d
Definition: SE2.hpp:62
aikido::statespace::SE2::copyState
void copyState(const StateSpace::State *_source, StateSpace::State *_destination) const override
Copy a state.
aikido::statespace::SE2::cloneState
ScopedState cloneState(const StateSpace::State *stateIn) const
Creates an identical clone of stateIn.
aikido::statespace::SE2StateHandle
StateHandle for a SE2.
Definition: SE2-impl.hpp:9
aikido::statespace::SE2::allocateStateInBuffer
StateSpace::State * allocateStateInBuffer(void *_buffer) const override
Create a new state in a pre-allocated buffer.
aikido::statespace::SE2
The two-dimensional special Euclidean group SE(2), i.e.
Definition: SE2.hpp:19
aikido::statespace::SE2::SE2
SE2()=default
Constructs a state space representing SE(2).
aikido::statespace::SE2::compose
void compose(const StateSpace::State *_state1, const StateSpace::State *_state2, StateSpace::State *_out) const override
Lie group operation for this StateSpace.
aikido::statespace::SE2::getIsometry
const Isometry2d & getIsometry(const State *_state) const
Gets value as an Eigen transformation object.
aikido::statespace::StateSpace
Represents a Lie group and its associated Lie algebra, i.e.
Definition: StateSpace.hpp:33
aikido::statespace::SE2::getIdentity
void getIdentity(StateSpace::State *_out) const override
Gets the identity element for this Lie group, such that:
aikido::statespace::ScopedState< StateHandle >
aikido::statespace::SE2::logMap
void logMap(const StateSpace::State *_state, Eigen::VectorXd &_tangent) const override
Log mapping of Lie group element to a Lie algebra element.
aikido::statespace::StateSpace::compose
virtual void compose(const State *_state1, const State *_state2, State *_out) const =0
Lie group operation for this StateSpace.
SE2-impl.hpp
aikido::statespace::SE2::setIsometry
void setIsometry(State *_state, const Isometry2d &_transform) const
Sets value to an Eigen transfomation object.
aikido::statespace::SE2::State
Definition: SE2.hpp:22
aikido::statespace::SE2::State::State
State()
Constructs the identity element.
aikido::statespace::SE2::State::Isometry2d
Eigen::Transform< double, 2, Eigen::Isometry, Eigen::DontAlign > Isometry2d
Definition: SE2.hpp:26
aikido::statespace::StateSpace::State
Definition: StateSpace.hpp:167
aikido::statespace::SE2::getDimension
std::size_t getDimension() const override
Get the dimension of this Lie group.
aikido::statespace::SE2::State::~State
~State()=default
aikido::statespace::SE2::State::getIsometry
const Isometry2d & getIsometry() const
Gets value as an Eigen transformation object.
aikido::statespace::SE2::print
void print(const StateSpace::State *_state, std::ostream &_os) const override
Print the state. Format: [x, y, theta].
ScopedState.hpp
aikido::statespace::SE2::State::setIsometry
void setIsometry(const Isometry2d &_transform)
Sets value to an Eigen transfomation object.