Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
Eigen::Map< Sophus::SO2< Scalar_ >, Options > Class Template Reference

#include <so2.hpp>

Inheritance diagram for Eigen::Map< Sophus::SO2< Scalar_ >, Options >:
Inheritance graph
[legend]

Public Types

using Adjoint = typename Base::Adjoint
 
using Base = Sophus::SO2Base< Map< Sophus::SO2< Scalar_ >, Options > >
 
using HomogeneousPoint = typename Base::HomogeneousPoint
 
using Point = typename Base::Point
 
using Scalar = Scalar_
 
using Tangent = typename Base::Tangent
 
using Transformation = typename Base::Transformation
 
- Public Types inherited from Sophus::SO2Base< Map< Sophus::SO2< Scalar_ >, Options > >
using Adjoint = Scalar
 
using ComplexT = typename Eigen::internal::traits< Map< Sophus::SO2< Scalar_ >, Options > >::ComplexType
 
using HomogeneousPoint = Vector3< Scalar >
 
using HomogeneousPointProduct = Vector3< ReturnScalar< HPointDerived > >
 
using Line = ParametrizedLine2< Scalar >
 
using Point = Vector2< Scalar >
 
using PointProduct = Vector2< ReturnScalar< PointDerived > >
 
using ReturnScalar = typename Eigen::ScalarBinaryOpTraits< Scalar, typename OtherDerived::Scalar >::ReturnType
 
using Scalar = typename Eigen::internal::traits< Map< Sophus::SO2< Scalar_ >, Options > >::Scalar
 
using SO2Product = SO2< ReturnScalar< OtherDerived > >
 
using Tangent = Scalar
 
using Transformation = Matrix< Scalar, N, N >
 

Public Member Functions

 EIGEN_INHERIT_ASSIGNMENT_EQUAL_OPERATOR (Map)
 
SOPHUS_FUNC Map (Scalar *coeffs)
 
SOPHUS_FUNC Map< Sophus::Vector2< Scalar >, Options > const & unit_complex () const
 
- Public Member Functions inherited from Sophus::SO2Base< Map< Sophus::SO2< Scalar_ >, Options > >
SOPHUS_FUNC Adjoint Adj () const
 
SOPHUS_FUNC SO2< NewScalarType > cast () const
 
SOPHUS_FUNC Scalardata ()
 
SOPHUS_FUNC Scalar const * data () const
 
SOPHUS_FUNC Matrix< Scalar, num_parameters, DoFDx_this_mul_exp_x_at_0 () const
 
SOPHUS_FUNC SO2< Scalarinverse () const
 
SOPHUS_FUNC Scalar log () const
 
SOPHUS_FUNC Transformation matrix () const
 
SOPHUS_FUNC void normalize ()
 
SOPHUS_FUNC HomogeneousPointProduct< HPointDerived > operator* (Eigen::MatrixBase< HPointDerived > const &p) const
 
SOPHUS_FUNC PointProduct< PointDerived > operator* (Eigen::MatrixBase< PointDerived > const &p) const
 
SOPHUS_FUNC Line operator* (Line const &l) const
 
SOPHUS_FUNC SO2Product< OtherDerived > operator* (SO2Base< OtherDerived > const &other) const
 
SOPHUS_FUNC SO2Base< Map< Sophus::SO2< Scalar_ >, Options > > operator*= (SO2Base< OtherDerived > const &other)
 
SOPHUS_FUNC SO2Baseoperator= (SO2Base const &other)=default
 
SOPHUS_FUNC SO2Base< Map< Sophus::SO2< Scalar_ >, Options > > & operator= (SO2Base< OtherDerived > const &other)
 
SOPHUS_FUNC Sophus::Vector< Scalar, num_parametersparams () const
 
SOPHUS_FUNC void setComplex (Point const &complex)
 
SOPHUS_FUNC ComplexT const & unit_complex () const
 

Protected Member Functions

SOPHUS_FUNC Map< Sophus::Vector2< Scalar >, Options > & unit_complex_nonconst ()
 

Protected Attributes

Map< Matrix< Scalar, 2, 1 >, Options > unit_complex_
 

Friends

class Sophus::SO2Base< Map< Sophus::SO2< Scalar_ >, Options > >
 Base is friend so unit_complex_nonconst can be accessed from Base. More...
 

Additional Inherited Members

