eigen_types.h

Go to the documentation of this file.

/*******************************************************************************
 * BSD 3-Clause License
 *
 * Copyright (c) 2021, Qiayuan Liao
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * * Redistributions of source code must retain the above copyright notice, this
 *   list of conditions and the following disclaimer.
 *
 * * Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 *
 * * Neither the name of the copyright holder nor the names of its
 *   contributors may be used to endorse or promote products derived from
 *   this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *******************************************************************************/
 
//
// Created by qiayuan on 4/3/20.
//
 
#pragma once
 
#include <eigen3/Eigen/Dense>
 
#include <vector>
 
// Rotation Matrix
template <typename T>
using RotMat = typename Eigen::Matrix<T, 3, 3>;
 
// 2x1 Vector
template <typename T>
using Vec2 = typename Eigen::Matrix<T, 2, 1>;
 
// 3x1 Vector
template <typename T>
using Vec3 = typename Eigen::Matrix<T, 3, 1>;
 
// 4x1 Vector
template <typename T>
using Vec4 = typename Eigen::Matrix<T, 4, 1>;
 
// 6x1 Vector
template <typename T>
using Vec6 = Eigen::Matrix<T, 6, 1>;
 
// 8x1 Vector
template <typename T>
using Vec8 = Eigen::Matrix<T, 8, 1>;
 
// 10x1 Vector
template <typename T>
using Vec10 = Eigen::Matrix<T, 10, 1>;
 
// 12x1 Vector
template <typename T>
using Vec12 = Eigen::Matrix<T, 12, 1>;
 
// 18x1 Vector
template <typename T>
using Vec18 = Eigen::Matrix<T, 18, 1>;
 
// 28x1 vector
template <typename T>
using Vec28 = Eigen::Matrix<T, 28, 1>;
 
// 2x2 Matrix
template <typename T>
using Mat2 = typename Eigen::Matrix<T, 2, 2>;
 
// 3x3 Matrix
template <typename T>
using Mat3 = typename Eigen::Matrix<T, 3, 3>;
 
// 8x8 Matrix
template <typename T>
using Mat8 = typename Eigen::Matrix<T, 8, 8>;
 
// 4x1 Vector
template <typename T>
using Quat = typename Eigen::Matrix<T, 4, 1>;
 
// Spatial Vector (6x1, all subspaces)
template <typename T>
using SVec = typename Eigen::Matrix<T, 6, 1>;
 
// Spatial Transform (6x6)
template <typename T>
using SXform = typename Eigen::Matrix<T, 6, 6>;
 
// 6x6 Matrix
template <typename T>
using Mat6 = typename Eigen::Matrix<T, 6, 6>;
 
// 12x12 Matrix
template <typename T>
using Mat12 = typename Eigen::Matrix<T, 12, 12>;
 
// 18x18 Matrix
template <typename T>
using Mat18 = Eigen::Matrix<T, 18, 18>;
 
// 28x28 Matrix
template <typename T>
using Mat28 = Eigen::Matrix<T, 28, 28>;
 
// 3x4 Matrix
template <typename T>
using Mat34 = Eigen::Matrix<T, 3, 4>;
 
// 3x4 Matrix
template <typename T>
using Mat23 = Eigen::Matrix<T, 2, 3>;
 
// 4x4 Matrix
template <typename T>
using Mat4 = typename Eigen::Matrix<T, 4, 4>;
 
// 10x1 Vector
template <typename T>
using MassProperties = typename Eigen::Matrix<T, 10, 1>;
 
// Dynamically sized vector
template <typename T>
using DVec = typename Eigen::Matrix<T, Eigen::Dynamic, 1>;
 
// Dynamically sized matrix
template <typename T>
using DMat = typename Eigen::Matrix<T, Eigen::Dynamic, Eigen::Dynamic>;
 
// Dynamically sized matrix with spatial vector columns
template <typename T>
using D6Mat = typename Eigen::Matrix<T, 6, Eigen::Dynamic>;
 
// Dynamically sized matrix with cartesian vector columns
template <typename T>
using D3Mat = typename Eigen::Matrix<T, 3, Eigen::Dynamic>;
 
// std::vector (a list) of Eigen things
template <typename T>
using vectorAligned = typename std::vector<T, Eigen::aligned_allocator<T>>;