zoumson / eigen

Basic Eigen Matrix Manipulations

Eigen basics

Table of Contents

1. About The Project
   • Built With
2. Files Structure
   • Folders
   • Entire Files Structure
3. Getting Started
   • Prerequisites
   • Installation
4. Usage
5. Roadmap
6. Contributing
7. License
8. Contact
9. Acknowledgements

About The Project

Eigen matrix manipulation

Built With

• cmake
• gnu
• eigen
• boost
• Pangolin
• openGL

File Structure

Folders

• include/: c++ header files.
• src/: c++ definitions.

Entire Files Structure

.
├── CMakeLists.txt
├── include
│   └── Log.h
├── README.md
└── src
    ├── eigenGeometry.cpp
    ├── eigenMatrix.cpp
    └── visualizeGeometry.cpp

Getting Started

This is a sample code of how you may use the Eigen library matrix and transformations. To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• cmake

  sudo apt-get install cmake

• eigen

sudo apt-get install -y libeigen3-dev

• boost

sudo apt-get install libboost-all-dev

• pangolin

git clone https://github.com/stevenlovegrove/Pangolin.git
sudo apt-get install libglew-dev
sudo apt-get install cmake
sudo apt-get install libpython2.7-dev
sudo apt-get install ffmpeg libavcodec-dev libavutil-dev libavformat-dev libswscale-dev libavdevice-dev
sudo apt-get install libdc1394-22-dev libraw1394-dev
sudo apt-get install libjpeg-dev libpng12-dev libtiff5-dev libopenexr-dev
cd Pangolin
mkdir build
cd build
cmake ..
cmake --build .
make install

Installation

1. Clone the repo

   git clone https://github.com/zoumson/Eigen.git

2. Go to the project directory source

   cd Eigen

3. Create empty directories build, log, and bin

   mkdir build &&  mkdir bin && mkdir log

4. Generate the exectutable demo and move it to bin

   cd build && cmake .. && make -j4 && cd ..

Usage

1. Run for matrix usage

   ./bin/eigenMatrix

2. Run for geomotry computation

   ./bin/eigenGeometry

3. Run for geomotry graphical representation

   ./bin/visualizeGeometry

4. Back to the initial file structure configuration

   rm -r bin build log

Roadmap

All the headers files are well docummented, read through the comments

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Adama Zouma - - [email protected]

Project Link: https://github.com/zoumson/Eigen

Acknowledgements

• Google
• Stack Overflow
• Github