- Static Public Attributes inherited from Sophus::SO2Base< Map< Sophus::SO2< Scalar_ >, Options > >
static constexpr int DoF
 
static constexpr int N
 Group transformations are 2x2 matrices. More...
 
static constexpr int num_parameters
 Number of internal parameters used (complex numbers are a tuples). More...
 

Detailed Description

template<class Scalar_, int Options>
class Eigen::Map< Sophus::SO2< Scalar_ >, Options >

Specialization of Eigen::Map for SO2; derived from SO2Base.

Allows us to wrap SO2 objects around POD array (e.g. external c style complex number / tuple).

Definition at line 543 of file so2.hpp.

Member Typedef Documentation

◆ Adjoint

template<class Scalar_ , int Options>
using Eigen::Map< Sophus::SO2< Scalar_ >, Options >::Adjoint = typename Base::Adjoint

Definition at line 553 of file so2.hpp.

◆ Base

template<class Scalar_ , int Options>
using Eigen::Map< Sophus::SO2< Scalar_ >, Options >::Base = Sophus::SO2Base<Map<Sophus::SO2<Scalar_>, Options> >

Definition at line 546 of file so2.hpp.

◆ HomogeneousPoint

template<class Scalar_ , int Options>
using Eigen::Map< Sophus::SO2< Scalar_ >, Options >::HomogeneousPoint = typename Base::HomogeneousPoint

Definition at line 551 of file so2.hpp.

◆ Point

template<class Scalar_ , int Options>
using Eigen::Map< Sophus::SO2< Scalar_ >, Options >::Point = typename Base::Point

Definition at line 550 of file so2.hpp.

◆ Scalar

template<class Scalar_ , int Options>
using Eigen::Map< Sophus::SO2< Scalar_ >, Options >::Scalar = Scalar_

Definition at line 547 of file so2.hpp.

◆ Tangent

template<class Scalar_ , int Options>
using Eigen::Map< Sophus::SO2< Scalar_ >, Options >::Tangent = typename Base::Tangent

Definition at line 552 of file so2.hpp.

◆ Transformation

template<class Scalar_ , int Options>
using Eigen::Map< Sophus::SO2< Scalar_ >, Options >::Transformation = typename Base::Transformation

Definition at line 549 of file so2.hpp.

Constructor & Destructor Documentation

◆ Map()

template<class Scalar_ , int Options>
SOPHUS_FUNC Eigen::Map< Sophus::SO2< Scalar_ >, Options >::Map ( Scalar coeffs)
inline

Definition at line 566 of file so2.hpp.

Member Function Documentation

◆ EIGEN_INHERIT_ASSIGNMENT_EQUAL_OPERATOR()

template<class Scalar_ , int Options>
Eigen::Map< Sophus::SO2< Scalar_ >, Options >::EIGEN_INHERIT_ASSIGNMENT_EQUAL_OPERATOR ( Map< Sophus::SO2< Scalar_ >, Options >  )

◆ unit_complex()

template<class Scalar_ , int Options>
SOPHUS_FUNC Map<Sophus::Vector2<Scalar>, Options> const& Eigen::Map< Sophus::SO2< Scalar_ >, Options >::unit_complex ( ) const
inline

Accessor of unit complex number.

Definition at line 571 of file so2.hpp.

◆ unit_complex_nonconst()

template<class Scalar_ , int Options>
SOPHUS_FUNC Map<Sophus::Vector2<Scalar>, Options>& Eigen::Map< Sophus::SO2< Scalar_ >, Options >::unit_complex_nonconst ( )
inlineprotected

Mutator of unit_complex is protected to ensure class invariant.

Definition at line 579 of file so2.hpp.

Friends And Related Function Documentation

◆ Sophus::SO2Base< Map< Sophus::SO2< Scalar_ >, Options > >

template<class Scalar_ , int Options>
friend class Sophus::SO2Base< Map< Sophus::SO2< Scalar_ >, Options > >
friend

Base is friend so unit_complex_nonconst can be accessed from Base.

Definition at line 556 of file so2.hpp.

Member Data Documentation

◆ unit_complex_

template<class Scalar_ , int Options>
Map<Matrix<Scalar, 2, 1>, Options> Eigen::Map< Sophus::SO2< Scalar_ >, Options >::unit_complex_
protected

Definition at line 583 of file so2.hpp.


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


sophus
Author(s): Hauke Strasdat
autogenerated on Wed Mar 2 2022 01:01:48